@ray-js/api 1.5.0-beta.11 → 1.5.0

package/@types/BaseKit.d.ts

@@ -1,94 +1,7 @@
-declare enum WidgetVersionType {
-  /** 线上版本 */
-  release = 'release',
-
-  /** 预发版本 */
-  preview = 'preview',
-}
-
-declare enum WidgetPosition {
-  /** 居底展示 */
-  bottom = 'bottom',
-
-  /** 居顶展示 */
-  top = 'top',
-}
-
-declare enum HTTPMethod {
-  /** 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',
-}
-
-declare enum AccelerometerInterval {
-  /** 适用于更新游戏的回调频率，在 20ms/次 左右 */
-  game = 'game',
-
-  /** 适用于更新 UI 的回调频率，在 60ms/次 左右 */
-  ui = 'ui',
-
-  /** 普通的回调频率，在 200ms/次 左右 */
-  normal = 'normal',
-}
-
-declare enum DeviceMotionInterval {
-  /** 适用于更新游戏的回调频率，在 20ms/次 左右 */
-  game = 'game',
-
-  /** 适用于更新 UI 的回调频率，在 60ms/次 左右 */
-  ui = 'ui',
-
-  /** 普通的回调频率，在 200ms/次 左右 */
-  normal = 'normal',
-}
-
-declare enum GyroscopeInterval {
-  /** 适用于更新游戏的回调频率，在 20ms/次 左右 */
-  game = 'game',
-
-  /** 适用于更新 UI 的回调频率，在 60ms/次 左右 */
-  ui = 'ui',
-
-  /** 普通的回调频率，在 200ms/次 左右 */
-  normal = 'normal',
-}
-
-declare enum Themes {
-  dark = 'dark',
-
-  light = 'light',
-}
-
-declare enum Orientation {
-  portrait = 'portrait',
-
-  landscape = 'landscape',
-}
-
 /**
  * BaseKit
  *
- * @version 3.3.13
+ * @version 3.11.0
  */
 declare namespace ty {
   /**
@@ -97,7 +10,7 @@ declare namespace ty {
   export function stopAccelerometer(params?: {
     complete?: () => void
     success?: (params: null) => void
-    failure?: (params: {
+    fail?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {
@@ -112,10 +25,10 @@ declare namespace ty {
    */
   export function startAccelerometer(params?: {
     /** 监听加速度数据回调函数的执行频率 */
-    interval?: keyof typeof AccelerometerInterval
+    interval?: AccelerometerInterval
     complete?: () => void
     success?: (params: null) => void
-    failure?: (params: {
+    fail?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {
@@ -238,7 +151,7 @@ declare namespace ty {
   export function startCompass(params?: {
     complete?: () => void
     success?: (params: null) => void
-    failure?: (params: {
+    fail?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {
@@ -254,7 +167,7 @@ declare namespace ty {
   export function stopCompass(params?: {
     complete?: () => void
     success?: (params: null) => void
-    failure?: (params: {
+    fail?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {
@@ -269,10 +182,10 @@ declare namespace ty {
    */
   export function startDeviceMotionListening(params?: {
     /** 监听加速度数据回调函数的执行频率 */
-    interval?: keyof typeof DeviceMotionInterval
+    interval?: DeviceMotionInterval
     complete?: () => void
     success?: (params: null) => void
-    failure?: (params: {
+    fail?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {
@@ -288,7 +201,7 @@ declare namespace ty {
   export function stopDeviceMotionListening(params?: {
     complete?: () => void
     success?: (params: null) => void
-    failure?: (params: {
+    fail?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {
@@ -317,15 +230,37 @@ declare namespace ty {
     }) => void
   }): void
 
+  /**
+   * 写日志文件,需要APP配套使用检测设备网络功能进行日志上传查看。
+   */
+  export function writeLogFile(params: {
+    /** 标识信息，传入devId或groupId */
+    resId: string
+    /** 要写入的文本数据, 使用utf8编码 */
+    data: string
+    /** 内容添加形式，true为追加在文件尾部，false为覆写文件 */
+    append?: boolean
+    complete?: () => void
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
   /**
    * 开始监听陀螺仪数据。
    */
   export function startGyroscope(params?: {
     /** 监听陀螺仪数据回调函数的执行频率 */
-    interval?: keyof typeof GyroscopeInterval
+    interval?: GyroscopeInterval
     complete?: () => void
     success?: (params: null) => void
-    failure?: (params: {
+    fail?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {
@@ -341,7 +276,7 @@ declare namespace ty {
   export function stopGyroscope(params?: {
     complete?: () => void
     success?: (params: null) => void
-    failure?: (params: {
+    fail?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {
@@ -578,6 +513,24 @@ declare namespace ty {
     }) => void
   }): void
 
+  /**
+   * 保存图片到系统相册
+   */
+  export function saveImageToPhotosAlbum(params: {
+    /** 图片文件路径，可以是临时文件路径也可以是永久文件路径 (本地路径) */
+    filePath: string
+    complete?: () => void
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
   /**
    * 显示消息提示框
    */
@@ -669,6 +622,8 @@ declare namespace ty {
     itemList: string[]
     /** 按钮的文字颜色 */
     itemColor?: string
+    /** 按钮的文字颜色 */
+    itemColors?: string[]
     complete?: () => void
     success?: (params: {
       /** 用户点击的按钮序号，从上到下的顺序，从0开始 */
@@ -999,10 +954,18 @@ declare namespace ty {
       bluetoothEnabled: boolean
       locationEnabled: boolean
       wifiEnabled: boolean
-      theme?: keyof typeof Themes
-      deviceOrientation?: keyof typeof Orientation
+      theme?: Themes
+      deviceOrientation?: Orientation
       /** 设备等级(低:low-中:middle-高:high) */
       deviceLevel: string
+      /** 手机系统是否支持创建快捷方式（仅Android使用） */
+      isSupportPinShortcut?: boolean
+      /**
+       * 设备类型
+       * phone：手机
+       * pad：平板
+       */
+      deviceType?: string
     }) => void
     fail?: (params: {
       errorMsg: string
@@ -1047,10 +1010,18 @@ declare namespace ty {
     bluetoothEnabled: boolean
     locationEnabled: boolean
     wifiEnabled: boolean
-    theme?: keyof typeof Themes
-    deviceOrientation?: keyof typeof Orientation
+    theme?: Themes
+    deviceOrientation?: Orientation
     /** 设备等级(低:low-中:middle-高:high) */
     deviceLevel: string
+    /** 手机系统是否支持创建快捷方式（仅Android使用） */
+    isSupportPinShortcut?: boolean
+    /**
+     * 设备类型
+     * phone：手机
+     * pad：平板
+     */
+    deviceType?: string
   }
 
   /**
@@ -1368,6 +1339,36 @@ declare namespace ty {
    */
   export function clearStorageSync(): null
 
+  /**
+   * onKeyboardHeightChange 发送键盘事件给js
+   */
+  export function onKeyboardHeightChange(listener: (params: BeanRes) => void): void
+
+  /**
+   * 取消监听：onKeyboardHeightChange 发送键盘事件给js
+   */
+  export function offKeyboardHeightChange(listener: (params: BeanRes) => void): void
+
+  /**
+   * 键盘弹出
+   */
+  export function onKeyboardWillShow(listener: (params: BeanRes) => void): void
+
+  /**
+   * 取消监听：键盘弹出
+   */
+  export function offKeyboardWillShow(listener: (params: BeanRes) => void): void
+
+  /**
+   * 键盘消息
+   */
+  export function onKeyboardWillHide(listener: (params: BeanRes) => void): void
+
+  /**
+   * 取消监听：键盘消息
+   */
+  export function offKeyboardWillHide(listener: (params: BeanRes) => void): void
+
   /**
    * 系统音量监听通知事件
    *
@@ -1593,6 +1594,25 @@ declare namespace ty {
     }) => void
   ): void
 
+  export enum WidgetVersionType {
+    /** 线上版本 */
+    release = 'release',
+
+    /** 预发版本 */
+    preview = 'preview',
+  }
+
+  export enum WidgetPosition {
+    /** 居底展示 */
+    bottom = 'bottom',
+
+    /** 居顶展示 */
+    top = 'top',
+
+    /** 居中展示 */
+    center = 'center',
+  }
+
   export type Profile = {
     /** 第一个 HTTP 重定向发生时的时间。有跳转且是同域名内的重定向才算，否则值为 0 */
     redirectStart: number
@@ -1731,6 +1751,65 @@ declare namespace ty {
     encoding?: string
   }
 
+  export enum HTTPMethod {
+    /** 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 enum AccelerometerInterval {
+    /** 适用于更新游戏的回调频率，在 20ms/次 左右 */
+    game = 'game',
+
+    /** 适用于更新 UI 的回调频率，在 60ms/次 左右 */
+    ui = 'ui',
+
+    /** 普通的回调频率，在 200ms/次 左右 */
+    normal = 'normal',
+  }
+
+  export enum DeviceMotionInterval {
+    /** 适用于更新游戏的回调频率，在 20ms/次 左右 */
+    game = 'game',
+
+    /** 适用于更新 UI 的回调频率，在 60ms/次 左右 */
+    ui = 'ui',
+
+    /** 普通的回调频率，在 200ms/次 左右 */
+    normal = 'normal',
+  }
+
+  export enum GyroscopeInterval {
+    /** 适用于更新游戏的回调频率，在 20ms/次 左右 */
+    game = 'game',
+
+    /** 适用于更新 UI 的回调频率，在 60ms/次 左右 */
+    ui = 'ui',
+
+    /** 普通的回调频率，在 200ms/次 左右 */
+    normal = 'normal',
+  }
+
   export type TempFileCB = {
     /** 本地临时文件路径 (本地路径) */
     path: string
@@ -1768,6 +1847,18 @@ declare namespace ty {
     height: number
   }
 
+  export enum Themes {
+    dark = 'dark',
+
+    light = 'light',
+  }
+
+  export enum Orientation {
+    portrait = 'portrait',
+
+    landscape = 'landscape',
+  }
+
   export type StorageDataBean = {
     /** 本地缓存中指定的 key */
     key: string
@@ -1780,6 +1871,11 @@ declare namespace ty {
     key: string
   }
 
+  export type BeanRes = {
+    /** 键盘高度 */
+    height: number
+  }
+
   export type CurrentVolumeResponse = {
     /** 音量，阈值【0 - 1】 */
     value: number
@@ -1891,11 +1987,11 @@ declare namespace ty {
     /** 小部件样式,默认middle */
     style?: string
     /** 版本类型,默认release */
-    versionType?: keyof typeof WidgetVersionType
+    versionType?: WidgetVersionType
     /** 版本号 */
     version?: string
     /** 展示位置,默认bottom */
-    position?: keyof typeof WidgetPosition
+    position?: WidgetPosition
     /** 点击空白处是否关闭 */
     autoDismiss?: boolean
     /**
@@ -1914,7 +2010,7 @@ declare namespace ty {
 
   export type DeviceMotionBean = {
     /** 监听加速度数据回调函数的执行频率 */
-    interval?: keyof typeof DeviceMotionInterval
+    interval?: DeviceMotionInterval
   }
 
   export type DownLoadBean = {
@@ -1978,9 +2074,18 @@ declare namespace ty {
     filePath: string
   }
 
+  export type LogFileParams = {
+    /** 标识信息，传入devId或groupId */
+    resId: string
+    /** 要写入的文本数据, 使用utf8编码 */
+    data: string
+    /** 内容添加形式，true为追加在文件尾部，false为覆写文件 */
+    append?: boolean
+  }
+
   export type GyroscopeBean = {
     /** 监听陀螺仪数据回调函数的执行频率 */
-    interval?: keyof typeof GyroscopeInterval
+    interval?: GyroscopeInterval
   }
 
   export type ChooseImageBean = {
@@ -2124,6 +2229,11 @@ declare namespace ty {
     filePath: string
   }
 
+  export type SaveImageParams = {
+    /** 图片文件路径，可以是临时文件路径也可以是永久文件路径 (本地路径) */
+    filePath: string
+  }
+
   export type ToastBean = {
     /** 提示的内容 */
     title: string
@@ -2175,6 +2285,8 @@ declare namespace ty {
     itemList: string[]
     /** 按钮的文字颜色 */
     itemColor?: string
+    /** 按钮的文字颜色 */
+    itemColors?: string[]
   }
 
   export type ActionSheetCallback = {
@@ -2194,7 +2306,7 @@ declare namespace ty {
     /** 超时时间，单位为毫秒 */
     timeout?: number
     /** HTTP 请求方法 */
-    method?: keyof typeof HTTPMethod
+    method?: HTTPMethod
     /** 返回的数据格式 */
     dataType?: any
     /** 返回的数据类型 */
@@ -2348,10 +2460,18 @@ declare namespace ty {
     bluetoothEnabled: boolean
     locationEnabled: boolean
     wifiEnabled: boolean
-    theme?: keyof typeof Themes
-    deviceOrientation?: keyof typeof Orientation
+    theme?: Themes
+    deviceOrientation?: Orientation
     /** 设备等级(低:low-中:middle-高:high) */
     deviceLevel: string
+    /** 手机系统是否支持创建快捷方式（仅Android使用） */
+    isSupportPinShortcut?: boolean
+    /**
+     * 设备类型
+     * phone：手机
+     * pad：平板
+     */
+    deviceType?: string
   }
 
   export type GetConnectedWifiParams = {
@@ -2668,11 +2788,11 @@ declare namespace ty {
     /** 小部件样式,默认middle */
     style?: string
     /** 版本类型,默认release */
-    versionType?: keyof typeof WidgetVersionType
+    versionType?: WidgetVersionType
     /** 版本号 */
     version?: string
     /** 展示位置,默认bottom */
-    position?: keyof typeof WidgetPosition
+    position?: WidgetPosition
     /** 点击空白处是否关闭 */
     autoDismiss?: boolean
     /**
@@ -2704,7 +2824,7 @@ declare namespace ty {
     abort(params: {
       complete?: () => void
       success?: (params: null) => void
-      failure?: (params: {
+      fail?: (params: {
         errorMsg: string
         errorCode: string | number
         innerError: {
@@ -2790,7 +2910,7 @@ declare namespace ty {
       /** 网络请求过程中一些调试信息 */
       profile: Profile
     }) => void
-    failure?: (params: {
+    fail?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {
@@ -3051,7 +3171,7 @@ declare namespace ty {
     abort(params: {
       complete?: () => void
       success?: (params: null) => void
-      failure?: (params: {
+      fail?: (params: {
         errorMsg: string
         errorCode: string | number
         innerError: {
@@ -3095,7 +3215,7 @@ declare namespace ty {
     /** 超时时间，单位为毫秒 */
     timeout?: number
     /** HTTP 请求方法 */
-    method?: keyof typeof HTTPMethod
+    method?: HTTPMethod
     /** 返回的数据格式 */
     dataType?: any
     /** 返回的数据类型 */
@@ -3121,7 +3241,7 @@ declare namespace ty {
       /** 网络请求id，用户取消、监听等操作 */
       taskId: string
     }) => void
-    failure?: (params: {
+    fail?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {
@@ -3158,7 +3278,7 @@ declare namespace ty {
         /** 录音文件的临时路径 (本地路径) */
         tempFilePath: string
       }) => void
-      failure?: (params: {
+      fail?: (params: {
         errorMsg: string
         errorCode: string | number
         innerError: {
@@ -3177,7 +3297,7 @@ declare namespace ty {
         /** 录音文件的临时路径 (本地路径) */
         tempFilePath: string
       }) => void
-      failure?: (params: {
+      fail?: (params: {
         errorMsg: string
         errorCode: string | number
         innerError: {
@@ -3196,7 +3316,7 @@ declare namespace ty {
         /** 录音文件的临时路径 (本地路径) */
         tempFilePath: string
       }) => void
-      failure?: (params: {
+      fail?: (params: {
         errorMsg: string
         errorCode: string | number
         innerError: {
@@ -3215,7 +3335,7 @@ declare namespace ty {
         /** 录音文件的临时路径 (本地路径) */
         tempFilePath: string
       }) => void
-      failure?: (params: {
+      fail?: (params: {
         errorMsg: string
         errorCode: string | number
         innerError: {
@@ -3233,7 +3353,7 @@ declare namespace ty {
       period: number
       complete?: () => void
       success?: (params: null) => void
-      failure?: (params: {
+      fail?: (params: {
         errorMsg: string
         errorCode: string | number
         innerError: {
@@ -3249,7 +3369,7 @@ declare namespace ty {
     stopRecording(params: {
       complete?: () => void
       success?: (params: null) => void
-      failure?: (params: {
+      fail?: (params: {
         errorMsg: string
         errorCode: string | number
         innerError: {
@@ -3262,7 +3382,7 @@ declare namespace ty {
   export function getRecorderManager(params?: {
     complete?: () => void
     success?: (params: null) => void
-    failure?: (params: {
+    fail?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {
@@ -3282,7 +3402,7 @@ declare namespace ty {
     abort(params: {
       complete?: () => void
       success?: (params: null) => void
-      failure?: (params: {
+      fail?: (params: {
         errorMsg: string
         errorCode: string | number
         innerError: {
@@ -3368,7 +3488,7 @@ declare namespace ty {
       /** 开发者服务器返回的 HTTP 状态码 */
       statusCode: number
     }) => void
-    failure?: (params: {
+    fail?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {

package/@types/BizKit.d.ts

@@ -892,7 +892,7 @@ declare namespace ty {
       /** 是否是临时用户 */
       isTemporaryUser: boolean
     }) => void
-    failure?: (params: {
+    fail?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {