@tarojs/taro 3.3.11 → 3.3.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tarojs/taro",
-  "version": "3.3.11",
+  "version": "3.3.15",
   "description": "Taro framework",
   "homepage": "https://github.com/nervjs/taro/tree/master/packages/taro#readme",
   "main": "index.js",
@@ -26,9 +26,9 @@
   "author": "O2Team",
   "license": "MIT",
   "dependencies": {
-    "@tarojs/api": "3.3.11",
-    "@tarojs/runtime": "3.3.11",
-    "@tarojs/taro-h5": "3.3.11"
+    "@tarojs/api": "3.3.15",
+    "@tarojs/runtime": "3.3.15",
+    "@tarojs/taro-h5": "3.3.15"
   },
-  "gitHead": "dad3664e58bb1fe7ab752365d9cc0d0dd444c40a"
+  "gitHead": "4a11ab9a8950f6a580e1278c160f6b4aaa8ac4f2"
 }

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

@@ -1,9 +1,6 @@
-declare namespace Taro {
-  /** 创建激励视频广告组件。
-   * @supported weapp
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/wx.createRewardedVideoAd.html
-   */
-  function createRewardedVideoAd (option: createRewardedVideoAd.Option): RewardedVideoAd
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace createRewardedVideoAd {
     interface Option {
       /** 广告单元 id */
@@ -14,12 +11,6 @@ declare namespace Taro {
       multiton?: boolean
     }
   }
-  /** 创建插屏广告组件。
-   * 请通过 getSystemInfoSync 返回对象的 SDKVersion 判断基础库版本号后再使用该 API。每次调用该方法创建插屏广告都会返回一个全新的实例（小程序端的插屏广告实例不允许跨页面使用）。
-   * @supported weapp
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/wx.createInterstitialAd.html
-   */
-  function createInterstitialAd (option: createInterstitialAd.Option): InterstitialAd
 
   namespace createInterstitialAd {
     interface Option {
@@ -27,7 +18,7 @@ declare namespace Taro {
       adUnitId: string
     }
   }
-  
+
   /**
    * 插屏广告组件。插屏广告组件是一个原生组件，层级比普通组件高。插屏广告组件每次创建都会返回一个全新的实例（小程序端的插屏广告实例不允许跨页面使用），默认是隐藏的，需要调用 InterstitialAd.show() 将其显示。
    * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.html
@@ -74,7 +65,7 @@ declare namespace Taro {
      */
     load(): Promise<any>
     /** 显示插屏广告。
-     * 
+     *
      * **错误码信息表**
      *
      *  如果插屏广告显示失败，InterstitialAd.show() 方法会返回一个rejected Promise，开发者可以获取到错误码及对应的错误信息。
@@ -93,22 +84,22 @@ declare namespace Taro {
   }
   namespace InterstitialAd {
     /** 插屏广告关闭事件的回调函数 */
-    type OffCloseCallback = (res: General.CallbackResult) => void
+    type OffCloseCallback = (res: TaroGeneral.CallbackResult) => void
     /** 插屏错误事件的回调函数 */
-    type OffErrorCallback = (res: General.CallbackResult) => void
+    type OffErrorCallback = (res: TaroGeneral.CallbackResult) => void
     /** 插屏广告加载事件的回调函数 */
-    type OffLoadCallback = (res: General.CallbackResult) => void
+    type OffLoadCallback = (res: TaroGeneral.CallbackResult) => void
     /** 插屏广告关闭事件的回调函数 */
-    type OnCloseCallback = (res: General.CallbackResult) => void
+    type OnCloseCallback = (res: TaroGeneral.CallbackResult) => void
     /** 插屏错误事件的回调函数 */
     type OnErrorCallback = (result: OnErrorCallbackResult) => void
     /** 插屏广告加载事件的回调函数 */
-    type OnLoadCallback = (res: General.CallbackResult) => void
-    interface OnErrorCallbackResult extends General.CallbackResult {
+    type OnLoadCallback = (res: TaroGeneral.CallbackResult) => void
+    interface OnErrorCallbackResult extends TaroGeneral.CallbackResult {
       /** 错误码
        * @see https://nervjs.github.io/taro/docs/apis/General#AdErrCode
        */
-      errCode: keyof General.AdErrCode
+      errCode: keyof TaroGeneral.AdErrCode
       /** 错误信息 */
       errMsg: string
     }
@@ -154,7 +145,7 @@ declare namespace Taro {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.onClose.html
      */
     onClose(callback: RewardedVideoAd.OnCloseCallback): void
-    /** 
+    /**
      * 监听激励视频错误事件。
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.onError.html
@@ -167,11 +158,11 @@ declare namespace Taro {
     onLoad(callback: RewardedVideoAd.OnLoadCallback): void
   }
   namespace RewardedVideoAd {
-    interface OnErrorCallbackResult extends General.CallbackResult {
+    interface OnErrorCallbackResult extends TaroGeneral.CallbackResult {
       /** 错误码
        * @see https://nervjs.github.io/taro/docs/apis/General#AdErrCode
        */
-      errCode: keyof General.AdErrCode
+      errCode: keyof TaroGeneral.AdErrCode
       /** 错误信息 */
       errMsg: string
     }
@@ -180,16 +171,31 @@ declare namespace Taro {
       isEnded: boolean
     }
     /** 用户点击 `关闭广告` 按钮的事件的回调函数 */
-    type OffCloseCallback = (res: General.CallbackResult) => void
+    type OffCloseCallback = (res: TaroGeneral.CallbackResult) => void
     /** 激励视频错误事件的回调函数 */
-    type OffErrorCallback = (res: General.CallbackResult) => void
+    type OffErrorCallback = (res: TaroGeneral.CallbackResult) => void
     /** 激励视频广告加载事件的回调函数 */
-    type OffLoadCallback = (res: General.CallbackResult) => void
+    type OffLoadCallback = (res: TaroGeneral.CallbackResult) => void
     /** 用户点击 `关闭广告` 按钮的事件的回调函数 */
     type OnCloseCallback = (result: OnCloseCallbackResult) => void
     /** 激励视频错误事件的回调函数 */
     type OnErrorCallback = (result: OnErrorCallbackResult) => void
     /** 激励视频广告加载事件的回调函数 */
-    type OnLoadCallback = (res: General.CallbackResult) => void
+    type OnLoadCallback = (res: TaroGeneral.CallbackResult) => void
+  }
+
+  interface TaroStatic {
+    /** 创建激励视频广告组件。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/wx.createRewardedVideoAd.html
+     */
+    createRewardedVideoAd (option: createRewardedVideoAd.Option): RewardedVideoAd
+
+    /** 创建插屏广告组件。
+     * 请通过 getSystemInfoSync 返回对象的 SDKVersion 判断基础库版本号后再使用该 API。每次调用该方法创建插屏广告都会返回一个全新的实例（小程序端的插屏广告实例不允许跨页面使用）。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/wx.createInterstitialAd.html
+     */
+    createInterstitialAd (option: createInterstitialAd.Option): InterstitialAd
   }
 }

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

@@ -1,8 +1,12 @@
-declare namespace Taro {
-  /**
-   * 此接口可获取支付宝会员的基础信息（头像图片地址、昵称、性别、国家码、省份、所在市区），接入方法请参考 获取会员基础信息介绍。如需获取支付宝会员标识（user_id），请调用 my.getAuthCode 和 alipay.system.oauth.token 接口。
-   * @supported alipay
-   * @see https://docs.alipay.com/mini/api/ch8chh
-   */
-  function getOpenUserInfo(): Promise<string>
+import Taro from '../../index'
+
+declare module '../../index' {
+  interface TaroStatic {
+    /**
+     * 此接口可获取支付宝会员的基础信息（头像图片地址、昵称、性别、国家码、省份、所在市区），接入方法请参考 获取会员基础信息介绍。如需获取支付宝会员标识（user_id），请调用 my.getAuthCode 和 alipay.system.oauth.token 接口。
+     * @supported alipay
+     * @see https://docs.alipay.com/mini/api/ch8chh
+     */
+    getOpenUserInfo(): Promise<string>
+  }
 }

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

@@ -1,37 +1,22 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace setEnableDebug {
     type Option = {
       /** 是否打开调试 */
       enableDebug: boolean
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
-    interface Promised extends General.CallbackResult {
+    interface Promised extends TaroGeneral.CallbackResult {
       /** 调用结果 */
       errMsg: string
     }
   }
-  /**
-   * 设置是否打开调试开关，此开关对正式版也能生效。
-   * @supported weapp
-   * @example
-   * ```tsx
-   * // 打开调试
-   * Taro.setEnableDebug({
-   *     enableDebug: true
-   * })
-   * // 关闭调试
-   * Taro.setEnableDebug({
-   *     enableDebug: false
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/wx.setEnableDebug.html
-   */
-  function setEnableDebug(res: setEnableDebug.Option): Promise<setEnableDebug.Promised>
 
   namespace getLogManager {
     type Option = {
@@ -48,31 +33,16 @@ declare namespace Taro {
       1
     }
   }
-  /**
-   * 获取日志管理器对象。
-   * @supported weapp
-   * @example
-   * ```tsx
-   * const logger = Taro.getLogManager({level: 1})
-   * 
-   * logger.log({str: 'hello world'}, 'basic log', 100, [1, 2, 3])
-   * logger.info({str: 'hello world'}, 'info log', 100, [1, 2, 3])
-   * logger.debug({str: 'hello world'}, 'debug log', 100, [1, 2, 3])
-   * logger.warn({str: 'hello world'}, 'warn log', 100, [1, 2, 3])
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/wx.getLogManager.html
-   */
-  function getLogManager(res?: getLogManager.Option): LogManager
 
   /**
    * 日志管理器实例，可以通过 Taro.getLogManager 获取。
-   * 
+   *
    * 使用说明
    * 最多保存5M的日志内容，超过5M后，旧的日志内容会被删除。
    * 对于小程序，用户可以通过使用 button 组件的 open-type="feedback" 来上传打印的日志。
    * 对于小游戏，用户可以通过使用 Taro.createFeedbackButton 来创建上传打印的日志的按钮。
    * 开发者可以通过小程序管理后台左侧菜单“反馈管理”页面查看相关打印日志。
-   * 
+   *
    * 基础库默认会把 App、Page 的生命周期函数和 wx 命名空间下的函数调用写入日志。
    */
   interface LogManager {
@@ -108,24 +78,11 @@ declare namespace Taro {
       /** 日志内容，可以有任意多个。每次调用的参数的总大小不超过100Kb */
       ...args: any[]
     ): void
-}
-
-  /**
-   * 获取实时日志管理器对象。
-   * @supported weapp
-   * @example
-   * ```tsx
-   * const logger = Taro.getRealtimeLogManager()
-   * logger.info({str: 'hello world'}, 'info log', 100, [1, 2, 3])
-   * logger.error({str: 'hello world'}, 'error log', 100, [1, 2, 3])
-   * logger.warn({str: 'hello world'}, 'warn log', 100, [1, 2, 3])
-   * ```
-   */
-  function getRealtimeLogManager(): RealtimeLogManager
+  }
 
   /**
    * 实时日志管理器实例，可以通过 Taro.getRealtimeLogManager 获取。
-   * 
+   *
    * 使用说明
    * 为帮助小程序开发者快捷地排查小程序漏洞、定位问题，我们推出了实时日志功能。从基础库2.7.1开始，开发者可通过提供的接口打印日志，日志汇聚并实时上报到小程序后台。
    * 开发者可从小程序管理后台“开发->运维中心->实时日志”进入日志查询页面，查看开发者打印的日志信息。
@@ -181,4 +138,53 @@ declare namespace Taro {
       ...args: any[]
     ): void
   }
+
+  interface TaroStatic {
+    /**
+     * 设置是否打开调试开关，此开关对正式版也能生效。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * // 打开调试
+     * Taro.setEnableDebug({
+     *     enableDebug: true
+     * })
+     * // 关闭调试
+     * Taro.setEnableDebug({
+     *     enableDebug: false
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/wx.setEnableDebug.html
+     */
+    setEnableDebug(res: setEnableDebug.Option): Promise<setEnableDebug.Promised>
+
+    /**
+     * 获取日志管理器对象。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * const logger = Taro.getLogManager({level: 1})
+     *
+     * logger.log({str: 'hello world'}, 'basic log', 100, [1, 2, 3])
+     * logger.info({str: 'hello world'}, 'info log', 100, [1, 2, 3])
+     * logger.debug({str: 'hello world'}, 'debug log', 100, [1, 2, 3])
+     * logger.warn({str: 'hello world'}, 'warn log', 100, [1, 2, 3])
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/wx.getLogManager.html
+     */
+    getLogManager(res?: getLogManager.Option): LogManager
+
+    /**
+     * 获取实时日志管理器对象。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * const logger = Taro.getRealtimeLogManager()
+     * logger.info({str: 'hello world'}, 'info log', 100, [1, 2, 3])
+     * logger.error({str: 'hello world'}, 'error log', 100, [1, 2, 3])
+     * logger.warn({str: 'hello world'}, 'warn log', 100, [1, 2, 3])
+     * ```
+     */
+    getRealtimeLogManager(): RealtimeLogManager
+  }
 }

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

@@ -1,10 +1,14 @@
-declare namespace Taro {
-  /**
-   * @supported weapp
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/env/envObj.html
-   */
-  abstract class env {
-    /** 文件系统中的用户目录路径 (本地路径) */
-    static USER_DATA_PATH: string
+import Taro from '../../index'
+
+declare module '../../index' {
+  interface TaroStatic {
+    /**
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/env/envObj.html
+     */
+    env: {
+      /** 文件系统中的用户目录路径 (本地路径) */
+      USER_DATA_PATH: string
+    }
   }
 }

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

@@ -1,90 +1,94 @@
-declare namespace Taro {
-  /** 判断小程序的 API，回调，参数，组件等是否在当前版本可用。
-   * @supported weapp
-   * @example
-   * ```tsx
-   * Taro.canIUse('openBluetoothAdapter')
-   * Taro.canIUse('getSystemInfoSync.return.screenWidth')
-   * Taro.canIUse('getSystemInfo.success.screenWidth')
-   * Taro.canIUse('showToast.object.image')
-   * Taro.canIUse('onCompassChange.callback.direction')
-   * Taro.canIUse('request.object.method.GET')
-   * Taro.canIUse('live-player')
-   * Taro.canIUse('text.selectable')
-   * Taro.canIUse('button.open-type.contact')
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/wx.canIUse.html
-   */
-  function canIUse(
-    /**
-     * 使用 `${API}.${method}.${param}.${option}` 或者 `${component}.${attribute}.${option}` 方式来调用
-     *
-     * **参数说明**
-     *
-     * - `${API}` 代表 API 名字
-     * - `${method}` 代表调用方式，有效值为return, success, object, callback
-     * - `${param}` 代表参数或者返回值
-     * - `${option}` 代表参数的可选值或者返回值的属性
-     * - `${component}` 代表组件名字
-     * - `${attribute}` 代表组件属性
-     * - `${option}` 代表组件属性的可选值
+import Taro from '../../index'
+
+declare module '../../index' {
+  interface TaroStatic {
+    /** 判断小程序的 API，回调，参数，组件等是否在当前版本可用。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.canIUse('openBluetoothAdapter')
+     * Taro.canIUse('getSystemInfoSync.return.screenWidth')
+     * Taro.canIUse('getSystemInfo.success.screenWidth')
+     * Taro.canIUse('showToast.object.image')
+     * Taro.canIUse('onCompassChange.callback.direction')
+     * Taro.canIUse('request.object.method.GET')
+     * Taro.canIUse('live-player')
+     * Taro.canIUse('text.selectable')
+     * Taro.canIUse('button.open-type.contact')
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/wx.canIUse.html
      */
-    schema: string
-  ): boolean
+    canIUse(
+      /**
+       * 使用 `${API}.${method}.${param}.${option}` 或者 `${component}.${attribute}.${option}` 方式来调用
+       *
+       * **参数说明**
+       *
+       * - `${API}` 代表 API 名字
+       * - `${method}` 代表调用方式，有效值为return, success, object, callback
+       * - `${param}` 代表参数或者返回值
+       * - `${option}` 代表参数的可选值或者返回值的属性
+       * - `${component}` 代表组件名字
+       * - `${attribute}` 代表组件属性
+       * - `${option}` 代表组件属性的可选值
+       */
+      schema: string
+    ): boolean
 
-  /**
-   * 将 Base64 字符串转成 ArrayBuffer 数据。
-   * @supported weapp, h5
-   * @example
-   * ```tsx
-   * const base64 = 'CxYh'
-   * const arrayBuffer = Taro.base64ToArrayBuffer(base64)
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/wx.base64ToArrayBuffer.html
-   */
-  function base64ToArrayBuffer (
-    /** 要转化成 ArrayBuffer 对象的 Base64 字符串 */
-    base64: string,
-  ): ArrayBuffer
+    /**
+     * 将 Base64 字符串转成 ArrayBuffer 数据。
+     * @supported weapp, h5
+     * @example
+     * ```tsx
+     * const base64 = 'CxYh'
+     * const arrayBuffer = Taro.base64ToArrayBuffer(base64)
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/wx.base64ToArrayBuffer.html
+     */
+    base64ToArrayBuffer (
+      /** 要转化成 ArrayBuffer 对象的 Base64 字符串 */
+      base64: string,
+    ): ArrayBuffer
 
-  /**
-   * 将 ArrayBuffer 数据转成 Base64 字符串。
-   * @supported weapp, h5
-   * @example
-   * ```tsx
-   * const arrayBuffer = new Uint8Array([11, 22, 33])
-   * const base64 = Taro.arrayBufferToBase64(arrayBuffer)
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/wx.arrayBufferToBase64.html
-   */
-  function arrayBufferToBase64 (
-    /** 要转换成 Base64 字符串的 ArrayBuffer 对象 */
-    buffer: ArrayBuffer,
-  ): string
+    /**
+     * 将 ArrayBuffer 数据转成 Base64 字符串。
+     * @supported weapp, h5
+     * @example
+     * ```tsx
+     * const arrayBuffer = new Uint8Array([11, 22, 33])
+     * const base64 = Taro.arrayBufferToBase64(arrayBuffer)
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/wx.arrayBufferToBase64.html
+     */
+    arrayBufferToBase64 (
+      /** 要转换成 Base64 字符串的 ArrayBuffer 对象 */
+      buffer: ArrayBuffer,
+    ): string
 
-  /**
-   * 跳转预加载 API
-   * @param options 预加载的数据
-   * @example
-   * ```tsx
-   * Taro.preload({ key: 'value' })
-   * ```
-   */
-  function preload (options: Record<string, any>)
+    /**
+     * 跳转预加载 API
+     * @param options 预加载的数据
+     * @example
+     * ```tsx
+     * Taro.preload({ key: 'value' })
+     * ```
+     */
+    preload (options: Record<string, any>)
 
-  /**
-   * 跳转预加载 API
-   * @param key 预加载的数据 key
-   * @param value 预加载的数据 value
-   * @example
-   * ```tsx
-   * Taro.preload('key', 'value')
-   * ```
-   */
-  function preload (key: string, value: any)
+    /**
+     * 跳转预加载 API
+     * @param key 预加载的数据 key
+     * @param value 预加载的数据 value
+     * @example
+     * ```tsx
+     * Taro.preload('key', 'value')
+     * ```
+     */
+    preload (key: string, value: any)
 
-  /**
-   * 预加载的数据
-   */
-  const preloadData: Record<string, any>
+    /**
+     * 预加载的数据
+     */
+    preloadData: Record<string, any>
+  }
 }