@ray-js/api 1.6.0-beta.9 → 1.6.0

package/@types/HomeKit.d.ts

@@ -179,80 +179,6 @@ declare namespace ty.home {
     }) => void
   }): void
 
-  // /**
-  //  * 验证码校验成功
-  //  */
-  // export function onTicketSuccess(params?: {
-  //   /** ticket */
-  //   map?: Record<string, string>
-  //   complete?: () => void
-  //   success?: (params: {
-  //     /** ticket */
-  //     map?: Record<string, string>
-  //   }) => void
-  //   fail?: (params: {
-  //     errorMsg: string
-  //     errorCode: string | number
-  //     innerError: {
-  //       errorCode: string | number
-  //       errorMsg: string
-  //     }
-  //   }) => void
-  // }): void
-
-  // /**
-  //  * 【废弃】打开推荐场景详情页面
-  //  *请用deviceKit包下同名方法替代
-  //  *详细文档链接：https://wiki.tuya-inc.com:7799/page/1456192108871295013
-  //  */
-  // export function openRecommendSceneDetail(params: {
-  //   /** 来源 */
-  //   source: string
-  //   /** 场景模型 */
-  //   sceneModel: Record<string, any>
-  //   complete?: () => void
-  //   success?: (params: {
-  //     /** 返回状态，默认返回 true */
-  //     status?: boolean
-  //     /** 成功返回的类型。0-未操作，1-保存成功，2-点击不感兴趣 */
-  //     type: number
-  //     /** 返回的场景数据，可能为空 */
-  //     data?: Record<string, any>
-  //   }) => void
-  //   fail?: (params: {
-  //     errorMsg: string
-  //     errorCode: string | number
-  //     innerError: {
-  //       errorCode: string | number
-  //       errorMsg: string
-  //     }
-  //   }) => void
-  // }): void
-
-  // /**
-  //  * 【废弃】跳转一键执行和自动化页面
-  //  *请用deviceKit包下同名方法替代
-  //  */
-  // export function openDeviceExecutionAndAnutomation(params: {
-  //   /**
-  //    * deviceId
-  //    * 设备 id
-  //    */
-  //   deviceId: string
-  //   /** 页面标题，Android 需要 */
-  //   title?: string
-  //   complete?: () => void
-  //   success?: (params: null) => void
-  //   fail?: (params: {
-  //     errorMsg: string
-  //     errorCode: string | number
-  //     innerError: {
-  //       errorCode: string | number
-  //       errorMsg: string
-  //     }
-  //   }) => void
-  // }): void
-
   export type RoomData = {
     /** 房间id */
     roomId: number

package/@types/MiniKit.d.ts

@@ -27,14 +27,28 @@ declare enum HighwayMethod {
 /**
  * MiniKit
  *
- * @version 3.1.0
+ * @version 3.12.1
  */
 declare namespace ty {
   /**
-   * 是否禁止原生组件区域原生手势管理。
-   * 基础库 2.0.12 开始支持, 低版本需做兼容处理。
+   * 特殊方法：是否异层渲染响应
    */
-  export function nativeDisabled(params: boolean): void
+  export function nativeDisabled(params: {
+    /** 禁用异层渲染手势分发 */
+    nativeDisabled: boolean
+    /** 需要禁止或启用手势分发的页面id */
+    pageId: string
+    complete?: () => void
+    success?: (params: string) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
 
   /**
    * 通用方法：调用组件API
@@ -311,7 +325,7 @@ declare namespace ty {
     /** data 请求入参 */
     data?: Record<string, any>
     /** method 请求方法 */
-    method?: keyof typeof HighwayMethod
+    method?: HighwayMethod
     complete?: () => void
     success?: (params: {
       /**
@@ -792,6 +806,163 @@ declare namespace ty {
     miniProgram: MiniProgramAccountInfo
   }
 
+  /**
+   * 获取小程序自定义配置
+   */
+  export function getMiniAppConfig(params?: {
+    complete?: () => void
+    success?: (params: {
+      /** 小程序自定义配置 */
+      config: {}
+    }) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 获取小程序自定义配置
+   */
+  export function getMiniAppConfigSync(): {
+    /** 小程序自定义配置 */
+    config: {}
+  }
+
+  /**
+   * 唤起小程序看板页
+   */
+  export function showBoard(params?: {
+    complete?: () => void
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 重置小程序看板页自定义栏item
+   */
+  export function resetBoardMenus(params: {
+    /** 生效页面, 默认当前页面 */
+    effectPage?: EffectPage
+    /** item列表 */
+    menus: BoardItemBean[]
+    complete?: () => void
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 重置小程序看板页默认栏item
+   */
+  export function resetSystemMenus(params: {
+    /** 生效页面, 默认当前页面 */
+    effectPage?: EffectPage
+    /** item列表 */
+    menus: BoardItemBean[]
+    complete?: () => void
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 针对具体的看板itemKey显示红点
+   */
+  export function showRedBot(params: {
+    /** 生效页面, 默认当前页面 */
+    effectPage?: EffectPage
+    /** 看板item名称 */
+    key: string
+    complete?: () => void
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 针对具体的看板itemKey隐藏红点
+   */
+  export function hiddenRedBot(params: {
+    /** 生效页面, 默认当前页面 */
+    effectPage?: EffectPage
+    /** 看板item名称 */
+    key: string
+    complete?: () => void
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 关闭小程序页面加载框
+   */
+  export function hideRenderLoading(params?: {
+    complete?: () => void
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 设置小程序页面背景图片，调用后小程序导航栏背景色将变为透明
+   */
+  export function setBackgroundImage(params: {
+    /** 图片地址，支持网络图片和本地图片 */
+    imageUrl: string
+    complete?: () => void
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
   /**
    * 在当前页面显示导航条加载动画
    */
@@ -888,6 +1059,19 @@ declare namespace ty {
     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: {
@@ -926,6 +1110,19 @@ declare namespace ty {
     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: {
@@ -946,6 +1143,19 @@ declare namespace ty {
     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: {
@@ -966,6 +1176,19 @@ declare namespace ty {
     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: {
@@ -1072,15 +1295,63 @@ declare namespace ty {
     }) => void
   }): void
 
+  /**
+   * 移除当前widget视图, 仅在widget内部调用且不支持Dialog形式
+   */
+  export function widgetRemove(params?: {
+    /** 移除模式 */
+    mode?: WidgetMode
+    complete?: () => void
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
   /**
    * 原生上报的事件
    */
-  export function onNativeEvent(listener: (params: NativeUploadData) => void): void
+  export function onNativeEvent(
+    listener: (params: NativeUploadData) => void
+  ): void
 
   /**
    * 取消监听：原生上报的事件
    */
-  export function offNativeEvent(listener: (params: NativeUploadData) => void): void
+  export function offNativeEvent(
+    listener: (params: NativeUploadData) => void
+  ): void
+
+  export 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",
+  }
 
   export type ReferrerInfo = {
     /** 来源小程序、公众号或 App 的 appId */
@@ -1116,6 +1387,29 @@ declare namespace ty {
     envVersion: string
     /** 小程序版本号 */
     version: string
+    /** 小程序名称 */
+    appName: string
+    /** 小程序图标 */
+    appIcon: string
+  }
+
+  export enum EffectPage {
+    /** 当前页面 */
+    current = "current",
+
+    /** 所有页面 */
+    all = "all",
+  }
+
+  export type BoardItemBean = {
+    /** item名称 */
+    key: string
+    /** item图标 */
+    iconPath: string
+    /** item文案 */
+    text: string
+    /** item是否显示 */
+    isShow?: boolean
   }
 
   export type NavigationBarColorAnimationInfo = {
@@ -1138,6 +1432,14 @@ declare namespace ty {
     params?: Record<string, any>
   }
 
+  export enum WidgetMode {
+    /** 单次移除 */
+    ONCE = "ONCE",
+
+    /** 永久移除 */
+    FOREVER = "FOREVER",
+  }
+
   export type NativeUploadData = {
     /** 原生组件的EventName */
     eventName: string
@@ -1231,7 +1533,7 @@ declare namespace ty {
     /** data 请求入参 */
     data?: Record<string, any>
     /** method 请求方法 */
-    method?: keyof typeof HighwayMethod
+    method?: HighwayMethod
   }
 
   export type HighwayRequestResponse = {
@@ -1307,6 +1609,42 @@ declare namespace ty {
     miniProgram: MiniProgramAccountInfo
   }
 
+  export type MiniAppConfigResp = {
+    /** 小程序自定义配置 */
+    config: {}
+  }
+
+  export type BoardMenusBean = {
+    /** 生效页面, 默认当前页面 */
+    effectPage?: EffectPage
+    /** item列表 */
+    menus: BoardItemBean[]
+  }
+
+  export type RedBodReq = {
+    /** 生效页面, 默认当前页面 */
+    effectPage?: EffectPage
+    /** 看板item名称 */
+    key: string
+  }
+
+  export type BackgroundImageBean = {
+    /** 图片地址，支持网络图片和本地图片 */
+    imageUrl: string
+  }
+
+  export type CreateReq = {
+    /** managerId: 通知管理器id */
+    managerId: string
+    /** name: 通知名称 */
+    name: string
+  }
+
+  export type ObserverReq = {
+    /** managerId: 通知管理器id */
+    managerId: string
+  }
+
   export type NavigationBarLoadingParams = {
     /** 页面标题 */
     title: string
@@ -1326,6 +1664,19 @@ declare namespace ty {
     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
   }
 
   export type BackRouteBean = {
@@ -1342,4 +1693,56 @@ declare namespace ty {
     /** extApi返回数据 */
     data?: {}
   }
+
+  export type MiniWidgetRemoveBean = {
+    /** 移除模式 */
+    mode?: WidgetMode
+  }
+
+  /**
+   * 原生主动发送通知
+   */
+  interface CreateNativeEventManagerTask {
+    /**
+     * 停止监听通知
+     */
+    offerListener(params: {
+      complete?: () => void
+      success?: (params: null) => void
+      fail?: (params: {
+        errorMsg: string
+        errorCode: string | number
+        innerError: {
+          errorCode: string | number
+          errorMsg: string
+        }
+      }) => void
+    }): void
+
+    /**
+     * 开始监听通知
+     */
+    onListener(
+      listener: (params: {
+        /** managerId */
+        managerId: string
+        /** data: 通知内容 */
+        data: {}
+      }) => void
+    ): void
+  }
+  export function createNativeEventManager(params: {
+    /** name: 通知名称 */
+    name: string
+    complete?: () => void
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): CreateNativeEventManagerTask
 }