Merge pull request #317 from yangmingshan/missing

feat: add missing types
wechat-miniprogram · Jun 26, 2024 · 4864c77 · 4864c77
2 parents 9f98eb4 + 6191ce5
commit 4864c77
Show file tree

Hide file tree

Showing 3 changed files with 95 additions and 0 deletions.
diff --git a/types/wx/lib.wx.app.d.ts b/types/wx/lib.wx.app.d.ts
@@ -317,6 +317,30 @@ declare namespace WechatMiniprogram.App {
         shareTicket: string
         /** 当场景为由从另一个小程序或公众号或App打开时，返回此字段 */
         referrerInfo?: ReferrerInfo
+        /** 打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数 */
+        forwardMaterials: ForwardMaterials[]
+        /** 从微信群聊/单聊打开小程序时，chatType 表示具体微信群聊/单聊类型
+         *
+         * 可选值：
+         * - 1: 微信联系人单聊;
+         * - 2: 企业微信联系人单聊;
+         * - 3: 普通微信群聊;
+         * - 4: 企业微信互通群聊; */
+        chatType?: 1 | 2 | 3 | 4
+        /** 需要基础库： `2.20.0`
+         *
+         * API 类别
+         *
+         * 可选值：
+         * - 'default': 默认类别;
+         * - 'nativeFunctionalized': 原生功能化，视频号直播商品、商品橱窗等场景打开的小程序;
+         * - 'browseOnly': 仅浏览，朋友圈快照页等场景打开的小程序;
+         * - 'embedded': 内嵌，通过打开半屏小程序能力打开的小程序; */
+        apiCategory:
+            | 'default'
+            | 'nativeFunctionalized'
+            | 'browseOnly'
+            | 'embedded'
     }
 
     interface PageNotFoundOption {

diff --git a/types/wx/lib.wx.component.d.ts b/types/wx/lib.wx.component.d.ts
@@ -157,13 +157,29 @@ declare namespace WechatMiniprogram.Component {
         [name in keyof P]: PropertyToData<P[name]>
     }
 
+    interface Router {
+        switchTab: Wx['switchTab']
+        reLaunch: Wx['reLaunch']
+        redirectTo: Wx['redirectTo']
+        navigateTo: Wx['navigateTo']
+        navigateBack: Wx['navigateBack']
+    }
+
     interface InstanceProperties {
         /** 组件的文件路径 */
         is: string
         /** 节点id */
         id: string
         /** 节点dataset */
         dataset: Record<string, string>
+        /** 上一次退出前 onSaveExitState 保存的数据 */
+        exitState: any
+        /** 相对于当前自定义组件的 Router 对象 */
+        router: Router
+        /** 相对于当前自定义组件所在页面的 Router 对象 */
+        pageRouter: Router
+        /** 渲染当前组件的渲染后端 */
+        renderer: 'webview' | 'skyline'
     }
 
     interface InstanceMethods<D extends DataOption> {
@@ -203,6 +219,8 @@ declare namespace WechatMiniprogram.Component {
         createIntersectionObserver(
             options: CreateIntersectionObserverOption
         ): IntersectionObserver
+        /** 创建一个 MediaQueryObserver 对象 */
+        createMediaQueryObserver(): MediaQueryObserver
         /** 使用选择器选择组件实例节点，返回匹配到的第一个组件实例对象（会被 `wx://component-export` 影响） */
         selectComponent(selector: string): TrivialInstance
         /** 使用选择器选择组件实例节点，返回匹配到的全部组件实例对象组成的数组 */
@@ -277,6 +295,27 @@ declare namespace WechatMiniprogram.Component {
          * 最低基础库版本：[`2.7.3`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
          */
         getOpenerEventChannel(): EventChannel
+        /**
+         * 绑定由 worklet 驱动的样式到相应的节点，详见 [worklet 动画](https://developers.weixin.qq.com/miniprogram/dev/framework/runtime/skyline/worklet.html)
+         *
+         * 最低基础库版本：[`2.29.0`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
+         */
+        applyAnimatedStyle(
+            selector: string,
+            updater: () => Record<string, string>,
+            userConfig?: { immediate: boolean, flush: 'sync' | 'async' },
+            callback?: (res: { styleId: number }) => void
+        ): void
+        /**
+         * 清除节点上 worklet 驱动样式的绑定关系
+         *
+         * 最低基础库版本：[`2.30.1`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
+         */
+        clearAnimatedStyle(
+            selector: string,
+            styleIds: number[],
+            callback?: () => void
+        ): void
         /**
          * 获取更新性能统计信息，详见 [获取更新性能统计信息]((custom-component/update-perf-stat))
          *
@@ -377,6 +416,11 @@ declare namespace WechatMiniprogram.Component {
          * 所在页面尺寸变化时执行
          */
         resize(size: Page.IResizeOption): void
+        /** 页面生命周期回调—监听页面路由动画完成
+         *
+         * 所在页面路由动画完成时执行
+         */
+        routeDone(): void
     }
 
     type DefinitionFilter = <T extends TrivialOption>(

diff --git a/types/wx/lib.wx.page.d.ts b/types/wx/lib.wx.page.d.ts
@@ -76,6 +76,11 @@ declare namespace WechatMiniprogram.Page {
          * 页面卸载时触发。如`redirectTo`或`navigateBack`到其他页面时。
          */
         onUnload(): void | Promise<void>
+        /** 生命周期回调—监听路由动画完成
+         *
+         * 路由动画完成时触发。如 wx.navigateTo 页面完全推入后 或 wx.navigateBack 页面完全恢复时。
+         */
+        onRouteDone(): void | Promise<void>
         /** 监听用户下拉动作
          *
          * 监听用户下拉刷新事件。
@@ -143,6 +148,9 @@ declare namespace WechatMiniprogram.Page {
          * 基础库 2.10.3，安卓 7.0.15 版本起支持，iOS 暂不支持
          */
         onAddToFavorites(options: IAddToFavoritesOption): IAddToFavoritesContent
+
+        /** 每当小程序可能被销毁之前会被调用，可以进行退出状态的保存。最低基础库： `2.7.4` */
+        onSaveExitState(): ISaveExitState
     }
     interface InstanceProperties {
         /** 页面的文件路径 */
@@ -153,6 +161,18 @@ declare namespace WechatMiniprogram.Page {
 
         /** 打开当前页面路径中的参数 */
         options: Record<string, string | undefined>
+
+        /** 上一次退出前 onSaveExitState 保存的数据 */
+        exitState: any
+
+        /** 相对于当前页面的 Router 对象 */
+        router: Component.Router
+
+        /** 相对于当前页面的 Router 对象 */
+        pageRouter: Component.Router
+
+        /** 渲染当前页面的渲染后端 */
+        renderer: 'webview' | 'skyline'
     }
 
     type DataOption = Record<string, any>
@@ -252,6 +272,13 @@ declare namespace WechatMiniprogram.Page {
         query?: string
     }
 
+    interface ISaveExitState {
+        /** 需要保存的数据（只能是 JSON 兼容的数据） */
+        data: any
+        /** 超时时刻，在这个时刻后，保存的数据保证一定被丢弃，默认为 (当前时刻 + 1 天) */
+        expireTimeStamp?: number
+    }
+
     interface GetCurrentPages {
         (): Array<Instance<IAnyObject, IAnyObject>>
     }