@tarojs/taro 3.5.0-canary.1 → 3.5.0

package/package.json

@@ -1,21 +1,16 @@
 {
   "name": "@tarojs/taro",
-  "version": "3.5.0-canary.1",
+  "version": "3.5.0",
   "description": "Taro framework",
   "homepage": "https://github.com/nervjs/taro/tree/master/packages/taro#readme",
   "main": "index.js",
-  "main:h5": "h5.js",
   "typings": "types/index.d.ts",
   "files": [
     "index.js",
-    "h5.js",
     "types",
     "html.css",
     "html5.css"
   ],
-  "scripts": {
-    "test": "echo \"Error: run tests from root\" && exit 1"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/NervJS/taro.git"
@@ -26,9 +21,24 @@
   "author": "O2Team",
   "license": "MIT",
   "dependencies": {
-    "@tarojs/api": "3.5.0-canary.1",
-    "@tarojs/runtime": "3.5.0-canary.1",
-    "@tarojs/taro-h5": "3.5.0-canary.1"
+    "@tarojs/api": "3.5.0",
+    "@tarojs/runtime": "3.5.0"
   },
-  "gitHead": "c61624d2f763e6d31e67d6cf9c564efc8b0d0887"
-}
+  "peerDependenciesMeta": {
+    "@types/react": {
+      "optional": true
+    },
+    "@types/webpack": {
+      "optional": true
+    },
+    "@types/webpack-dev-server": {
+      "optional": true
+    },
+    "vue": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "test": "echo \"Error: run tests from root\" && exit 1"
+  }
+}

package/types/api/ad/index.d.ts

@@ -97,7 +97,7 @@ declare module '../../index' {
     type OnLoadCallback = (res: TaroGeneral.CallbackResult) => void
     interface OnErrorCallbackResult extends TaroGeneral.CallbackResult {
       /** 错误码
-       * @see https://nervjs.github.io/taro/docs/apis/General#AdErrCode
+       * @see /docs/apis/General#aderrcode
        */
       errCode: keyof TaroGeneral.AdErrCode
       /** 错误信息 */
@@ -160,7 +160,7 @@ declare module '../../index' {
   namespace RewardedVideoAd {
     interface OnErrorCallbackResult extends TaroGeneral.CallbackResult {
       /** 错误码
-       * @see https://nervjs.github.io/taro/docs/apis/General#AdErrCode
+       * @see /docs/apis/General#aderrcode
        */
       errCode: keyof TaroGeneral.AdErrCode
       /** 错误信息 */

package/types/api/ai/face.d.ts

@@ -0,0 +1,133 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace stopFaceDetect {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace initFaceDetect {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace faceDetect {
+    interface Option {
+      /** 图像像素点数据，每四项表示一个像素点的 RGBA */
+      frameBuffer: ArrayBuffer
+      /** 图像宽度 */
+      width: number
+      /** 图像高度 */
+      height: number
+      /** 是否返回当前图像的人脸（106 个点）
+       * @default false
+       */
+      enablePoint?: boolean
+      /** 是否返回当前图像的人脸的置信度（可表示器官遮挡情况）
+       * @default false
+       */
+      enableConf?: boolean
+      /** 是否返回当前图像的人脸角度信息
+       * @default false
+       */
+      enableAngle?: boolean
+      /** 是否返回多张人脸的信息
+       * @default false
+       */
+      enableMultiFace?: boolean
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackOption) => void
+    }
+
+    interface SuccessCallbackOption extends face {
+      /** 多人模式（enableMultiFace）下的人脸信息，每个对象包含上述其它属性 */
+      faceInfo?: face
+    }
+
+    interface face {
+      /** 脸部正方框数值，对象包含 height, weight, originX, originY 四个属性 */
+      detectRect: detectRect
+      /** 脸部中心点横坐标，检测不到人脸则为 -1 */
+      x: number
+      /** 脸部中心点纵坐标，检测不到人脸则为 -1 */
+      y: number
+      /** 人脸 106 个点位置数组，数组每个对象包含 x 和 y */
+      pointArray: point[]
+      /** 人脸置信度，取值范围 [0, 1]，数值越大置信度越高（遮挡越少） */
+      confArray: conf[]
+      /** 人脸角度信息，取值范围 [-1, 1]，数值越接近 0 表示越正对摄像头 */
+      angleArray: angle[]
+    }
+
+    /** 脸部正方框数值 */
+    interface detectRect {
+      height: number
+      weight: number
+      originX: number
+      originY: number
+    }
+
+    interface point {
+      x: number
+      y: number
+    }
+
+    interface conf {
+      /** 整体可信度 */
+      global: number
+      /** 左眼可信度 */
+      leftEye: number
+      /** 右眼可信度 */
+      rightEye: number
+      /** 嘴巴可信度 */
+      mouth: number
+      /** 鼻子可信度 */
+      nose: number
+    }
+
+    interface angle {
+      /** 仰俯角（点头） */
+      pitch: number
+      /** 偏航角（摇头） */
+      yaw: number
+      /** 翻滚角（左右倾） */
+      roll: number
+    }
+  }
+
+  interface TaroStatic {
+    /** 停止人脸识别
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/face/wx.stopFaceDetect.html
+     */
+    stopFaceDetect (option: stopFaceDetect.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 初始化人脸识别
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/face/wx.initFaceDetect.html
+     */
+    initFaceDetect (option: initFaceDetect.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 人脸识别，使用前需要通过 Taro.initFaceDetect 进行一次初始化，推荐使用相机接口返回的帧数据
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/face/wx.faceDetect.html
+     */
+    faceDetect (option: faceDetect.Option): Promise<TaroGeneral.CallbackResult>
+  }
+}

package/types/api/ai/visionkit.d.ts

@@ -0,0 +1,303 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace isVKSupport {
+    /** vision kit 版本 */
+    interface Version {
+      /** 旧版本 */
+      v1
+      /** v2 版本，目前只有 iOS 基础库 2.22.0 以上支持 */
+      v2
+    }
+  }
+  namespace createVKSession {
+    /** vision kit 版本 */
+    interface Version {
+      /** 旧版本 */
+      v1
+      /** v2 版本，目前只有 iOS 基础库 2.22.0 以上支持 */
+      v2
+    }
+    /** 跟踪配置 */
+    interface Track {
+      /** 平面跟踪配置 */
+      plane: Plane
+    }
+    /** 平面跟踪配置 */
+    interface Plane {
+      /** 平面跟踪配置模式 */
+      mode: keyof PlaneMode
+    }
+    /** 平面跟踪配置模式合法值 */
+    interface PlaneMode {
+      /** 检测横向平面 */
+      1
+      /** 检测纵向平面，只有 v2 版本支持 */
+      2
+      /** 检测横向和纵向平面，只有 v2 版本支持 */
+      3
+    }
+  }
+
+  /** anchor 对象，只有 v2 版本支持
+   * @supported weapp
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKAnchor.html
+   */
+  interface VKAnchor {
+    /** 唯一标识 */
+    id: number
+    /** 类型 */
+    type: keyof VKAnchor.Type
+    /** 包含位置、旋转、放缩信息的矩阵，以列为主序 */
+    transform: Float32Array
+    /** 尺寸，只有平面 anchor 支持 */
+    size: VKAnchor.Size
+    /** 方向，只有平面 anchor 支持 */
+    alignment: number
+  }
+  namespace VKAnchor {
+    /** anchor 对象类型合法值 */
+    interface Type {
+      /** 平面 */
+      0
+    }
+    /** anchor 对象类型合法值 */
+    interface Size {
+      /** 宽度 */
+      width: number
+      /** 高度 */
+      height: number
+    }
+  }
+
+  /** 相机对象
+   * @supported weapp
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKCamera.html
+   */
+  interface VKCamera {
+    /** 视图矩阵 */
+    viewMatrix: Float32Array
+    /** 相机内参，只有 v2 版本支持 */
+    intrinsics: Float32Array
+    /** 获取投影矩阵
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKCamera.getProjectionMatrix.html
+     */
+    getProjectionMatrix (
+      /** 近视点 */
+      near: number,
+      /** 远视点 */
+      far: number
+    ): Float32Array
+  }
+
+  /** vision kit 会话对象
+   * @supported weapp
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKFrame.html
+   */
+  interface VKFrame {
+    /** 生成时间 */
+    timestamp: number
+    /** 相机对象 */
+    camera: VKCamera
+    /** 获取当前帧纹理，目前只支持 YUV 纹理
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKFrame.getCameraTexture.html
+     */
+    getCameraTexture(ctx: WebGLRenderingContext): VKFrame.getCameraTextureResult
+    /** 获取纹理调整矩阵。默认获取到的纹理是未经裁剪调整的纹理，此矩阵可用于在着色器中根据帧对象尺寸对纹理进行裁剪
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKFrame.getDisplayTransform.html
+     */
+    getDisplayTransform(): Float32Array
+  }
+
+  namespace VKFrame {
+    /** 帧纹理对象 */
+    interface getCameraTextureResult {
+      /** Y 分量纹理 */
+      yTexture: WebGLTexture
+      /** UV 分量纹理 */
+      uvTexture: WebGLTexture
+    }
+  }
+
+  /** vision kit 会话对象
+   * @supported weapp
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.html
+   */
+  interface VKSession {
+    /** 会话状态 */
+    state: keyof VKSession.State
+    /** 会话配置 */
+    config: VKSession.Config
+    /** 相机尺寸 */
+    cameraSize: VKSession.Size
+    /** 取消由 requestAnimationFrame 添加到计划中的动画帧请求
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.cancelAnimationFrame.html
+     */
+    cancelAnimationFrame(requestID: number): void
+    /** 销毁会话
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.destroy.html
+     */
+    destroy(): void
+    /** 获取帧对象，每调用一次都会触发一次帧分析过程
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.getVKFrame.html
+     */
+    getVKFrame(
+     /** 宽度 */
+     width: number,
+     /** 高度 */
+     height: number
+    ): VKFrame
+    /** 触摸检测，v1 版本只支持单平面（即 hitTest 生成一次平面后，后续 hitTest 均不会再生成平面，而是以之前生成的平面为基础进行检测）。
+     *
+     * 如果需要重新识别其他平面，可以在调用此方法时将 reset 参数置为 true。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.hitTest.html
+     */
+    hitTest(
+     /** 相对视窗的横坐标，取值范围为 [0, 1]，0 为左边缘，1 为右边缘 */
+     x: number,
+     /** 相对视窗的纵坐标，取值范围为 [0, 1]，0 为上边缘，1 为下边缘 */
+     y: number,
+     /** 是否需要重新识别其他平面，v2 版本不再需要此参数 */
+     reset?: boolean
+    ): VKSession.hitTestResult[]
+    /** 取消监听会话事件。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.off.html
+     */
+    off(
+     /** 事件名称 */
+     eventName: string,
+     /** 事件监听函数 */
+     fn: Function
+    ): void
+    /** 监听会话事件。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.on.html
+     */
+    on(
+     /** 事件名称 */
+     eventName: string,
+     /** 事件监听函数 */
+     fn: Function
+    ): void
+    /** 在下次进行重绘时执行。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.requestAnimationFrame.html
+     */
+    requestAnimationFrame(
+     /** 执行函数 */
+     callback: Function
+    ): number
+    /** 开启会话。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.start.html
+     */
+    start(
+     /** 开启会话回调 */
+     callback: (status: keyof VKSession.StartStatus) => void
+    ): void
+    /** 停止会话。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.stop.html
+     */
+     stop(): void
+  }
+  namespace VKSession {
+    /** state 的合法值 */
+    interface State {
+      /** 不可用 */
+      0
+      /** 运行中 */
+      1
+      /** 暂停中 */
+      2
+    }
+    /** 会话配置 */
+    interface Config {
+      /** 不可用 */
+      version: keyof version
+      /** 运行中 */
+      track: track
+    }
+    /** vision kit 版本 */
+    interface version {
+      /** 旧版本 */
+      v1
+      /** v2 版本，目前只有 iOS 基础库 2.22.0 以上支持 */
+      v2
+    }
+    /** 跟踪配置 */
+    interface track {
+      /** 平面跟踪配置 */
+      plane: plane
+    }
+    /** 平面跟踪配置 */
+    interface plane {
+      /** 平面跟踪配置模式 */
+      mode: keyof PlaneMode
+    }
+    /** 平面跟踪配置模式合法值 */
+    interface PlaneMode {
+      /** 检测横向平面 */
+      1
+      /** 检测纵向平面，只有 v2 版本支持 */
+      2
+      /** 检测横向和纵向平面，只有 v2 版本支持 */
+      3
+    }
+    /** 相机尺寸 */
+    interface Size {
+      /** 宽度 */
+      width: number
+      /** 高度 */
+      height: number
+    }
+
+    /** hitTest 检测结果 */
+    interface hitTestResult {
+      /** 包含位置、旋转、放缩信息的矩阵，以列为主序 */
+      transform: Float32Array
+    }
+
+    /** start status 的合法值 */
+    interface StartStatus {
+      /** 成功 */
+      0
+      /** 系统错误 */
+      2000000
+      /** 参数错误 */
+      2000001
+      /** 设备不支持 */
+      2000002
+      /** 系统不支持 */
+      2000003
+      /** 会话不可用 */
+      2003000
+      /** 未开启系统相机权限 */
+      2003001
+      /** 未开启小程序相机权限 */
+      2003002
+    }
+  }
+
+  interface TaroStatic {
+    /** 判断支持版本
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/wx.isVKSupport.html
+     */
+     isVKSupport (version: keyof isVKSupport.Version): boolean /** 是否支持对应版本的 vision kit */
+
+    /** 创建 vision kit 会话对象
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/wx.createVKSession.html
+     */
+    createVKSession (version: keyof createVKSession.Version): VKSession /** vision kit 会话对象 */
+  }
+}

package/types/api/base/crypto.d.ts

@@ -0,0 +1,90 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  /** 用户加密模块
+   * @supported weapp
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/crypto/UserCryptoManager.html
+   */
+  interface UserCryptoManager {
+    /** 获取最新的用户加密密钥
+     * @supported weapp
+     * @example
+     * ```tsx
+     * const userCryptoManager = Taro.getUserCryptoManager()
+     * userCryptoManager.getLatestUserKey({
+     *   success: res => {
+     *     const { encryptKey, iv, version, expireTime } = res
+     *     console.log(encryptKey, iv, version, expireTime)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/crypto/UserCryptoManager.getLatestUserKey.html
+     */
+    getLatestUserKey(option: UserCryptoManager.getLatestUserKey.Option): Promise<UserCryptoManager.getLatestUserKey.SuccessCallbackResult>
+
+    /** 获取密码学安全随机数
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.getRandomValues({
+     *   length: 6 // 生成 6 个字节长度的随机数,
+     *   success: res => {
+     *     console.log(Taro.arrayBufferToBase64(res.randomValues)) // 转换为 base64 字符串后打印
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/crypto/UserCryptoManager.getRandomValues.html
+     */
+    getRandomValues(option: UserCryptoManager.getRandomValues.Option): Promise<UserCryptoManager.getRandomValues.SuccessCallbackResult>
+  }
+
+  namespace UserCryptoManager {
+    namespace getLatestUserKey {
+      interface Option {
+        /** 接口调用成功的回调函数 */
+        success?: (res: TaroGeneral.CallbackResult) => void
+        /** 接口调用失败的回调函数 */
+        fail?: (res: TaroGeneral.CallbackResult) => void
+        /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+        complete?: (res: SuccessCallbackResult) => void
+      }
+
+      interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+        /** 用户加密密钥 */
+        encryptKey: string
+        /** 密钥初始向量 */
+        iv: string
+        /** 密钥版本 */
+        version: number
+        /** 密钥过期时间 */
+        expireTime: number
+      }
+    }
+
+    namespace getRandomValues {
+      interface Option {
+        /** 整数，生成随机数的字节数，最大 1048576 */
+        length: number
+        /** 接口调用成功的回调函数 */
+        success?: (res: TaroGeneral.CallbackResult) => void
+        /** 接口调用失败的回调函数 */
+        fail?: (res: TaroGeneral.CallbackResult) => void
+        /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+        complete?: (res: SuccessCallbackResult) => void
+      }
+
+      interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+        /** 随机数内容，长度为传入的字节数 */
+        randomValues: ArrayBuffer
+      }
+    }
+  }
+
+  interface TaroStatic {
+    /** 获取用户加密模块
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/crypto/wx.getUserCryptoManager.html
+     */
+    getUserCryptoManager(): UserCryptoManager
+  }
+}