@dcloudio/uni-app-x 0.5.0 → 0.5.2

package/types/uni/{ext → uts-plugin-api}/lib/uni-storage/utssdk/interface.d.ts

@@ -22,7 +22,7 @@ export type SetStorageCompleteCallback = (res: any) => void
  */
 export type SetStorageOptions = {
   /**
-   * 本地缓存中的指定的 key
+   * 本地存储中的指定的 key
    */
   key: string,
   /**
@@ -75,7 +75,7 @@ export type GetStorageCompleteCallback = (res: any) => void
  */
 export type GetStorageOptions = {
   /**
-   * 本地缓存中的指定的 key
+   * 本地存储中的指定的 key
    */
   key: string,
   /**
@@ -136,15 +136,15 @@ export type GetStorageInfoOptions = {
   /**
    * 接口调用成功的回调函数
    */
-  success: GetStorageInfoSuccessCallback | null,
+  success?: GetStorageInfoSuccessCallback | null,
   /**
    * 接口调用失败的回调函数
    */
-  fail: GetStorageInfoFailCallback | null,
+  fail?: GetStorageInfoFailCallback | null,
   /**
    * 接口调用结束的回调函数（调用成功、失败都会执行）
    */
-  complete: GetStorageInfoCompleteCallback | null
+  complete?: GetStorageInfoCompleteCallback | null
 }
 
 
@@ -175,7 +175,7 @@ export type RemoveStorageCompleteCallback = (res: any) => void
  */
 export type RemoveStorageOptions = {
   /**
-   * 本地缓存中的指定的 key
+   * 本地存储中的指定的 key
    */
   key: string,
   /**
@@ -244,7 +244,7 @@ export type ClearStorageSync = () => void
 export interface Uni {
   /**
    * uni.setStorage函数定义
-   * 将数据存储在本地缓存中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个异步接口。  
+   * 将数据存储在本地storage存储中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个异步接口。  
    * 
    * @param {SetStorageOptions} options 
    * @tutorial https://uniapp.dcloud.net.cn/api/storage/storage.html#setstorage
@@ -265,12 +265,12 @@ export interface Uni {
    * @uniVersion 2.0.3
    * @uniVueVersion 2,3  //支持的vue版本
    */
-  setStorage: SetStorage,
+  setStorage(options: SetStorageOptions) :  void,
   /**
    * uni.setStorageSync函数定义
-   * 将 data 存储在本地缓存中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个同步接口。
+   * 将 data 存储在本地storage存储中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个同步接口。
    * 
-   * @param {string} key  本地缓存中的指定的 key
+   * @param {string} key  本地storage存储中的指定的 key
    * @param {any} data  需要存储的内容，只支持原生类型、及能够通过 JSON.stringify 序列化的对象
    * @tutorial https://uniapp.dcloud.net.cn/api/storage/storage.html#setstoragesync
    * @uniPlatform {
@@ -290,10 +290,10 @@ export interface Uni {
    * @uniVersion 2.0.3
    * @uniVueVersion 2,3  //支持的vue版本
    */
-  setStorageSync: SetStorageSync,
+  setStorageSync(key: string, data: any) : void,
   /**
    * uni.getStorage函数定义
-   * 从本地缓存中异步获取指定 key 对应的内容。
+   * 从本地存储中异步获取指定 key 对应的内容。
    * 
    * @param {GetStorageOptions} options 
    * @tutorial https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorage
@@ -314,12 +314,12 @@ export interface Uni {
    * @uniVersion 2.0.3
    * @uniVueVersion 2,3  //支持的vue版本
    */
-  getStorage: GetStorage,
+  getStorage(options: GetStorageOptions) : void,
   /**
    * uni.getStorageSync函数定义
-   * 从本地缓存中同步获取指定 key 对应的内容。
+   * 从本地存储中同步获取指定 key 对应的内容。
    * 
-   * @param {string} key  本地缓存中的指定的 key
+   * @param {string} key  本地存储中的指定的 key
    * @tutorial https://uniapp.dcloud.net.cn/api/storage/storage.html#getstoragesync
    * @uniPlatform {
    *    "app": {
@@ -338,7 +338,7 @@ export interface Uni {
    * @uniVersion 2.0.3
    * @uniVueVersion 2,3  //支持的vue版本
    */
-  getStorageSync: GetStorageSync,
+  getStorageSync(key: string) : any | null,
   /**
    * uni.getStorageInfo函数定义
    * 异步获取当前 storage 的相关信息。
@@ -362,7 +362,7 @@ export interface Uni {
    * @uniVersion 2.0.3
    * @uniVueVersion 2,3  //支持的vue版本
    */
-  getStorageInfo: GetStorageInfo,
+  getStorageInfo(options: GetStorageInfoOptions) : void,
   /**
    * uni.getStorageInfoSync函数定义
    * 同步获取当前 storage 的相关信息。
@@ -387,10 +387,10 @@ export interface Uni {
    * @uniVersion 2.0.3
    * @uniVueVersion 2,3  //支持的vue版本
    */
-  getStorageInfoSync: GetStorageInfoSync,
+  getStorageInfoSync() : GetStorageInfoSuccess,
   /**
    * uni.removeStorage函数定义
-   * 从本地缓存中异步移除指定 key。
+   * 从本地存储中异步移除指定 key。
    * 
    * @param {RemoveStorageOptions} options 
    * 
@@ -413,12 +413,12 @@ export interface Uni {
    * @uniVersion 2.0.3
    * @uniVueVersion 2,3  //支持的vue版本
    */
-  removeStorage: RemoveStorage,
+  removeStorage(options: RemoveStorageOptions) : void,
   /**
    * uni.removeStorageSync函数定义
-   * 从本地缓存中同步移除指定 key。
+   * 从本地存储中同步移除指定 key。
    * 
-   * @param {string} key  本地缓存中的指定的 key
+   * @param {string} key  本地存储中的指定的 key
    * 
    * @tutorial https://uniapp.dcloud.net.cn/api/storage/storage.html#removestoragesync
    * 
@@ -439,10 +439,10 @@ export interface Uni {
    * @uniVersion 2.0.3
    * @uniVueVersion 2,3  //支持的vue版本
    */
-  removeStorageSync: RemoveStorageSync,
+  removeStorageSync(key: string) : void,
   /**
    * uni.clearStorage函数定义
-   * 清理本地数据缓存。
+   * 清除本地数据存储。
    * 
    * @tutorial https://uniapp.dcloud.net.cn/api/storage/storage.html#clearstorage
    * 
@@ -463,10 +463,10 @@ export interface Uni {
    * @uniVersion 2.0.3
    * @uniVueVersion 2,3  //支持的vue版本
    */
-  clearStorage: ClearStorage,
+  clearStorage(option?: ClearStorageOptions | null) : void,
   /**
    * uni.clearStorageSync函数定义
-   * 清理本地数据缓存。
+   * 清除本地数据存储。
    * 
    * @tutorial https://uniapp.dcloud.net.cn/api/storage/storage.html#clearstoragesync
    * 
@@ -487,5 +487,5 @@ export interface Uni {
    * @uniVersion 2.0.3
    * @uniVueVersion 2,3  //支持的vue版本
    */
-  clearStorageSync: ClearStorageSync
+  clearStorageSync() :  void
 }

package/types/uni/{ext → uts-plugin-api}/lib/uni-websocket/utssdk/index.d.ts

@@ -1,6 +1,7 @@
 import {
   ConnectSocket as ConnectSocketOrigin,
   ConnectSocketSuccess as ConnectSocketSuccessOrigin,
+  ConnectSocketErrorCode as ConnectSocketErrorCodeOrigin,
   ConnectSocketFail as ConnectSocketFailOrigin,
   ConnectSocketOptions as ConnectSocketOptionsOrigin,
   GeneralCallbackResult as GeneralCallbackResultOrigin,
@@ -27,6 +28,7 @@ import {
 declare global {
   type ConnectSocket = ConnectSocketOrigin
   type ConnectSocketSuccess = ConnectSocketSuccessOrigin
+  type ConnectSocketErrorCode = ConnectSocketErrorCodeOrigin
   type ConnectSocketFail = ConnectSocketFailOrigin
   type ConnectSocketOptions = ConnectSocketOptionsOrigin
   type GeneralCallbackResult = GeneralCallbackResultOrigin

package/types/uni/{ext → uts-plugin-api}/lib/uni-websocket/utssdk/interface.d.ts

@@ -16,7 +16,7 @@ export interface Uni {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -30,7 +30,7 @@ export interface Uni {
           });
      ```
     */
-  connectSocket: ConnectSocket;
+  connectSocket(options: ConnectSocketOptions): SocketTask;
   /**
     * OnSocketOpen()
     * @description 
@@ -48,7 +48,7 @@ export interface Uni {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -59,7 +59,7 @@ export interface Uni {
       });
      ```
     */
-  onSocketOpen: OnSocketOpen;
+  onSocketOpen(options: OnSocketOpenCallback): void;
 
   /**
     * OnSocketError()
@@ -78,7 +78,7 @@ export interface Uni {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -89,7 +89,7 @@ export interface Uni {
       });
      ```
     */
-  onSocketError: OnSocketError;
+  onSocketError(callback: OnSocketErrorCallback): void;
 
   /**
     * SendSocketMessage()
@@ -108,7 +108,7 @@ export interface Uni {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -119,7 +119,7 @@ export interface Uni {
       });
      ```
     */
-  sendSocketMessage: SendSocketMessage;
+  sendSocketMessage(options: SendSocketMessageOptions): void;
   /**
     * OnSocketMessage()
     * @description 
@@ -137,7 +137,7 @@ export interface Uni {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -148,7 +148,7 @@ export interface Uni {
       });
      ```
     */
-  onSocketMessage: OnSocketMessage;
+  onSocketMessage(callback: OnSocketMessageCallback): void;
   /**
     * CloseSocket()
     * @description 
@@ -166,7 +166,7 @@ export interface Uni {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -175,7 +175,7 @@ export interface Uni {
       uni.closeSocket();
      ```
     */
-  closeSocket: CloseSocket;
+  closeSocket(options: CloseSocketOptions): void;
   /**
     * OnSocketClose()
     * @description 
@@ -193,7 +193,7 @@ export interface Uni {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -204,15 +204,27 @@ export interface Uni {
       });
      ```
     */
-  onSocketClose: OnSocketClose;
+  onSocketClose(callback: OnSocketCloseCallback): void;
 }
 
 export type ConnectSocket = (options: ConnectSocketOptions) => SocketTask;
 export type ConnectSocketSuccess = {
   errMsg: string
 };
-type ConnectSocketSuccessCallback = (result: ConnectSocketSuccess) => void;
-export type ConnectSocketFail = UniError;
+type ConnectSocketSuccessCallback = (result: ConnectSocketSuccess) => void;
+/**
+ * 错误码
+ * - 600009 URL格式不合法
+ */
+export type ConnectSocketErrorCode = 600009;
+
+/**
+ * 连接调用失败的错误回调参数
+ */
+export interface ConnectSocketFail extends IUniError { 
+	errCode: ConnectSocketErrorCode;
+};
+
 type ConnectSocketFailCallback = (result: ConnectSocketFail) => void;
 type ConnectSocketComplete = any;
 type ConnectSocketCompleteCallback = (result: ConnectSocketComplete) => void;
@@ -222,23 +234,28 @@ export type ConnectSocketOptions = {
    */
   url: string,
   /**
-   * HTTP 请求 Header，header 中不能设置 Referer
+   * HTTP 请求 Header，header 中不能设置 Referer
+   * @defaultValue null
    */
   header: UTSJSONObject | null,
   /**
-   * 子协议数组
+   * 子协议数组
+   * @defaultValue null
    */
   protocols: (string[]) | null,
   /**
-   * 接口调用成功的回调函数
+   * 接口调用成功的回调函数
+   * @defaultValue null
    */
   success?: ConnectSocketSuccessCallback | null,
   /**
-   * 接口调用失败的回调函数
+   * 接口调用失败的回调函数
+   * @defaultValue null
    */
   fail?: ConnectSocketFailCallback | null,
   /**
-   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   * @defaultValue null
    */
   complete?: ConnectSocketCompleteCallback | null
 };
@@ -256,37 +273,45 @@ export type SendSocketMessageOptions = {
    */
   data: any,
   /**
-   * 接口调用成功的回调函数
+   * 接口调用成功的回调函数
+   * @defaultValue null
    */
   success?: ((result: GeneralCallbackResult) => void) | null,
   /**
-   * 接口调用失败的回调函数
+   * 接口调用失败的回调函数
+   * @defaultValue null
    */
   fail?: ((result: GeneralCallbackResult) => void) | null,
   /**
-   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   * @defaultValue null
    */
   complete?: ((result: GeneralCallbackResult) => void) | null
 };
 export type CloseSocketOptions = {
   /**
-   * 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被指定，默认的取值是1000 （表示正常连接关闭）
+   * 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被指定，默认的取值是1000 （表示正常连接关闭）
+   * @defaultValue 1000
    */
   code?: number | null,
   /**
-   * 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本（不是字符）
+   * 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本（不是字符）
+   * @defaultValue ""
    */
   reason?: string | null,
   /**
-   * 接口调用成功的回调函数
+   * 接口调用成功的回调函数
+   * @defaultValue null
    */
   success?: ((result: GeneralCallbackResult) => void) | null,
   /**
-   * 接口调用失败的回调函数
+   * 接口调用失败的回调函数
+   * @defaultValue null
    */
   fail?: ((result: GeneralCallbackResult) => void) | null,
   /**
-   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   * @defaultValue null
    */
   complete?: ((result: GeneralCallbackResult) => void) | null
 };
@@ -321,7 +346,7 @@ export interface SocketTask {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -348,7 +373,7 @@ export interface SocketTask {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -375,7 +400,7 @@ export interface SocketTask {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -402,7 +427,7 @@ export interface SocketTask {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -430,7 +455,7 @@ export interface SocketTask {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -458,7 +483,7 @@ export interface SocketTask {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }

package/types/uni/uts-plugin-component/index.d.ts

@@ -0,0 +1 @@
+/// <reference path='./lib/uni-video/utssdk/index.d.ts' />

package/types/uni/uts-plugin-component/lib/uni-video/utssdk/index.d.ts

@@ -0,0 +1,15 @@
+import {
+  CreateVideoContext as CreateVideoContextOrigin,
+  Danmu as DanmuOrigin,
+  RequestFullScreenOptions as RequestFullScreenOptionsOrigin,
+  VideoContext as VideoContextOrigin,
+  Uni as UniOrigin
+} from './interface'
+
+declare global {
+  type CreateVideoContext = CreateVideoContextOrigin
+  type Danmu = DanmuOrigin
+  type RequestFullScreenOptions = RequestFullScreenOptionsOrigin
+  type VideoContext = VideoContextOrigin
+  interface Uni extends UniOrigin { }
+}

package/types/uni/uts-plugin-component/lib/uni-video/utssdk/interface.d.ts

@@ -0,0 +1,171 @@
+import { ComponentPublicInstance } from 'vue'
+
+export type CreateVideoContext = (videoId: VideoIdString, component?: ComponentPublicInstance | null) => VideoContext | null;
+
+export type Danmu = {
+  /**
+   * 弹幕文字
+   */
+  text: string | null,
+  /**
+   * 弹幕颜色
+   */
+  color: string | null,
+  /**
+   * 显示时刻
+   */
+  time: number | null
+};
+
+export type RequestFullScreenOptions = {
+  /**
+   * direction
+   * - 0: 正常竖向
+   * - 90: 屏幕逆时针90度
+   * - -90: 屏幕顺时针90度
+   * @type 0 | 90 | -90
+   */
+  direction: number | null
+};
+
+export interface VideoContext {
+  /**
+   * @description 播放
+   * @uniPlatform {
+   *   "app": {
+   *     "android": {
+   *       "osVer": "4.4",
+   *       "uniVer": "√",
+   *       "unixVer": "3.9.0"
+   *     }
+   *   }
+   * }
+   * @uniVueVersion 2,3
+   */
+  play(): void;
+  /**
+   * @description 暂停
+   * @uniPlatform {
+   *   "app": {
+   *     "android": {
+   *       "osVer": "4.4",
+   *       "uniVer": "√",
+   *       "unixVer": "3.9.0"
+   *     }
+   *   }
+   * }
+   * @uniVueVersion 2,3
+   */
+  pause(): void;
+  /**
+   * @description 跳转到指定位置
+   * @param {number} position 跳转到指定位置(秒)
+   * @uniPlatform {
+   *   "app": {
+   *     "android": {
+   *       "osVer": "4.4",
+   *       "uniVer": "√",
+   *       "unixVer": "3.9.0"
+   *     }
+   *   }
+   * }
+   * @uniVueVersion 2,3
+   */
+  seek(position: number): void;
+  /**
+   * @description 停止视频
+   * @uniPlatform {
+   *   "app": {
+   *     "android": {
+   *       "osVer": "4.4",
+   *       "uniVer": "√",
+   *       "unixVer": "3.9.0"
+   *     }
+   *   }
+   * }
+   * @uniVueVersion 2,3
+   */
+  stop(): void;
+  /**
+   * @description 发送弹幕
+   * @param {Danmu} 属性 text, color
+   * @uniPlatform {
+   *   "app": {
+   *     "android": {
+   *       "osVer": "4.4",
+   *       "uniVer": "√",
+   *       "unixVer": "3.9.0"
+   *     }
+   *   }
+   * }
+   * @uniVueVersion 2,3
+   */
+  sendDanmu(danmu: Danmu): void;
+  /**
+   * @description 设置倍速播放
+   * @param {number} rate, 支持倍率 0.5/0.8/1.0/1.25/1.5
+   * @uniPlatform {
+   *   "app": {
+   *     "android": {
+   *       "osVer": "4.4",
+   *       "uniVer": "√",
+   *       "unixVer": "3.9.0"
+   *     }
+   *   }
+   * }
+   * @uniVueVersion 2,3
+   */
+  playbackRate(rate: number): void;
+  /**
+   * @description 进入全屏
+   * @param {RequestFullScreenOptions} direction, 0|正常竖向, 90|屏幕逆时针90度, -90|屏幕顺时针90度
+   * @uniPlatform {
+   *   "app": {
+   *     "android": {
+   *       "osVer": "4.4",
+   *       "uniVer": "√",
+   *       "unixVer": "3.9.0"
+   *     }
+   *   }
+   * }
+   * @uniVueVersion 2,3
+   */
+  requestFullScreen(direction: RequestFullScreenOptions | null): void;
+  /**
+   * 退出全屏
+   * @description 退出全屏
+   * @uniPlatform {
+   *   "app": {
+   *     "android": {
+   *       "osVer": "4.4",
+   *       "uniVer": "√",
+   *       "unixVer": "3.9.0"
+   *     }
+   *   }
+   * }
+   * @uniVueVersion 2,3
+   */
+  exitFullScreen(): void;
+}
+
+export interface Uni {
+  /**
+   * 创建并返回 video 上下文 videoContext 对象
+   * @description 创建并返回 video 上下文 videoContext 对象
+   * @uniPlatform {
+   *   "app": {
+   *     "android": {
+   *       "osVer": "4.4",
+   *       "uniVer": "√",
+   *       "unixVer": "√"
+   *     }
+   *   }
+   * }
+   * @uniVueVersion 2,3
+   * @return {VideoContext} 视频对象
+   *
+   * @tutorial http://uniapp.dcloud.io/api/media/video-context?id=createVideoContext
+   *
+   */
+  createVideoContext(videoId : string | HBuilderX.VideoIdString, component?: ComponentPublicInstance | null) : VideoContext | null
+}