@dcloudio/uni-app-x 0.5.10 → 0.5.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcloudio/uni-app-x",
-  "version": "0.5.10",
+  "version": "0.5.11",
   "description": "uni-app x types",
   "typings": "index.d.ts",
   "author": "DCloud",
@@ -10,6 +10,7 @@
     "build:types:core": "node ./scripts/build-types.js -t core",
     "build:types:plugin:api": "node ./scripts/build-types.js -t uts-plugin-api",
     "build:types:plugin:component": "node ./scripts/build-types.js -t uts-plugin-component",
+    "build:types:plugin:modules": "node ./scripts/build-types.js -t uts-plugin-modules",
     "build:types:plugin": "npm run build:types:plugin:api  && npm run build:types:plugin:component",
     "build:types:meta": "node ./scripts/build-meta.js",
     "build:types": "npm run build:types:core && npm run build:types:plugin"

package/types/native/Element.d.ts

@@ -68,7 +68,7 @@ declare interface Element {
    * 只读属性 获取当前元素的元素名称
    * @autodoc false
    */
-  nodeName: string
+  nodeName: string | null
 
   /**
    * 只读属性 获取元素上自定义数据属性（data-*）的集合
@@ -157,7 +157,7 @@ declare interface Element {
    *    }
    * }
    */
-  takeSnapshot(options: TakeSnapshotOptions):void
+  takeSnapshot(options: TakeSnapshotOptions): void
 
   /**
    * 将一个元素添加到指定父元素的子元素列表的末尾处。如果将被插入的元素已经存在于当前文档的文档树中，那么将会它从原先的位置移动到新的位置。

package/types/uni/core/lib/base/interceptor/interface.d.ts

@@ -16,12 +16,132 @@ export interface Uni {
    * 添加拦截器
    * @param name 需要拦截的 API 名称
    * @param interceptor 拦截器
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *        "osVer": "5.0",
+   *        "uniVer": "√",
+   *        "unixVer": "3.97"
+   *      },
+   *      "ios": {
+   *          "osVer": "10.0",
+   *          "uniVer": "√",
+   *          "unixVer": "x"
+   *      }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    },
+   *    "alipay": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    },
+   *    "baidu": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    },
+   *    "toutiao": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    },
+   *    "lark": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    },
+   *    "qq": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    },
+   *    "kuaishou": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    },
+   *    "jd": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    }
+   *  },
+   *  "web": {
+   *      "uniVer": "√",
+   *      "unixVer": "x"
+   *  }
+   * }
    */
   addInterceptor(name: string, interceptor: AddInterceptorOptions): void
   /**
    * 删除拦截器
    * @param name 需要删除拦截器的 API 名称
    * @param interceptor 拦截器
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *        "osVer": "5.0",
+   *        "uniVer": "√",
+   *        "unixVer": "3.97"
+   *      },
+   *      "ios": {
+   *          "osVer": "10.0",
+   *          "uniVer": "√",
+   *          "unixVer": "x"
+   *      }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    },
+   *    "alipay": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    },
+   *    "baidu": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    },
+   *    "toutiao": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    },
+   *    "lark": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    },
+   *    "qq": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    },
+   *    "kuaishou": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    },
+   *    "jd": {
+   *        "hostVer": "√",
+   *        "uniVer": "√",
+   *        "unixVer": "x"
+   *    }
+   *  },
+   *  "web": {
+   *      "uniVer": "√",
+   *      "unixVer": "x"
+   *  }
+   * }
    */
   removeInterceptor(
     name: string,

package/types/uni/index.d.ts

@@ -2,3 +2,4 @@
 /// <reference path='./core/index.d.ts' />
 /// <reference path='./uts-plugin-api/index.d.ts' />
 /// <reference path='./uts-plugin-component/index.d.ts' />
+/// <reference path='./uts-plugin-modules/index.d.ts' />

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

@@ -3,6 +3,12 @@ import {
   Danmu as DanmuOrigin,
   RequestFullScreenOptions as RequestFullScreenOptionsOrigin,
   VideoContext as VideoContextOrigin,
+  VideoTimeUpdateEventDetail as VideoTimeUpdateEventDetailOrigin,
+  VideoFullScreenChangeEventDetail as VideoFullScreenChangeEventDetailOrigin,
+  VideoProgressChangeEventDetail as VideoProgressChangeEventDetailOrigin,
+  VideoFullScreenClickEventDetail as VideoFullScreenClickEventDetailOrigin,
+  VideoControlsToggleEventDetail as VideoControlsToggleEventDetailOrigin,
+  VideoErrorCode as VideoErrorCodeOrigin,
   Uni as UniOrigin
 } from './interface'
 
@@ -11,5 +17,11 @@ declare global {
   type Danmu = DanmuOrigin
   type RequestFullScreenOptions = RequestFullScreenOptionsOrigin
   type VideoContext = VideoContextOrigin
+  type VideoTimeUpdateEventDetail = VideoTimeUpdateEventDetailOrigin
+  type VideoFullScreenChangeEventDetail = VideoFullScreenChangeEventDetailOrigin
+  type VideoProgressChangeEventDetail = VideoProgressChangeEventDetailOrigin
+  type VideoFullScreenClickEventDetail = VideoFullScreenClickEventDetailOrigin
+  type VideoControlsToggleEventDetail = VideoControlsToggleEventDetailOrigin
+  type VideoErrorCode = VideoErrorCodeOrigin
   interface Uni extends UniOrigin { }
 }

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

@@ -1,171 +1,311 @@
-import { ComponentPublicInstance } from 'vue'
+import { ComponentPublicInstance } from 'vue';
 
-export type CreateVideoContext = (videoId: VideoIdString, component?: ComponentPublicInstance | null) => VideoContext | null;
+export type CreateVideoContext = (videoId : string, component ?: ComponentPublicInstance | null) => VideoContext | null;
 
 export type Danmu = {
-  /**
-   * 弹幕文字
-   */
-  text: string | null,
-  /**
-   * 弹幕颜色
-   */
-  color: string | null,
-  /**
-   * 显示时刻
-   */
-  time: number | null
+	/**
+	 * 弹幕文字
+	 */
+	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
+	/**
+	 * 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;
+	/**
+	 * @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
+	/**
+	 * 创建并返回 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, component ?: ComponentPublicInstance | null) : VideoContext | null
+}
+
+/**
+ * timeupdate 事件
+ * 播放进度变化时触发
+ */
+export class VideoTimeUpdateEvent extends CustomEvent<VideoTimeUpdateEventDetail> {
+	constructor(detail : VideoTimeUpdateEventDetail) {
+		super("timeupdate", detail);
+	}
+}
+
+/**
+ * @param currentTime 当前进度
+ * @param duration 总进度
+ */
+export type VideoTimeUpdateEventDetail = {
+	currentTime : number,
+	duration : number
+}
+
+/**
+ * fullscreenchange 事件
+ * 当视频进入和退出全屏是触发
+ */
+export class VideoFullScreenChangeEvent extends CustomEvent<VideoFullScreenChangeEventDetail> {
+	constructor(detail : VideoFullScreenChangeEventDetail) {
+		super("fullscreenchange", detail);
+	}
+}
+
+/**
+ * @param fullScreen 是否全屏
+ * @param direction 横竖屏，取值 vertical 或 horizontal
+ */
+export type VideoFullScreenChangeEventDetail = {
+	fullScreen : boolean,
+	direction : string
+}
+
+/**
+ * error 事件
+ * 视频播放出错时触发
+ */
+export class VideoErrorEvent extends CustomEvent<VideoError> {
+	constructor(detail : VideoError) {
+		super("error", detail);
+	}
+}
+
+/**
+ * progress 事件
+ * 加载进度变化时触发
+ */
+export class VideoProgressChangeEvent extends CustomEvent<VideoProgressChangeEventDetail> {
+	constructor(detail : VideoProgressChangeEventDetail) {
+		super("progress", detail);
+	}
+}
+
+/**
+ * @param buffered 加载进度百分比
+ */
+export type VideoProgressChangeEventDetail = {
+	buffered : number
+}
+
+/**
+ * fullscreenclick 事件
+ * 视频播放全屏播放时点击事件
+ */
+export class VideoFullScreenClickEvent extends CustomEvent<VideoFullScreenClickEventDetail> {
+	constructor(detail : VideoFullScreenClickEventDetail) {
+		super("fullscreenclick", detail);
+	}
+}
+
+/**
+ * @param screenX 点击点相对于屏幕左侧边缘的 X 轴坐标
+ * @param screenY 点击点相对于屏幕顶部边缘的 Y 轴坐标
+ * @param screenWidth 屏幕总宽度
+ * @param screenHeight 屏幕总高度
+ */
+export type VideoFullScreenClickEventDetail = {
+	screenX : number,
+	screenY : number,
+	screenWidth : number,
+	screenHeight : number
+}
+
+/**
+ * controlstoggle 事件
+ * 切换播放控件显示隐藏时触发
+ */
+export class VideoControlsToggleEvent extends CustomEvent<VideoControlsToggleEventDetail> {
+	constructor(detail : VideoControlsToggleEventDetail) {
+		super("controlstoggle", detail);
+	}
+}
+
+/**
+ * @param show 是否显示
+ */
+export type VideoControlsToggleEventDetail = {
+	show : boolean
+}
+
+/**
+ * 错误主题
+ */
+export const UniErrorSubject = 'uni-video';
+
+/**
+ * 错误码
+ * 100001 网络错误
+ * 200001 内部错误
+ * 300001 SDK错误
+ */
+export type VideoErrorCode = 100001 | 200001 | 300001
+
+/**
+ * 错误信息
+ */
+export const UniErrors : Map<VideoErrorCode, string> = new Map([
+	[100001, 'video:network error'],
+	[200001, 'video:internal error'],
+	[300001, 'video:sdk error']
+]);
+
+/**
+ * 错误实现
+ */
+export class VideoError extends UniError {
+	constructor(errCode : VideoErrorCode, cause : SourceError | null = null) {
+		super();
+		this.errSubject = UniErrorSubject;
+		this.errCode = errCode;
+		this.errMsg = UniErrors[errCode] ?? "";
+		this.cause = cause;
+	}
 }

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

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

package/types/uni/uts-plugin-modules/lib/uni-facialRecognitionVerify/utssdk/index.d.ts

@@ -0,0 +1,15 @@
+import {
+  StartFacialRecognitionVerifySuccess as StartFacialRecognitionVerifySuccessOrigin,
+  StartFacialRecognitionVerifyOptions as StartFacialRecognitionVerifyOptionsOrigin,
+  GetFacialRecognitionMetaInfo as GetFacialRecognitionMetaInfoOrigin,
+  StartFacialRecognitionVerify as StartFacialRecognitionVerifyOrigin,
+  Uni as UniOrigin
+} from './interface'
+
+declare global {
+  type StartFacialRecognitionVerifySuccess = StartFacialRecognitionVerifySuccessOrigin
+  type StartFacialRecognitionVerifyOptions = StartFacialRecognitionVerifyOptionsOrigin
+  type GetFacialRecognitionMetaInfo = GetFacialRecognitionMetaInfoOrigin
+  type StartFacialRecognitionVerify = StartFacialRecognitionVerifyOrigin
+  interface Uni extends UniOrigin { }
+}

package/types/uni/uts-plugin-modules/lib/uni-facialRecognitionVerify/utssdk/interface.d.ts

@@ -0,0 +1,66 @@
+export type StartFacialRecognitionVerifySuccess = {
+	/**
+	 * 错误码
+	 */
+	errCode: number,
+	/**
+	 * 调用API的名称
+	 */
+	errSubject: string,
+	/**
+	 * 错误的详细信息
+	 */
+	errMsg: string,
+	/**
+	 * 错误来源
+	 */
+	cause?: any
+}
+
+export type StartFacialRecognitionVerifyOptions = {
+	/**
+	 * certifyId 调用实人认证的id
+	 */
+	certifyId: string,
+	/**
+	 * 活体检测页面的进度条颜色。
+	 */
+	progressBarColor?: string,
+	/**
+	 * 认证界面UI朝向。仅Android支持
+	 */
+	screenOrientation?: string,
+	/**
+	 * 成功回调
+	 */
+	success?: (res: StartFacialRecognitionVerifySuccess) => void,
+	/**
+	 * 失败回调
+	 */
+	fail?: (res: UniError) => void,
+	/**
+	 * 完成回调
+	 */
+	complete?: (res: any) => void
+}
+
+/**
+ * 获取阿里云实人认证meta info
+ */
+export type GetFacialRecognitionMetaInfo = () => string
+
+/**
+ * 启动人脸识别
+ */
+export type StartFacialRecognitionVerify = (faceStyle: StartFacialRecognitionVerifyOptions) => void
+
+export interface Uni {
+	/**
+	 * 获取阿里云实人认证meta info
+	 */
+	getFacialRecognitionMetaInfo() : string,
+	/**
+	 * 启动人脸识别
+	 */
+	startFacialRecognitionVerify(faceStyle: StartFacialRecognitionVerifyOptions) : void
+}