@tarojs/taro 3.6.14 → 3.6.16-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tarojs/taro",
-  "version": "3.6.14",
+  "version": "3.6.16-alpha.0",
   "description": "Taro framework",
   "homepage": "https://github.com/nervjs/taro/tree/master/packages/taro#readme",
   "main": "index.js",
@@ -21,11 +21,11 @@
   "author": "O2Team",
   "license": "MIT",
   "dependencies": {
-    "@tarojs/api": "3.6.14",
-    "@tarojs/runtime": "3.6.14"
+    "@tarojs/api": "3.6.16-alpha.0",
+    "@tarojs/runtime": "3.6.16-alpha.0"
   },
   "devDependencies": {
-    "@tarojs/helper": "3.6.14"
+    "@tarojs/helper": "3.6.16-alpha.0"
   },
   "peerDependenciesMeta": {
     "@types/react": {

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

@@ -41,17 +41,17 @@ declare module '../../index' {
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.offClose.html
      */
-    offClose(callback: InterstitialAd.OffCloseCallback): void
+    offClose(callback: InterstitialAd.OnCloseCallback): void
     /** 取消监听插屏错误事件
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.offError.html
      */
-    offError(callback: InterstitialAd.OffErrorCallback): void
+    offError(callback: InterstitialAd.OnErrorCallback): void
     /** 取消监听插屏广告加载事件
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.offLoad.html
      */
-    offLoad(callback: InterstitialAd.OffLoadCallback): void
+    offLoad(callback: InterstitialAd.OnLoadCallback): void
     /** 监听插屏广告关闭事件。
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.onClose.html
@@ -91,12 +91,6 @@ declare module '../../index' {
     show(): Promise<any>
   }
   namespace InterstitialAd {
-    /** 插屏广告关闭事件的回调函数 */
-    type OffCloseCallback = (res: TaroGeneral.CallbackResult) => void
-    /** 插屏错误事件的回调函数 */
-    type OffErrorCallback = (res: TaroGeneral.CallbackResult) => void
-    /** 插屏广告加载事件的回调函数 */
-    type OffLoadCallback = (res: TaroGeneral.CallbackResult) => void
     /** 插屏广告关闭事件的回调函数 */
     type OnCloseCallback = (res: TaroGeneral.CallbackResult) => void
     /** 插屏错误事件的回调函数 */
@@ -137,17 +131,17 @@ declare module '../../index' {
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.offClose.html
      */
-    offClose(callback: RewardedVideoAd.OffCloseCallback): void
+    offClose(callback: RewardedVideoAd.OnCloseCallback): void
     /** 取消监听激励视频错误事件
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.offError.html
      */
-    offError(callback: RewardedVideoAd.OffErrorCallback): void
+    offError(callback: RewardedVideoAd.OnErrorCallback): void
     /** 取消监听激励视频广告加载事件
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.offLoad.html
      */
-    offLoad(callback: RewardedVideoAd.OffLoadCallback): void
+    offLoad(callback: RewardedVideoAd.OnLoadCallback): void
     /** 监听用户点击 `关闭广告` 按钮的事件。
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.onClose.html
@@ -179,12 +173,6 @@ declare module '../../index' {
       isEnded: boolean
     }
     /** 用户点击 `关闭广告` 按钮的事件的回调函数 */
-    type OffCloseCallback = (res: TaroGeneral.CallbackResult) => void
-    /** 激励视频错误事件的回调函数 */
-    type OffErrorCallback = (res: TaroGeneral.CallbackResult) => void
-    /** 激励视频广告加载事件的回调函数 */
-    type OffLoadCallback = (res: TaroGeneral.CallbackResult) => void
-    /** 用户点击 `关闭广告` 按钮的事件的回调函数 */
     type OnCloseCallback = (result: OnCloseCallbackResult) => void
     /** 激励视频错误事件的回调函数 */
     type OnErrorCallback = (result: OnErrorCallbackResult) => void

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

@@ -57,17 +57,17 @@ declare module '../../index' {
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/inference/InferenceSession.offError.html
      */
-    offError(callback?: InferenceSession.OffErrorCallback): void
+    offError(callback?: InferenceSession.OnErrorCallback): void
     /** 取消监听模型加载完成事件
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/inference/InferenceSession.offLoad.html
      */
-    offLoad(callback?: InferenceSession.OffLoadCallback): void
+    offLoad(callback?: InferenceSession.OnLoadCallback): void
     /** 监听模型加载失败事件
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/inference/InferenceSession.onError.html
      */
-    onError(callback: InferenceSession.OnLoadCallback): void
+    onError(callback: InferenceSession.OnErrorCallback): void
     /** 监听模型加载完成事件
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ai/inference/InferenceSession.onLoad.html
@@ -103,12 +103,8 @@ declare module '../../index' {
       [key: string]: Tensor
     }
 
-    /** 模型加载失败回调函数。*/
-    type OffErrorCallback = (res: TaroGeneral.CallbackResult) => void
-    /** 模型加载完成回调函数 */
-    type OffLoadCallback = (res: TaroGeneral.CallbackResult) => void
     /** 模型加载失败回调函数 */
-    type OnLoadCallback = (res: TaroGeneral.CallbackResult) => void
+    type OnErrorCallback = (res: TaroGeneral.CallbackResult) => void
     /** 模型加载完成回调函数 */
     type OnLoadCallback = (res: TaroGeneral.CallbackResult) => void
   }

package/types/api/media/audio.d.ts

@@ -292,83 +292,83 @@ declare module '../../index' {
     /** 音频进入可以播放状态，但不保证后面可以流畅播放
      * @supported weapp, h5, rn
      */
-    onCanplay(callback?: () => void): void
+    onCanplay(callback?: InnerAudioContext.OnCanplayCallback): void
     /** 音频播放事件
      * @supported weapp, h5, rn
      */
-    onPlay(callback?: () => void): void
+    onPlay(callback?: InnerAudioContext.OnPlayCallback): void
     /** 音频暂停事件
      * @supported weapp, h5, rn
      */
-    onPause(callback?: () => void): void
+    onPause(callback?: InnerAudioContext.OnPauseCallback): void
     /** 音频停止事件
      * @supported weapp, h5, rn
      */
-    onStop(callback?: () => void): void
+    onStop(callback?: InnerAudioContext.OnStopCallback): void
     /** 音频自然播放结束事件
      * @supported weapp, h5, rn
      */
-    onEnded(callback?: () => void): void
+    onEnded(callback?: InnerAudioContext.OnEndedCallback): void
     /** 音频播放进度更新事件
      * @supported weapp, h5, rn
      */
-    onTimeUpdate(callback?: () => void): void
+    onTimeUpdate(callback?: InnerAudioContext.OnTimeUpdateCallback): void
     /** 音频播放错误事件
      * @supported weapp, h5, rn
      */
-    onError(callback?: (res: InnerAudioContext.onErrorDetail) => void): void
+    onError(callback?: InnerAudioContext.OnErrorCallback): void
     /** 音频加载中事件，当音频因为数据不足，需要停下来加载时会触发
      * @supported weapp, h5, rn
      */
-    onWaiting(callback?: () => void): void
+    onWaiting(callback?: InnerAudioContext.OnWaitingCallback): void
     /** 音频进行 seek 操作事件
      * @supported weapp, h5, rn
      */
-    onSeeking(callback?: () => void): void
+    onSeeking(callback?: InnerAudioContext.OnSeekingCallback): void
     /** 音频完成 seek 操作事件
      * @supported weapp, h5, rn
      */
-    onSeeked(callback?: () => void): void
-    /** 取消监听 onCanplay 事件
+    onSeeked(callback?: InnerAudioContext.OnSeekedCallback): void
+    /** 取消监听 canplay 事件
      * @supported weapp, h5, rn
      */
-    offCanplay(callback?: () => void): void
-    /** 取消监听 onPlay 事件
+    offCanplay(callback?: InnerAudioContext.OnCanplayCallback): void
+    /** 取消监听 play 事件
      * @supported weapp, h5, rn
      */
-    offPlay(callback?: () => void): void
-    /** 取消监听 onPause 事件
+    offPlay(callback?: InnerAudioContext.OnPlayCallback): void
+    /** 取消监听 pause 事件
      * @supported weapp, h5, rn
      */
-    offPause(callback?: () => void): void
-    /** 取消监听 onStop 事件
+    offPause(callback?: InnerAudioContext.OnPauseCallback): void
+    /** 取消监听 stop 事件
      * @supported weapp, h5, rn
      */
-    offStop(callback?: () => void): void
-    /** 取消监听 onEnded 事件
+    offStop(callback?: InnerAudioContext.OnStopCallback): void
+    /** 取消监听 ended 事件
      * @supported weapp, h5, rn
      */
-    offEnded(callback?: () => void): void
-    /** 取消监听 onTimeUpdate 事件
+    offEnded(callback?: InnerAudioContext.OnEndedCallback): void
+    /** 取消监听 timeUpdate 事件
      * @supported weapp, h5, rn
      */
-    offTimeUpdate(callback?: () => void): void
-    /** 取消监听 onError 事件
+    offTimeUpdate(callback?: InnerAudioContext.OnTimeUpdateCallback): void
+    /** 取消监听 error 事件
      * @supported weapp, h5, rn
      */
-    offError(callback?: () => void): void
-    /** 取消监听 onWaiting 事件
+    offError(callback?: InnerAudioContext.OnErrorCallback): void
+    /** 取消监听 waiting 事件
      * @supported weapp, h5, rn
      */
-    offWaiting(callback?: () => void): void
-    /** 取消监听 onSeeking 事件
+    offWaiting(callback?: InnerAudioContext.OnWaitingCallback): void
+    /** 取消监听 seeking 事件
      * @supported weapp, h5, rn
      */
-    offSeeking(callback?: () => void): void
-    /** 取消监听 onSeeked 事件
+    offSeeking(callback?: InnerAudioContext.OnSeekingCallback): void
+    /** 取消监听 seeked 事件
      * @supported weapp, h5, rn
      */
-    offSeeked(callback?: () => void): void
+    offSeeked(callback?: InnerAudioContext.OnSeekedCallback): void
   }
 
   namespace InnerAudioContext {
@@ -391,6 +391,26 @@ declare module '../../index' {
       /** 未知错误 */
       '-1'
     }
+    /** 音频进入可以播放状态事件的回调函数 */
+    type OnCanplayCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频播放事件的回调函数 */
+    type OnPlayCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频暂停事件的回调函数 */
+    type OnPauseCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频停止事件的回调函数 */
+    type OnStopCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频自然播放结束事件的回调函数 */
+    type OnEndedCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频播放进度更新事件的回调函数 */
+    type OnTimeUpdateCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频播放错误事件的回调函数 */
+    type OnErrorCallback = (res: onErrorDetail) => void
+    /** 音频加载中事件的回调函数 */
+    type OnWaitingCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频进行 seek 操作事件的回调函数 */
+    type OnSeekingCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频完成 seek 操作事件的回调函数 */
+    type OnSeekedCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
   }
 
   /** MediaAudioPlayer 实例，可通过 [Taro.createMediaAudioPlayer](./createMediaAudioPlayer) 接口获取实例。

package/types/api/network/download.d.ts

@@ -57,14 +57,6 @@ declare module '../../index' {
   }
 
   namespace DownloadTask {
-    /** HTTP Response Header 事件的回调函数 */
-    type OffHeadersReceivedCallback = (
-      res: TaroGeneral.CallbackResult,
-    ) => void
-    /** 下载进度变化事件的回调函数 */
-    type OffProgressUpdateCallback = (
-        res: TaroGeneral.CallbackResult,
-    ) => void
     /** HTTP Response Header 事件的回调函数 */
     type OnHeadersReceivedCallback = (
         result: OnHeadersReceivedCallbackResult,
@@ -135,7 +127,7 @@ declare module '../../index' {
      */
     offProgressUpdate(
       /** 下载进度变化事件的回调函数 */
-      callback: DownloadTask.OffProgressUpdateCallback,
+      callback: DownloadTask.OnProgressUpdateCallback,
     ): void
     /** 监听 HTTP Response Header 事件。会比请求完成事件更早
      * @supported weapp, h5
@@ -151,7 +143,7 @@ declare module '../../index' {
      */
     offHeadersReceived(
       /** HTTP Response Header 事件的回调函数 */
-      callback: DownloadTask.OffHeadersReceivedCallback,
+      callback: DownloadTask.OnHeadersReceivedCallback,
     ): void
   }
 

package/types/api/network/upload.d.ts

@@ -56,14 +56,6 @@ declare module '../../index' {
   }
 
   namespace UploadTask {
-    /** HTTP Response Header 事件的回调函数 */
-    type OffHeadersReceivedCallback = (
-      res: TaroGeneral.CallbackResult,
-    ) => void
-    /** 上传进度变化事件的回调函数 */
-    type OffProgressUpdateCallback = (
-      res: TaroGeneral.CallbackResult,
-    ) => void
     /** HTTP Response Header 事件的回调函数 */
     type OnHeadersReceivedCallback = (
       result: OnHeadersReceivedCallbackResult,
@@ -138,7 +130,7 @@ declare module '../../index' {
      */
     offProgressUpdate(
       /** 上传进度变化事件的回调函数 */
-      callback: UploadTask.OffProgressUpdateCallback,
+      callback: UploadTask.OnProgressUpdateCallback,
     ): void
     /** 监听 HTTP Response Header 事件。会比请求完成事件更早
      * @supported weapp, h5
@@ -154,7 +146,7 @@ declare module '../../index' {
      */
     offHeadersReceived(
       /** HTTP Response Header 事件的回调函数 */
-      callback: UploadTask.OffHeadersReceivedCallback,
+      callback: UploadTask.OnHeadersReceivedCallback,
     ): void
   }
 

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

@@ -0,0 +1,90 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace getPrivacySetting {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void;
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void;
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void;
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 是否需要用户授权隐私协议（如果开发者没有在[mp后台-设置-服务内容声明-用户隐私保护指引]中声明隐私收集类型则会返回false；如果开发者声明了隐私收集，且用户之前同意过隐私协议则会返回false；如果开发者声明了隐私收集，且用户还没同意过则返回true；如果用户之前同意过、但后来小程序又新增了隐私收集类型也会返回true） */
+      needAuthorization: boolean;
+      /** 隐私授权协议的名称 */
+      privacyContractName: string;
+    }
+  }
+
+  namespace requirePrivacyAuthorize {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void;
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void;
+      /** 接口调用成功的回调函数 */
+      success?: (result: TaroGeneral.CallbackResult) => void;
+    }
+  }
+
+  namespace openPrivacyContract {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void;
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void;
+      /** 接口调用成功的回调函数 */
+      success?: (result: TaroGeneral.CallbackResult) => void;
+    }
+  }
+
+  namespace onNeedPrivacyAuthorization {
+    /**
+     * resolve 是 onNeedPrivacyAuthorization 的回调参数，是一个接口函数。
+     * 当触发 needPrivacyAuthorization 事件时，触发该事件的隐私接口或组件会处于 pending 状态。
+     * 如果调用 resolve({ buttonId: 'disagree-btn'， event:'agree' })，则触发当前 needPrivacyAuthorization 事件的原隐私接口或组件会继续执行。其中 buttonId 为隐私同意授权按钮的id，为确保用户有同意的操作，基础库会检查对应的同意按钮是否被点击过。
+     * 如果调用 resolve({ event: 'disagree' })，则触发当前 needPrivacyAuthorization 事件的原隐私接口或组件会失败并返回 API:fail privacy permission is not authorized 的错误信息。
+     * 在调用 resolve({ event: 'agree'/'disagree' }) 之前，开发者可以调用 resolve({ event: 'exposureAuthorization' }) 把隐私弹窗曝光告知平台。
+     */
+    interface ResolveOption {
+      /** 用户操作类型 */
+      event: 'exposureAuthorization' | 'agree' | 'disagree';
+      /** 同意授权按钮的id （仅event=agree时必填） */
+      buttonId?: string;
+    }
+    /**
+     * 触发本次 onNeedPrivacyAuthorization 事件的关联信息
+     */
+    interface EventInfo {
+      referrer: string
+    }
+
+    type Resolve = (option: ResolveOption) => void;
+    type Listener = (resolve: Resolve, eventInfo: EventInfo) => void;
+  }
+
+  interface TaroStatic {
+    /**
+     * 查询隐私授权情况。隐私合规开发指南详情可见《小程序隐私协议开发指南》
+     * @supported weapp
+     */
+    getPrivacySetting: (option?: getPrivacySetting.Option) => void;
+    /**
+     * 跳转至隐私协议页面。隐私合规开发指南详情可见《小程序隐私协议开发指南》
+     * @supported weapp
+     */
+    openPrivacyContract: (option?: openPrivacyContract.Option) => void;
+    /**
+     * 模拟隐私接口调用，并触发隐私弹窗逻辑。隐私合规开发指南详情可见《小程序隐私协议开发指南》
+     * @supported weapp
+     */
+    requirePrivacyAuthorize: (option?: requirePrivacyAuthorize.Option) => void;
+    /** 
+     * 监听隐私接口需要用户授权事件。当需要用户进行隐私授权时会触发。触发该事件时，开发者需要弹出隐私协议说明，并在用户同意或拒绝授权后调用回调接口 resolve 触发原隐私接口或组件继续执行。隐私合规开发指南详情可见《小程序隐私协议开发指南》
+     * @supported weapp
+    */
+    onNeedPrivacyAuthorization: (listener: onNeedPrivacyAuthorization.Listener) => void;
+  }
+}

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

@@ -156,6 +156,7 @@ declare module '../../index' {
 
     /** 关闭当前页面，跳转到应用内的某个页面。但是不允许跳转到 tabbar 页面。
      * @supported weapp, h5, rn, tt
+     * @h5 未针对 tabbar 页面做限制处理
      * @example
      * ```tsx
      * Taro.redirectTo({
@@ -168,6 +169,7 @@ declare module '../../index' {
 
     /** 保留当前页面，跳转到应用内的某个页面。但是不能跳到 tabbar 页面。使用 Taro.navigateBack 可以返回到原页面。小程序中页面栈最多十层。
      * @supported weapp, h5, rn, tt
+     * @h5 未针对 tabbar 页面做限制处理
      * @example
      * ```tsx
      * Taro.navigateTo({

package/types/api/taro.extend.d.ts

@@ -83,7 +83,7 @@ declare module '../index' {
     /** 尺寸转换
      * @supported global
      */
-    pxTransform(size: number, designWidth?: number): string
+    pxTransform(size: number): string
 
     /** 尺寸转换初始化
      * @supported global

package/types/taro.config.d.ts

@@ -622,6 +622,12 @@ declare module './index' {
        */
       useAuthorizePage: boolean
     }
+    /**
+     * 在 2023年9月15号之前，在 app.json 中配置 __usePrivacyCheck__: true 后，会启用隐私相关功能，如果不配置或者配置为 false 则不会启用。
+     * 在 2023年9月15号之后，不论 app.json 中是否有配置 __usePrivacyCheck__，隐私相关功能都会启用
+     * @supported wx
+     */
+    __usePrivacyCheck__?: boolean
     /**
      * 正常情况下默认所有资源文件都被打包发布到所有平台，可以通过 static 字段配置特定每个目录/文件只能发布到特定的平台(多端场景)
      * @see https://dev.weixin.qq.com/docs/framework/guideline/devtools/condition-compile.html#%E8%B5%84%E6%BA%90