@ray-js/api 1.6.8 → 1.6.9

package/@types/MiniKit.d.ts

@@ -1,44 +1,16 @@
-declare enum HighwayMethod {
-  /** HTTP 请求 OPTIONS */
-  OPTIONS = 'OPTIONS',
-
-  /** HTTP 请求 GET */
-  GET = 'GET',
-
-  /** HTTP 请求 HEAD */
-  HEAD = 'HEAD',
-
-  /** HTTP 请求 POST */
-  POST = 'POST',
-
-  /** HTTP 请求 PUT */
-  PUT = 'PUT',
-
-  /** HTTP 请求 DELETE */
-  DELETE = 'DELETE',
-
-  /** HTTP 请求 TRACE */
-  TRACE = 'TRACE',
-
-  /** HTTP 请求 TRACE */
-  CONNECT = 'CONNECT',
-}
-
 /**
  * MiniKit
  *
- * @version 3.12.1
+ * @version 3.14.1
  */
 declare namespace ty {
   /**
-   * 特殊方法：是否异层渲染响应
-   */
+   *@description 特殊方法：是否异层渲染响应*/
   export function nativeDisabled(params: {
     /** 禁用异层渲染手势分发 */
     nativeDisabled: boolean
     /** 需要禁止或启用手势分发的页面id */
     pageId: string
-    complete?: () => void
     success?: (params: string) => void
     fail?: (params: {
       errorMsg: string
@@ -48,11 +20,11 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 通用方法：调用组件API
-   */
+   *@description 通用方法：用于基础库给原生异层渲染组件发送消息*/
   export function nativeInovke(params: {
     /** 原生组件类型 */
     type?: number
@@ -63,8 +35,7 @@ declare namespace ty {
     /** 小程序页面id */
     pageId: string
     /** 参数等 */
-    params: Record<string, string>
-    complete?: () => void
+    params: any
     success?: (params: {}) => void
     fail?: (params: {
       errorMsg: string
@@ -74,16 +45,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 获取权限的配置信息
-   */
+   *@description 获取权限的配置信息*/
   export function getPermissionConfig(params?: {
-    complete?: () => void
     success?: (params: {
       /** 权限相关配置信息 */
-      result: Record<string, any>
+      result: any
     }) => void
     fail?: (params: {
       errorMsg: string
@@ -93,24 +63,22 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 获取权限的配置信息
-   */
+   *@description 获取权限的配置信息*/
   export function getPermissionConfigSync(): {
     /** 权限相关配置信息 */
-    result: Record<string, any>
+    result: any
   }
 
   /**
-   * 调起客户端小程序设置界面，返回用户设置的操作结果。
-   */
+   *@description 调起客户端小程序设置界面，返回用户设置的操作结果。*/
   export function openSetting(params?: {
-    complete?: () => void
     success?: (params: {
       /** 用户授权设置信息 */
-      scope: Record<string, boolean>
+      scope: any
     }) => void
     fail?: (params: {
       errorMsg: string
@@ -120,15 +88,16 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 设置调试模式
-   */
+   *@description 设置vconsole调试模式开关
+   *true: 开启vconsole
+   *false: 关闭vconsole*/
   export function changeDebugMode(params: {
     /** 调试模式开关 */
     isEnable: boolean
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -138,13 +107,13 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 打开帮助中心，默认：面板小程序会跳转到面板帮助中心，普通小程序会跳转到App帮助中心
-   */
+   *@description 打开帮助中心，默认：面板小程序会跳转到面板帮助中心，普通小程序会跳转到App帮助中心
+   *@error {7: 'API Internal processing failed'}*/
   export function openHelpCenter(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -154,15 +123,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 显示 tabBar 某一项的右上角的红点
-   */
+   *@description 显示 tabBar 某一项的右上角的红点
+   *@error {40008: 'no tab config'}*/
   export function showTabBarRedDot(params: {
     /** tabBar 的哪一项，从左边算起 */
     index: number
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -172,15 +141,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 显示 tabBar
-   */
+   *@description 显示 tabBar
+   *@error {40008: 'no tab config'}*/
   export function showTabBar(params: {
     /** 是否需要动画效果 */
     animation: boolean
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -190,11 +159,12 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 动态设置 tabBar 的整体样式
-   */
+   *@description 动态设置 tabBar 的整体样式
+   *@error {40008: 'no tab config'}*/
   export function setTabBarStyle(params: {
     /** tab 上的文字默认颜色 */
     color: string
@@ -204,7 +174,6 @@ declare namespace ty {
     backgroundColor: string
     /** tabBar上边框的颜色， 仅支持 black/white */
     borderStyle: string
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -214,11 +183,12 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 动态设置 tabBar 某一项的内容
-   */
+   *@description 动态设置 tabBar 某一项的内容
+   *@error {40008: 'no tab config'}*/
   export function setTabBarItem(params: {
     /** tabBar 的哪一项，从左边算起 */
     index: number
@@ -228,7 +198,6 @@ declare namespace ty {
     iconPath: string
     /** 选中时的图片路径 */
     selectedIconPath: string
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -238,17 +207,17 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 为 tabBar 某一项的右上角添加文本
-   */
+   *@description 为 tabBar 某一项的右上角添加文本
+   *@error {40008: 'no tab config'}*/
   export function setTabBarBadge(params: {
     /** tabBar 的哪一项，从左边算起 */
     index: number
     /** 显示的文本，超过 4 个字符则显示成 ... */
     text: string
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -258,17 +227,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 移除 tabBar 某一项右上角的文本
-   */
+   *@description 移除 tabBar 某一项右上角的文本
+   *@error {40008: 'no tab config'}*/
   export function removeTabBarBadge(params: {
     /** tabBar 的哪一项，从左边算起 */
     index: number
-    /** 显示的文本，超过 4 个字符则显示成 ... */
-    text: string
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -278,15 +245,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 隐藏 tabBar 某一项的右上角的红点
-   */
+   *@description 隐藏 tabBar 某一项的右上角的红点
+   *@error {40008: 'no tab config'}*/
   export function hideTabBarRedDot(params: {
     /** tabBar 的哪一项，从左边算起 */
     index: number
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -296,15 +263,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 隐藏 tabBar
-   */
+   *@description 隐藏 tabBar
+   *@error {40008: 'no tab config'}*/
   export function hideTabBar(params: {
     /** 是否需要动画效果 */
     animation: boolean
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -314,26 +281,23 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 发起highway请求
-   */
+   *@description 发起highway请求
+   *@error {5: 'The necessary parameters are missing'} | {40015: 'miniapp highway request error'}*/
   export function apiRequestByHighway(params: {
     /** api 名称 */
     api: string
     /** data 请求入参 */
-    data?: Record<string, any>
+    data?: any
     /** method 请求方法 */
     method?: HighwayMethod
-    complete?: () => void
     success?: (params: {
-      /**
-       * 请求结果
-       * thing_data_ 出参结构体， JSON序列化
-       */
+      /** 接口返回数据的序列化对象，序列化失败时为null */
       thing_json_?: {}
-      /** 元数据 */
+      /** 接口返回的原始数据 */
       data: string
     }) => void
     fail?: (params: {
@@ -344,15 +308,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 返回到上一个小程序。只有在当前小程序是被其他小程序打开时可以调用成功
-   */
+   *@description 返回到上一个小程序。只有在当前小程序是被其他小程序打开时可以调用成功
+   *@error {7: 'API Internal processing failed'} | {40003: 'miniapp not exist'}*/
   export function navigateBackMiniProgram(params?: {
     /** 需要返回给上一个小程序的数据，上一个小程序可在 App.onShow 中获取到这份数据 */
-    extraData?: Record<string, any>
-    complete?: () => void
+    extraData?: any
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -362,13 +326,13 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 退出当前小程序
-   */
+   *@description 退出当前小程序
+   *@error {40003: 'miniapp not exist'} | {40010: 'miniapp can not be exit'}*/
   export function exitMiniProgram(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -378,18 +342,20 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 获取小程序启动时的参数。与App.onLaunch的回调参数一致。
-   */
+   *@description 获取小程序启动时的参数。与App.onLaunch的回调参数一致。
+   *@error {7: 'API Internal processing failed'}*/
   export function getLaunchOptions(params?: {
-    complete?: () => void
     success?: (params: {
       /** 启动小程序的路径 (代码包路径) */
       path: string
+      /** 启动小程序的场景值 */
+      scene?: MiniAppScene
       /** 启动小程序的 query 参数 */
-      query: Record<string, any>
+      query: any
       /** 分享转发 */
       referrerInfo: ReferrerInfo
       /** API 类别: default	默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序 */
@@ -403,16 +369,19 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 获取小程序启动时的参数。与App.onLaunch的回调参数一致。
-   */
+   *@description 获取小程序启动时的参数。与App.onLaunch的回调参数一致。
+   *@error {7: 'API Internal processing failed'}*/
   export function getLaunchOptionsSync(): {
     /** 启动小程序的路径 (代码包路径) */
     path: string
+    /** 启动小程序的场景值 */
+    scene?: MiniAppScene
     /** 启动小程序的 query 参数 */
-    query: Record<string, any>
+    query: any
     /** 分享转发 */
     referrerInfo: ReferrerInfo
     /** API 类别: default	默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序 */
@@ -420,15 +389,16 @@ declare namespace ty {
   }
 
   /**
-   * 获取本次小程序启动时的参数。如果当前是冷启动，则返回值与App.onLaunch的回调参数一致；如果当前是热启动，则返回值与App.onShow 一致。
-   */
+   *@description 获取本次小程序启动时的参数。如果当前是冷启动，则返回值与App.onLaunch的回调参数一致；如果当前是热启动，则返回值与App.onShow 一致。
+   *@error {7: 'API Internal processing failed'}*/
   export function getEnterOptions(params?: {
-    complete?: () => void
     success?: (params: {
       /** 启动小程序的路径 (代码包路径) */
       path: string
+      /** 启动小程序的场景值 */
+      scene?: MiniAppScene
       /** 启动小程序的 query 参数 */
-      query: Record<string, any>
+      query: any
       /** 分享转发 */
       referrerInfo: ReferrerInfo
       /** API 类别: default	默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序 */
@@ -442,16 +412,19 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 获取本次小程序启动时的参数。如果当前是冷启动，则返回值与App.onLaunch的回调参数一致；如果当前是热启动，则返回值与App.onShow 一致。
-   */
+   *@description 获取本次小程序启动时的参数。如果当前是冷启动，则返回值与App.onLaunch的回调参数一致；如果当前是热启动，则返回值与App.onShow 一致。
+   *@error {7: 'API Internal processing failed'}*/
   export function getEnterOptionsSync(): {
     /** 启动小程序的路径 (代码包路径) */
     path: string
+    /** 启动小程序的场景值 */
+    scene?: MiniAppScene
     /** 启动小程序的 query 参数 */
-    query: Record<string, any>
+    query: any
     /** 分享转发 */
     referrerInfo: ReferrerInfo
     /** API 类别: default	默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序 */
@@ -459,12 +432,11 @@ declare namespace ty {
   }
 
   /**
-   * 小程序看板的标题，小程序名称，面板名称等
-   */
+   *@description 设置小程序看板页标题，小程序名称，面板名称等
+   *@error {5: 'The necessary parameters are missing'}*/
   export function setBoardTitle(params: {
-    /** 看板的标题 */
+    /** 看板页标题 */
     title: string
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -474,20 +446,20 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 小程序看板的标题，小程序名称，面板名称等
-   */
+   *@description 设置小程序看板页标题，小程序名称，面板名称等
+   *@error {5: 'The necessary parameters are missing'}*/
   export function setBoardTitleSync(boardBean?: BoardBean): null
 
   /**
-   * 小程序看板的icon，小程序icon，面板icon等
-   */
+   *@description 设置小程序看板页icon，小程序icon，面板icon等
+   *@error {5: 'The necessary parameters are missing'}*/
   export function setBoardIcon(params: {
-    /** 看板的icon */
+    /** 看板页icon */
     icon: string
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -497,18 +469,18 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 小程序看板的icon，小程序icon，面板icon等
-   */
+   *@description 设置小程序看板页icon，小程序icon，面板icon等
+   *@error {5: 'The necessary parameters are missing'}*/
   export function setBoardIconSync(boardIconBean?: BoardIconBean): null
 
   /**
-   * 显示小程序看板中的标题和icon
-   */
+   *@description 显示小程序看板页的标题和icon
+   *@error {7: 'API Internal processing failed'}*/
   export function showBoardTitleIcon(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -518,18 +490,18 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 显示小程序看板中的标题和icon
-   */
+   *@description 显示小程序看板页的标题和icon
+   *@error {7: 'API Internal processing failed'}*/
   export function showBoardTitleIconSync(): null
 
   /**
-   * 隐藏小程序看板中的标题和icon
-   */
+   *@description 隐藏小程序看板页的标题和icon
+   *@error {7: 'API Internal processing failed'}*/
   export function hideBoardTitleIcon(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -539,18 +511,18 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 隐藏小程序看板中的标题和icon
-   */
+   *@description 隐藏小程序看板页的标题和icon
+   *@error {7: 'API Internal processing failed'}*/
   export function hideBoardTitleIconSync(): null
 
   /**
-   * 获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。
-   */
+   *@description 获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。
+   *@error {7: 'API Internal processing failed'}*/
   export function getMenuButtonBoundingClientRect(params?: {
-    complete?: () => void
     success?: (params: {
       /** 宽度，单位：px */
       width: number
@@ -573,11 +545,12 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。
-   */
+   *@description 获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。
+   *@error {7: 'API Internal processing failed'}*/
   export function getMenuButtonBoundingClientRectSync(): {
     /** 宽度，单位：px */
     width: number
@@ -594,14 +567,13 @@ declare namespace ty {
   }
 
   /**
-   * 预下载智能小程序，此接口仅供提供预下载普通智能小程序调用，面板小程序的预下载需要使用另外的接口。
-   */
+   *@description 预下载智能小程序，此接口仅供提供预下载普通智能小程序调用，面板小程序的预下载需要使用另外的接口。
+   *@error {5: 'The necessary parameters are missing'} | {6: 'The parameter format is incorrect'} | {7: 'API Internal processing failed'}*/
   export function preDownloadMiniApp(params: {
     /** 小程序id */
     miniAppId: string
     /** 指定小程序版本(可选参数) */
     miniAppVersion?: string
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -611,15 +583,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 调用接口获取登录凭证（code）。通过凭证进而换取用户登录态信息，包括用户在当前小程序的唯一标识（openid）、iot账号下的唯一标识（unionid）
-   */
+   *@description 调用接口获取登录凭证（code）。通过凭证进而换取用户登录态信息，包括用户在当前小程序的唯一标识（openid）、iot账号下的唯一标识（unionid）
+   *@error {8: 'Method Unauthorized access'} | {30001: 'atop request error'} | {40018: 'query auth code fail'}*/
   export function login(params?: {
     /** 超时时间，单位ms */
     timeout?: number
-    complete?: () => void
     success?: (params: {
       /** 用户登录凭证（有效期五分钟） */
       code: string
@@ -632,15 +604,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 屏幕旋转设置，auto / portrait / landscape。pad模式下不支持屏幕旋转
-   */
+   *@description 屏幕旋转设置，auto / portrait / landscape。pad模式下不支持屏幕旋转
+   *@error {5: 'The necessary parameters are missing'} | {8: 'Method Unauthorized access'} | {40021: 'this page is not support set orientation'}*/
   export function setPageOrientation(params: {
     /** 屏幕旋转设置， auto(暂不支持) / portrait / landscape */
     pageOrientation: string
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -650,13 +622,13 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 隐藏右上角胶囊按钮
-   */
+   *@description 隐藏右上角胶囊按钮
+   *@error {40022: 'this page can not hide menu button'}*/
   export function hideMenuButton(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -666,13 +638,13 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 显示右上角胶囊按钮
-   */
+   *@description 显示右上角胶囊按钮
+   *@error {40022: 'this page can not hide menu button'}*/
   export function showMenuButton(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -682,13 +654,13 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 显示手机状态栏
-   */
+   *@description 显示手机状态栏
+   *@error {7: 'API Internal processing failed'}*/
   export function showStatusBar(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -698,13 +670,13 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 隐藏手机状态栏
-   */
+   *@description 隐藏手机状态栏
+   *@error {7: 'API Internal processing failed'}*/
   export function hideStatusBar(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -714,13 +686,13 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 关闭小部件
-   */
+   *@description 关闭小部件
+   *@error {7: 'API Internal processing failed'}*/
   export function exitMiniWidget(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -730,15 +702,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 判断设备上是否有已经安装相应应用或可以处理URL的程序，返回结果是一个对象，只有一个参数，格式为Boolean值。
-   */
+   *@description 判断设备上是否有已经安装相应应用或可以处理URL的程序，返回结果是一个对象，只有一个参数，格式为Boolean值。
+   *@error {7: 'API Internal processing failed'}*/
   export function canOpenURL(params: {
     /** 要打开的url */
     url: string
-    complete?: () => void
     success?: (params: {
       /** 是否支持打开对应的url */
       isCanOpen?: boolean
@@ -751,23 +723,23 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 判断设备上是否有已经安装相应应用或可以处理URL的程序，返回结果是一个对象，只有一个参数，格式为Boolean值。
-   */
+   *@description 判断设备上是否有已经安装相应应用或可以处理URL的程序，返回结果是一个对象，只有一个参数，格式为Boolean值。
+   *@error {7: 'API Internal processing failed'}*/
   export function canOpenURLSync(openURLBean?: OpenURLBean): {
     /** 是否支持打开对应的url */
     isCanOpen?: boolean
   }
 
   /**
-   * 打开设备上的某个应用或可以处理URL的程序。
-   */
+   *@description 打开设备上的某个应用或可以处理URL的程序。
+   *@error {40026: 'open url fail, not exist app can open it.'}*/
   export function openURL(params: {
     /** 要打开的url */
     url: string
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -777,13 +749,13 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 获取小程序账号信息
-   */
+   *@description 获取小程序账号信息
+   *@error {7: 'API Internal processing failed'}*/
   export function getAccountInfo(params?: {
-    complete?: () => void
     success?: (params: {
       /** 小程序账号信息 */
       miniProgram: MiniProgramAccountInfo
@@ -796,21 +768,21 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 获取小程序账号信息
-   */
+   *@description 获取小程序账号信息
+   *@error {7: 'API Internal processing failed'}*/
   export function getAccountInfoSync(): {
     /** 小程序账号信息 */
     miniProgram: MiniProgramAccountInfo
   }
 
   /**
-   * 获取小程序自定义配置
-   */
+   *@description 获取小程序自定义配置
+   *@error {7: 'API Internal processing failed'}*/
   export function getMiniAppConfig(params?: {
-    complete?: () => void
     success?: (params: {
       /** 小程序自定义配置 */
       config: {}
@@ -823,21 +795,21 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 获取小程序自定义配置
-   */
+   *@description 获取小程序自定义配置
+   *@error {7: 'API Internal processing failed'}*/
   export function getMiniAppConfigSync(): {
     /** 小程序自定义配置 */
     config: {}
   }
 
   /**
-   * 唤起小程序看板页
-   */
+   *@description 唤起小程序看板页
+   *@error {7: 'API Internal processing failed'}*/
   export function showBoard(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -847,17 +819,17 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 重置小程序看板页自定义栏item
-   */
+   *@description 重置小程序看板页自定义栏item
+   *@error {5: 'The necessary parameters are missing'}*/
   export function resetBoardMenus(params: {
     /** 生效页面, 默认当前页面 */
     effectPage?: EffectPage
     /** item列表 */
     menus: BoardItemBean[]
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -867,17 +839,17 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 重置小程序看板页默认栏item
-   */
+   *@description 重置小程序看板页默认栏item
+   *@error {5: 'The necessary parameters are missing'}*/
   export function resetSystemMenus(params: {
     /** 生效页面, 默认当前页面 */
     effectPage?: EffectPage
     /** item列表 */
     menus: BoardItemBean[]
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -887,17 +859,17 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 针对具体的看板itemKey显示红点
-   */
+   *@description 针对具体的看板itemKey显示红点
+   *@error {7: 'API Internal processing failed'}*/
   export function showRedBot(params: {
     /** 生效页面, 默认当前页面 */
     effectPage?: EffectPage
     /** 看板item名称 */
     key: string
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -907,17 +879,17 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 针对具体的看板itemKey隐藏红点
-   */
+   *@description 针对具体的看板itemKey隐藏红点
+   *@error {7: 'API Internal processing failed'}*/
   export function hiddenRedBot(params: {
     /** 生效页面, 默认当前页面 */
     effectPage?: EffectPage
     /** 看板item名称 */
     key: string
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -927,13 +899,13 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 关闭小程序页面加载框
-   */
+   *@description 关闭小程序页面加载框, 如果页面配置中配置了manualHideLoading:true，需要手动调用此接口关闭加载框
+   *@error {7: 'API Internal processing failed'}*/
   export function hideRenderLoading(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -943,15 +915,33 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 设置小程序页面背景图片，调用后小程序导航栏背景色将变为透明
-   */
+   *@description 设置小程序页面背景图片，调用后小程序导航栏背景色将变为透明
+   *@error {7: 'API Internal processing failed'}*/
   export function setBackgroundImage(params: {
     /** 图片地址，支持网络图片和本地图片 */
     imageUrl: string
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
     complete?: () => void
+  }): void
+
+  /**
+   *@description 设置小程序页面背景颜色
+   *@error {7: 'API Internal processing failed'}*/
+  export function setBackgroundColor(params: {
+    /** 当前页面背景颜色 */
+    color: string
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -961,13 +951,12 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 在当前页面显示导航条加载动画
-   */
+   *@description 在当前页面显示导航条加载动画*/
   export function showNavigationBarLoading(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -977,15 +966,14 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 动态设置当前页面的标题
-   */
+   *@description 动态设置当前页面的标题*/
   export function setNavigationBarTitle(params: {
     /** 页面标题 */
     title: string
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -995,11 +983,11 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 设置页面导航条颜色
-   */
+   *@description 设置页面导航条颜色*/
   export function setNavigationBarColor(params: {
     /** 前景颜色值，包括按钮、标题、状态栏的颜色，仅支持 #ffffff 和 #000000 */
     frontColor: string
@@ -1007,7 +995,6 @@ declare namespace ty {
     backgroundColor: string
     /** 动画效果 */
     animation: NavigationBarColorAnimationInfo
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -1017,13 +1004,12 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 在当前页面隐藏导航条加载动画
-   */
+   *@description 在当前页面隐藏导航条加载动画*/
   export function hideNavigationBarLoading(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -1033,13 +1019,12 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 隐藏返回首页按钮
-   */
+   *@description 隐藏返回首页按钮*/
   export function hideHomeButton(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -1049,13 +1034,14 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 路由到新页面
-   */
+   *@description 路由到新页面
+   *@error {40002: 'the page not be found'} | {40003: 'miniapp not exist'} | {40004: 'navigatorTo cannot open tab url'} | {40006: 'A maximum of ten pages can be opened'}*/
   export function navigateTo(params: {
-    /** 页面路径 */
+    /** 页面路径, 参数需要做 url encode 处理 */
     url: string
     /** 打开方式，支持全屏full，半屏half；默认全屏full */
     type?: string
@@ -1072,7 +1058,6 @@ declare namespace ty {
      * 注意：Android 显示区域不包括状态栏，iOS显示区域包括状态栏。
      */
     topMarginPercent?: number
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -1082,15 +1067,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 关闭当前页面，返回上一页面或多级页面
-   */
+   *@description 关闭当前页面，返回上一页面或多级页面
+   *@error {40001: 'the last page cannot be navigator back'} | {40003: 'miniapp not exist'} | {40017: 'navigate back event already been intercept'}*/
   export function navigateBack(params?: {
     /** 返回的页面数，如果 delta 大于现有页面数，则返回到首页 */
     delta?: number
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -1100,30 +1085,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 关闭当前页面，跳转到应用内的某个页面
-   */
+   *@description 关闭当前页面，跳转到应用内的某个页面
+   *@error {40002: 'the page not be found'} | {40003: 'miniapp not exist'} | {40004: 'navigatorTo cannot open tab url'}*/
   export function redirectTo(params: {
-    /** 页面路径 */
+    /** 页面路径, 参数需要做 url encode 处理 */
     url: string
-    /** 打开方式，支持全屏full，半屏half；默认全屏full */
-    type?: string
-    /**
-     * 非全屏页面距离屏幕顶部的距离，type 为 half 时有效
-     * 取值范围：【1-屏幕的高度】单位：px
-     * 注意：Android 显示区域不包括状态栏，iOS显示区域包括状态栏。
-     * 因此 Android 的 topMargin 的最大值是屏幕高度减去状态栏的高度。
-     */
-    topMargin?: number
-    /**
-     * 非全屏页面距离屏幕顶部的百分比，type 为 half 时有效，优先级高于 topMargin
-     * 取值范围【1-99】单位：百分比
-     * 注意：Android 显示区域不包括状态栏，iOS显示区域包括状态栏。
-     */
-    topMarginPercent?: number
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -1133,30 +1103,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 关闭所有页面，打开到应用内的某个页面
-   */
+   *@description 关闭所有页面，打开到应用内的某个页面
+   *@error {40002: 'the page not be found'} | {40003: 'miniapp not exist'}*/
   export function reLaunch(params: {
-    /** 页面路径 */
+    /** 页面路径, 参数需要做 url encode 处理 */
     url: string
-    /** 打开方式，支持全屏full，半屏half；默认全屏full */
-    type?: string
-    /**
-     * 非全屏页面距离屏幕顶部的距离，type 为 half 时有效
-     * 取值范围：【1-屏幕的高度】单位：px
-     * 注意：Android 显示区域不包括状态栏，iOS显示区域包括状态栏。
-     * 因此 Android 的 topMargin 的最大值是屏幕高度减去状态栏的高度。
-     */
-    topMargin?: number
-    /**
-     * 非全屏页面距离屏幕顶部的百分比，type 为 half 时有效，优先级高于 topMargin
-     * 取值范围【1-99】单位：百分比
-     * 注意：Android 显示区域不包括状态栏，iOS显示区域包括状态栏。
-     */
-    topMarginPercent?: number
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -1166,30 +1121,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
-   */
+   *@description 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
+   *@error {40002: 'the page not be found'} | {40003: 'miniapp not exist'} | {40007: 'cannot find page url from tab config'} | {40008: 'no tab config'} | {40011: 'miniapp can not support on tab'}*/
   export function switchTab(params: {
-    /** 页面路径 */
+    /** 页面路径, 不支持参数 */
     url: string
-    /** 打开方式，支持全屏full，半屏half；默认全屏full */
-    type?: string
-    /**
-     * 非全屏页面距离屏幕顶部的距离，type 为 half 时有效
-     * 取值范围：【1-屏幕的高度】单位：px
-     * 注意：Android 显示区域不包括状态栏，iOS显示区域包括状态栏。
-     * 因此 Android 的 topMargin 的最大值是屏幕高度减去状态栏的高度。
-     */
-    topMargin?: number
-    /**
-     * 非全屏页面距离屏幕顶部的百分比，type 为 half 时有效，优先级高于 topMargin
-     * 取值范围【1-99】单位：百分比
-     * 注意：Android 显示区域不包括状态栏，iOS显示区域包括状态栏。
-     */
-    topMarginPercent?: number
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -1199,17 +1139,15 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 判断自定义API是否可用
-   */
+   *@description 判断自定义API是否可用
+   *@error {5: 'The necessary parameters are missing'} | {40020: 'ext api fail'}*/
   export function extApiCanIUse(params: {
     /** api名称 */
     api: string
-    /** api参数 */
-    params?: Record<string, any>
-    complete?: () => void
     success?: (params: {
       /** 当前版本是否可用 */
       result: boolean
@@ -1222,25 +1160,25 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 判断自定义API是否可用
-   */
-  export function extApiCanIUseSync(extApiBean?: ExtApiBean): {
+   *@description 判断自定义API是否可用
+   *@error {5: 'The necessary parameters are missing'} | {40020: 'ext api fail'}*/
+  export function extApiCanIUseSync(caniuseBean?: CanIUseBean): {
     /** 当前版本是否可用 */
     result: boolean
   }
 
   /**
-   * 调用自定义API
-   */
+   *@description 调用自定义API
+   *@error {40019: 'ext api not found'} | {40020: 'ext api fail'}*/
   export function extApiInvoke(params: {
     /** api名称 */
     api: string
     /** api参数 */
-    params?: Record<string, any>
-    complete?: () => void
+    params?: any
     success?: (params: {
       /** extApi返回数据 */
       data?: {}
@@ -1253,21 +1191,21 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 调用自定义API
-   */
+   *@description 调用自定义API
+   *@error {40019: 'ext api not found'} | {40020: 'ext api fail'}*/
   export function extApiInvokeSync(extApiBean?: ExtApiBean): {
     /** extApi返回数据 */
     data?: {}
   }
 
   /**
-   * 开始下拉刷新。调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。
-   */
+   *@description 开始下拉刷新。调用后触发当前页面下拉刷新动画，效果与用户手动下拉刷新一致。
+   *@error {7: 'API Internal processing failed'}*/
   export function startPullDownRefresh(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -1277,13 +1215,13 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 停止当前页面下拉刷新。
-   */
+   *@description 停止当前页面下拉刷新。
+   *@error {7: 'API Internal processing failed'}*/
   export function stopPullDownRefresh(params?: {
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -1293,15 +1231,14 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 移除当前widget视图, 仅在widget内部调用且不支持Dialog形式
-   */
+   *@description 移除当前widget视图, 仅在widget内部调用且不支持Dialog形式*/
   export function widgetRemove(params?: {
     /** 移除模式 */
     mode?: WidgetMode
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -1311,62 +1248,68 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
+    complete?: () => void
   }): void
 
   /**
-   * 原生上报的事件
-   */
-  export function onNativeEvent(
-    listener: (params: NativeUploadData) => void
-  ): void
+   *@description 原生上报的事件*/
+  export function onNativeEvent(listener: (params: NativeUploadData) => void): void
 
   /**
-   * 取消监听：原生上报的事件
-   */
-  export function offNativeEvent(
-    listener: (params: NativeUploadData) => void
-  ): void
+   *@description 移除监听：原生上报的事件*/
+  export function offNativeEvent(listener: (params: NativeUploadData) => void): void
 
   export enum HighwayMethod {
     /** HTTP 请求 OPTIONS */
-    OPTIONS = "OPTIONS",
+    OPTIONS = 'OPTIONS',
 
     /** HTTP 请求 GET */
-    GET = "GET",
+    GET = 'GET',
 
     /** HTTP 请求 HEAD */
-    HEAD = "HEAD",
+    HEAD = 'HEAD',
 
     /** HTTP 请求 POST */
-    POST = "POST",
+    POST = 'POST',
 
     /** HTTP 请求 PUT */
-    PUT = "PUT",
+    PUT = 'PUT',
 
     /** HTTP 请求 DELETE */
-    DELETE = "DELETE",
+    DELETE = 'DELETE',
 
     /** HTTP 请求 TRACE */
-    TRACE = "TRACE",
+    TRACE = 'TRACE',
 
     /** HTTP 请求 TRACE */
-    CONNECT = "CONNECT",
+    CONNECT = 'CONNECT',
+  }
+
+  export enum MiniAppScene {
+    /** 默认值 */
+    DEFAULT = 1000,
+
+    /** 通过最近使用小程序列表进入 */
+    RECENTLY_USED = 1001,
+
+    /** 通过URL映射进入 */
+    URL_MAPPING = 1002,
   }
 
   export type ReferrerInfo = {
-    /** 来源小程序、公众号或 App 的 appId */
+    /** 来源小程序的 appId */
     appId: string
     /** 来源小程序传过来的数据，特定scene支持 */
-    extraData: Record<string, any>
+    extraData: any
   }
 
   export type BoardBean = {
-    /** 看板的标题 */
+    /** 看板页标题 */
     title: string
   }
 
   export type BoardIconBean = {
-    /** 看板的icon */
+    /** 看板页icon */
     icon: string
   }
 
@@ -1395,10 +1338,10 @@ declare namespace ty {
 
   export enum EffectPage {
     /** 当前页面 */
-    current = "current",
+    current = 'current',
 
     /** 所有页面 */
-    all = "all",
+    all = 'all',
   }
 
   export type BoardItemBean = {
@@ -1417,27 +1360,32 @@ declare namespace ty {
     duration?: number
     /**
      * 动画变化方式
-     *   'linear'	动画从头到尾的速度是相同的
-     *   'easeIn'	动画以低速开始
-     *   'easeOut'	动画以低速结束
-     *   'easeInOut'	动画以低速开始和结束
+     * 'linear'	动画从头到尾的速度是相同的
+     * 'easeIn'	动画以低速开始
+     * 'easeOut'	动画以低速结束
+     * 'easeInOut'	动画以低速开始和结束
      */
     timingFunc?: string
   }
 
+  export type CanIUseBean = {
+    /** api名称 */
+    api: string
+  }
+
   export type ExtApiBean = {
     /** api名称 */
     api: string
     /** api参数 */
-    params?: Record<string, any>
+    params?: any
   }
 
   export enum WidgetMode {
     /** 单次移除 */
-    ONCE = "ONCE",
+    ONCE = 'ONCE',
 
     /** 永久移除 */
-    FOREVER = "FOREVER",
+    FOREVER = 'FOREVER',
   }
 
   export type NativeUploadData = {
@@ -1448,11 +1396,9 @@ declare namespace ty {
     /** 小程序页面id */
     pageId: string
     /** 数据等 */
-    data: Record<string, Object>
+    data: any
   }
 
-  export type Object = {}
-
   export type NativeDisabledParam = {
     /** 禁用异层渲染手势分发 */
     nativeDisabled: boolean
@@ -1470,17 +1416,19 @@ declare namespace ty {
     /** 小程序页面id */
     pageId: string
     /** 参数等 */
-    params: Record<string, string>
+    params: any
   }
 
+  export type Object = {}
+
   export type PermissionConfig = {
     /** 权限相关配置信息 */
-    result: Record<string, any>
+    result: any
   }
 
   export type AuthSetting = {
     /** 用户授权设置信息 */
-    scope: Record<string, boolean>
+    scope: any
   }
 
   export type DebugModeSetting = {
@@ -1488,7 +1436,7 @@ declare namespace ty {
     isEnable: boolean
   }
 
-  export type RedDotParams = {
+  export type TabBarIndexBean = {
     /** tabBar 的哪一项，从左边算起 */
     index: number
   }
@@ -1531,31 +1479,30 @@ declare namespace ty {
     /** api 名称 */
     api: string
     /** data 请求入参 */
-    data?: Record<string, any>
+    data?: any
     /** method 请求方法 */
     method?: HighwayMethod
   }
 
   export type HighwayRequestResponse = {
-    /**
-     * 请求结果
-     * thing_data_ 出参结构体， JSON序列化
-     */
+    /** 接口返回数据的序列化对象，序列化失败时为null */
     thing_json_?: {}
-    /** 元数据 */
+    /** 接口返回的原始数据 */
     data: string
   }
 
   export type BackMiniProgramBean = {
     /** 需要返回给上一个小程序的数据，上一个小程序可在 App.onShow 中获取到这份数据 */
-    extraData?: Record<string, any>
+    extraData?: any
   }
 
   export type MiniAppOptions = {
     /** 启动小程序的路径 (代码包路径) */
     path: string
+    /** 启动小程序的场景值 */
+    scene?: MiniAppScene
     /** 启动小程序的 query 参数 */
-    query: Record<string, any>
+    query: any
     /** 分享转发 */
     referrerInfo: ReferrerInfo
     /** API 类别: default	默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序 */
@@ -1633,6 +1580,11 @@ declare namespace ty {
     imageUrl: string
   }
 
+  export type BackgroundColorBean = {
+    /** 当前页面背景颜色 */
+    color: string
+  }
+
   export type CreateReq = {
     /** managerId: 通知管理器id */
     managerId: string
@@ -1660,7 +1612,7 @@ declare namespace ty {
   }
 
   export type RouteBean = {
-    /** 页面路径 */
+    /** 页面路径, 参数需要做 url encode 处理 */
     url: string
     /** 打开方式，支持全屏full，半屏half；默认全屏full */
     type?: string
@@ -1684,6 +1636,21 @@ declare namespace ty {
     delta?: number
   }
 
+  export type RedirectBean = {
+    /** 页面路径, 参数需要做 url encode 处理 */
+    url: string
+  }
+
+  export type ReLaunchBean = {
+    /** 页面路径, 参数需要做 url encode 处理 */
+    url: string
+  }
+
+  export type SwitchTabBean = {
+    /** 页面路径, 不支持参数 */
+    url: string
+  }
+
   export type SuccessResult = {
     /** 当前版本是否可用 */
     result: boolean
@@ -1700,14 +1667,13 @@ declare namespace ty {
   }
 
   /**
-   * 原生主动发送通知
-   */
-  interface CreateNativeEventManagerTask {
+   *@description 原生主动发送通知*/
+  interface NativeEventManager {
     /**
-     * 停止监听通知
-     */
+     *@description 停止监听通知
+     *@deprecated 方法已停止维护，请谨慎使用，推荐使用offListener代替。
+     *@error {5: 'The necessary parameters are missing'}*/
     offerListener(params: {
-      complete?: () => void
       success?: (params: null) => void
       fail?: (params: {
         errorMsg: string
@@ -1717,24 +1683,34 @@ declare namespace ty {
           errorMsg: string
         }
       }) => void
+      complete?: () => void
     }): void
 
     /**
-     * 开始监听通知
-     */
+     *@description 开始监听通知
+     *@error {5: 'The necessary parameters are missing'}*/
     onListener(
       listener: (params: {
-        /** managerId */
-        managerId: string
+        /** data: 通知内容 */
+        data: {}
+      }) => void
+    ): void
+
+    /**
+     *@description 停止监听通知
+     *@error {5: 'The necessary parameters are missing'}*/
+    offListener(
+      listener: (params: {
         /** data: 通知内容 */
         data: {}
       }) => void
     ): void
   }
+  /**
+   *@description 创建原生通知管理器*/
   export function createNativeEventManager(params: {
     /** name: 通知名称 */
     name: string
-    complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
       errorMsg: string
@@ -1744,5 +1720,6 @@ declare namespace ty {
         errorMsg: string
       }
     }) => void
-  }): CreateNativeEventManagerTask
+    complete?: () => void
+  }): NativeEventManager
 }