@ray-js/api 0.5.10 → 0.5.11

package/@types/{TYKit.d.ts → BizKit.d.ts}

@@ -1,7 +1,7 @@
 /**
- * TYKit
+ * BizKit
  *
- * @version 2.2.6
+ * @version 3.0.1
  */
 declare namespace ty {
   /**
@@ -20,7 +20,15 @@ declare namespace ty {
     /** extData 额外参数：{"GID":"xxxx"} */
     extData?: Record<string, any>
     complete?: () => void
-    success?: (success?: Record<string, any>) => void
+    success?: (params: {
+      /**
+       * 请求结果
+       * thing_data_ 出参结构体， JSON序列化
+       */
+      thing_json_?: {}
+      /** 元数据 */
+      data: string
+    }) => void
     fail?: (params: {
       errorMsg: string
       errorCode: string | number
@@ -156,6 +164,10 @@ declare namespace ty {
        * 2: 线上
        */
       appEnv?: number
+      /** app包名 */
+      appBundleId: string
+      /** app scheme */
+      appScheme: string
     }) => void
     fail?: (params: {
       errorMsg: string
@@ -292,7 +304,7 @@ declare namespace ty {
   }): void
 
   /**
-   * 打开RN面板(该方法已被废弃)
+   * 打开RN面板 (该方法已被废弃, 请使用openPanel替代)
    */
   export function openRNPanel(params: {
     /**
@@ -394,19 +406,23 @@ declare namespace ty {
   }): void
 
   /**
-   * 打开系统设置中当前应用信息界面
+   * 根据不同scope值，打开当前应用对应的设置界面
+   *"App-Settings" -> App应用设置界面
+   *"App-Settings-Permission" -> App应用权限设置界面 (Android 独有)
+   *"App-Settings-Notification" -> App应用通知设置界面 (Android 独有)
    */
   export function openAppSystemSettingPage(params: {
     /**
-     * 设置项名称
-     * “Settings” -> 手机设置主界面
-     * “Settings-Bluetooth” -> 手机蓝牙设置界面
-     * “Settings-Notification” -> 手机通知设置界面
-     * “Settings-WiFi” -> 手机设置WiFi界面
-     * “App-Settings” -> App设置界面
-     * “App-Settings-Permission” -> App权限设置界面
-     * “App-Settings-Permission” -> App权限设置界面
-     * “App-Settings-Notification” -> App通知设置界面
+     * 跳转系统-设置项名称
+     * "Settings"-> 手机设置主界面
+     * "Settings-Bluetooth" -> 手机蓝牙设置界面
+     * "Settings-WiFi" -> 手机WiFi设置界面
+     * "Settings-Location" -> 手机定位设置界面
+     * "Settings-Notification" -> 手机通知设置界面
+     * 跳转系统-应用-设置项名称
+     * "App-Settings" -> App应用设置界面
+     * "App-Settings-Permission" -> App应用权限设置界面 (Android 独有)
+     * "App-Settings-Notification" -> App应用通知设置界面 (Android 独有)
      */
     scope: string
     /** 请求code,Android特有 */
@@ -424,19 +440,25 @@ declare namespace ty {
   }): void
 
   /**
-   * 打开手机系统设置界面
+   * 根据不同scope值，打开对应的手机系统设置界面
+   *"Settings"-> 手机设置主界面
+   *"Settings-Bluetooth" -> 手机蓝牙设置界面
+   *"Settings-WiFi" -> 手机Wifi设置界面
+   *"Settings-Location" -> 手机定位设置界面
+   *"Settings-Notification" -> 手机通知设置界面
    */
   export function openSystemSettingPage(params: {
     /**
-     * 设置项名称
-     * “Settings” -> 手机设置主界面
-     * “Settings-Bluetooth” -> 手机蓝牙设置界面
-     * “Settings-Notification” -> 手机通知设置界面
-     * “Settings-WiFi” -> 手机设置WiFi界面
-     * “App-Settings” -> App设置界面
-     * “App-Settings-Permission” -> App权限设置界面
-     * “App-Settings-Permission” -> App权限设置界面
-     * “App-Settings-Notification” -> App通知设置界面
+     * 跳转系统-设置项名称
+     * "Settings"-> 手机设置主界面
+     * "Settings-Bluetooth" -> 手机蓝牙设置界面
+     * "Settings-WiFi" -> 手机WiFi设置界面
+     * "Settings-Location" -> 手机定位设置界面
+     * "Settings-Notification" -> 手机通知设置界面
+     * 跳转系统-应用-设置项名称
+     * "App-Settings" -> App应用设置界面
+     * "App-Settings-Permission" -> App应用权限设置界面 (Android 独有)
+     * "App-Settings-Notification" -> App应用通知设置界面 (Android 独有)
      */
     scope: string
     /** 请求code,Android特有 */
@@ -477,7 +499,7 @@ declare namespace ty {
    * 路由跳转原生页面
    *当传递的路由url带协议头, 则直接跳转; 若不带协议头, 则补充对应APP协议头进行跳转
    *1. 在使用万能路由跳转前, 需要在app.json中声明使用到的路由, 如果没有声明相关路由, 则该路由无法执行该方法
-   *e.g. "routers":['deviceDetail', 'tuyasmart://device']
+   *e.g. "routers":['deviceDetail', 'thingsmart://device']
    *2. 在使用router方法前, 建议使用canIUseRouter来做兼容, 处理当APP没有对应路由时执行业务兜底
    *errorCode 10014 当前路由不存在当前APP中, 不可用
    */
@@ -518,7 +540,7 @@ declare namespace ty {
   }): void
 
   /**
-   * 跳转设备详情页面, 已废弃, 推荐使用ty.device
+   * 跳转设备详情页面, 已废弃, 推荐使用thing.device
    */
   export function goDeviceDetail(params: {
     /** 设备Id */
@@ -538,7 +560,7 @@ declare namespace ty {
   }): void
 
   /**
-   * 跳转设备定时页面, 已废弃, 推荐使用ty.device
+   * 跳转设备定时页面, 已废弃, 推荐使用thing.device
    */
   export function goDeviceAlarm(params: {
     /** 设备Id */
@@ -635,6 +657,31 @@ declare namespace ty {
     }) => void
   }): void
 
+  /**
+   * 获取用户信息
+   */
+  export function getUserInfo(params?: {
+    complete?: () => void
+    success?: (params: {
+      /** nickName 用户昵称 */
+      nickName: string
+      /** 用户头像 */
+      avatarUrl: string
+      /** 国家代码 */
+      phoneCode: string
+      /** 是否是临时用户 */
+      isTemporaryUser: boolean
+    }) => void
+    failure?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
   /**
    * 压缩图片， 在保持原图长宽比基础上先裁剪至目标尺寸， 然后根据文件大小限制去执行质量压缩
    */
@@ -729,7 +776,7 @@ declare namespace ty {
   ): void
 
   /**
-   * 国家列表界面选择的国家信息
+   * 取消监听：国家列表界面选择的国家信息
    */
   export function offCountrySelectResult(
     listener: (params: CountrySelectResultResponse) => void
@@ -741,7 +788,7 @@ declare namespace ty {
   export function onUploadProgressUpdate(listener: (params: ProgressEvent) => void): void
 
   /**
-   * 上传进度回调
+   * 取消监听：上传进度回调
    */
   export function offUploadProgressUpdate(listener: (params: ProgressEvent) => void): void
 
@@ -751,7 +798,7 @@ declare namespace ty {
   export function onReceiveMessage(listener: (params: EventChannelMessageParams) => void): void
 
   /**
-   * 事件通道响应
+   * 取消监听：事件通道响应
    */
   export function offReceiveMessage(listener: (params: EventChannelMessageParams) => void): void
 
@@ -761,7 +808,7 @@ declare namespace ty {
   export function onRouterEvent(listener: (params: RouterEvent) => void): void
 
   /**
-   * 统一路由事件通知
+   * 取消监听：统一路由事件通知
    */
   export function offRouterEvent(listener: (params: RouterEvent) => void): void
 
@@ -771,7 +818,7 @@ declare namespace ty {
   export function onRouterResult(listener: (params: RouterResultResponse) => void): void
 
   /**
-   * 万能路由界面返回的数据
+   * 取消监听：万能路由界面返回的数据
    */
   export function offRouterResult(listener: (params: RouterResultResponse) => void): void
 
@@ -920,6 +967,10 @@ declare namespace ty {
      * 2: 线上
      */
     appEnv?: number
+    /** app包名 */
+    appBundleId: string
+    /** app scheme */
+    appScheme: string
   }
 
   export type SystemWirelessInfoBean = {
@@ -1021,15 +1072,16 @@ declare namespace ty {
 
   export type SettingPageBean = {
     /**
-     * 设置项名称
-     * “Settings” -> 手机设置主界面
-     * “Settings-Bluetooth” -> 手机蓝牙设置界面
-     * “Settings-Notification” -> 手机通知设置界面
-     * “Settings-WiFi” -> 手机设置WiFi界面
-     * “App-Settings” -> App设置界面
-     * “App-Settings-Permission” -> App权限设置界面
-     * “App-Settings-Permission” -> App权限设置界面
-     * “App-Settings-Notification” -> App通知设置界面
+     * 跳转系统-设置项名称
+     * "Settings"-> 手机设置主界面
+     * "Settings-Bluetooth" -> 手机蓝牙设置界面
+     * "Settings-WiFi" -> 手机WiFi设置界面
+     * "Settings-Location" -> 手机定位设置界面
+     * "Settings-Notification" -> 手机通知设置界面
+     * 跳转系统-应用-设置项名称
+     * "App-Settings" -> App应用设置界面
+     * "App-Settings-Permission" -> App应用权限设置界面 (Android 独有)
+     * "App-Settings-Notification" -> App应用通知设置界面 (Android 独有)
      */
     scope: string
     /** 请求code,Android特有 */
@@ -1132,6 +1184,17 @@ declare namespace ty {
     shareChannelList: string[]
   }
 
+  export type UserInfoResult = {
+    /** nickName 用户昵称 */
+    nickName: string
+    /** 用户头像 */
+    avatarUrl: string
+    /** 国家代码 */
+    phoneCode: string
+    /** 是否是临时用户 */
+    isTemporaryUser: boolean
+  }
+
   export type ImageResizeBean = {
     /**
      * 压缩参数