@tarojs/taro 3.5.7 → 3.5.9

package/package.json

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

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

@@ -3,12 +3,20 @@ import Taro from '../../index'
 declare module '../../index' {
   namespace createRewardedVideoAd {
     interface Option {
-      /** 广告单元 id */
+      /** 小程序广告位 ID
+       * @supported weapp, tt, swan
+       */
       adUnitId: string
       /** 是否启用多例模式
        * @default false
+       * @supported weapp
        */
       multiton?: boolean
+      /** 小程序应用 ID
+       * @supported swan
+       * @swan 必填
+       */
+      appSid?: string
     }
   }
 
@@ -186,7 +194,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 创建激励视频广告组件。
-     * @supported weapp
+     * @supported weapp, tt, swan
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ad/wx.createRewardedVideoAd.html
      */
     createRewardedVideoAd (option: createRewardedVideoAd.Option): RewardedVideoAd

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

@@ -1,12 +1,26 @@
 import Taro from '../../index'
 
 declare module '../../index' {
+  namespace getOpenUserInfo  {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?:(res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult {
+      /** 返回一个 Object 类型的对象 res。使用 JSON.parse(res.response).response 解析 */
+      response: string
+    }
+  }
   interface TaroStatic {
     /**
      * 此接口可获取支付宝会员的基础信息（头像图片地址、昵称、性别、国家码、省份、所在市区），接入方法请参考 获取会员基础信息介绍。如需获取支付宝会员标识（user_id），请调用 my.getAuthCode 和 alipay.system.oauth.token 接口。
      * @supported alipay
      * @see https://docs.alipay.com/mini/api/ch8chh
      */
-    getOpenUserInfo(): Promise<string>
+    getOpenUserInfo(Option: getOpenUserInfo.Option): Promise<getOpenUserInfo.SuccessCallbackResult>
   }
 }

package/types/api/device/contact.d.ts

@@ -100,7 +100,7 @@ declare module '../../index' {
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/contact/wx.chooseContact.html
      */
-    chooseContact(option: chooseContact.Option): Promise<TaroGeneral.CallbackResult>
+    chooseContact(option: chooseContact.Option): Promise<chooseContact.SuccessCallbackResult>
     /** 添加手机通讯录联系人。用户可以选择将该表单以「新增联系人」或「添加到已有联系人」的方式，写入手机系统通讯录。
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/contact/wx.addPhoneContact.html

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

@@ -62,7 +62,8 @@ declare module '../../index' {
       /** 实际设置的缩放级别。由于系统限制，某些机型可能无法设置成指定值，会改用最接近的可设值。 */
       zoom: number
       /**
-       * @supported alipay on android
+       * @supported alipay
+       * @alipay on android
        */
       setZoom:number
     }
@@ -86,19 +87,19 @@ declare module '../../index' {
       /** 视频的文件的临时路径 */
       tempVideoPath: string
       /** 视频文件的高度。
-       * @supported alipay 
+       * @supported alipay
        */
       height: string
        /** 视频文件的宽度。
-       * @supported alipay 
+       * @supported alipay
        */
       width: string
        /** 视频文件的尺寸。
-       * @supported alipay 
+       * @supported alipay
        */
       size: string
        /** 录制的持续时间。
-       * @supported alipay 
+       * @supported alipay
        */
       duration: string
     }
@@ -198,7 +199,6 @@ declare module '../../index' {
      * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/wx.createCameraContext.html
      */
-    createCameraContext(): CameraContext
-    createCameraContext(id: string): CameraContext
+    createCameraContext(id?: string): CameraContext
   }
 }

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

@@ -170,6 +170,8 @@ declare module '../../index' {
     interface InsertImageOption {
       /** 图片地址，仅支持 http(s)、base64、云图片(2.8.0)、临时文件(2.8.3)。 */
       src: string
+      /** 插入图片后是否自动换行，默认换行 */
+      nowrap?: boolean
       /** 图像无法显示时的替代文本 */
       alt?: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */

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

@@ -9,10 +9,14 @@ declare module '../../index' {
       path?: string
       /** 需要传递给目标小程序的数据，目标小程序可在 `App.onLaunch`，`App.onShow` 中获取到这份数据。如果跳转的是小游戏，可以在 [Taro.onShow](#)、[Taro.getLaunchOptionsSync](/docs/apis/base/weapp/life-cycle/getLaunchOptionsSync) 中可以获取到这份数据数据。 */
       extraData?: TaroGeneral.IAnyObject
-      /** 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版，则打开的小程序必定是正式版。*/
+      /** 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版，则打开的小程序必定是正式版。 */
       envVersion?: keyof EnvVersion
       /** 小程序链接，当传递该参数后，可以不传 appId 和 path。链接可以通过【小程序菜单】->【复制链接】获取。 */
       shortLink?: string
+      /** 校验方式 。默认为binding */
+      verify?: keyof Verify
+      /** 不 reLaunch 目标小程序，直接打开目标跳转的小程序退后台时的页面，需满足以下条件：1. 目标跳转的小程序生命周期未被销毁；2. 且目标当次启动的path、query、apiCategory与上次启动相同。默认值为 false 。 */
+      noRelaunchIfPathUnchanged?: boolean
       /** 接口调用成功的回调函数 */
       success?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
@@ -21,6 +25,13 @@ declare module '../../index' {
       complete?: (res: TaroGeneral.CallbackResult) => void
     }
 
+    interface Verify {
+      /** 校验小程序管理后台的绑定关系 */
+      binding
+      /** 校验目标打开链接是否为小程序联盟商品。 */
+      unionProduct
+    }
+
     interface EnvVersion {
       /** 开发版 */
       develop
@@ -39,7 +50,7 @@ declare module '../../index' {
       path?: string
       /** 需要传递给目标小程序的数据，目标小程序可在 `App.onLaunch`，`App.onShow` 中获取到这份数据。如果跳转的是小游戏，可以在 [Taro.onShow](#)、[Taro.getLaunchOptionsSync](/docs/apis/base/weapp/life-cycle/getLaunchOptionsSync) 中可以获取到这份数据数据。 */
       extraData?: TaroGeneral.IAnyObject
-      /** 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版，则打开的小程序必定是正式版。*/
+      /** 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版，则打开的小程序必定是正式版。 */
       envVersion?: keyof EnvVersion
       /** 小程序链接，当传递该参数后，可以不传 appId 和 path。链接可以通过【小程序菜单】->【复制链接】获取。 */
       shortLink?: string

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

@@ -9,6 +9,8 @@ declare module '../../index' {
       filePath?: string
       /** HTTP 请求的 Header，Header 中不能设置 Referer */
       header?: TaroGeneral.IAnyObject
+      /** 超时时间，单位为毫秒 */
+      timeout?: number
       /** 是否应使用传出凭据 (cookie) 发送此请求
        * @default true
        * @supported h5

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

@@ -505,7 +505,7 @@ declare module '../../index' {
      * ```tsx
      * const observer = Taro.createIntersectionObserver(this, { thresholds: [0], observeAll: true })
      * ```
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/wxml/wx.createSelectorQuery.html
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/wxml/wx.createIntersectionObserver.html
      */
     createIntersectionObserver(
       /** 自定义组件实例 */

package/types/taro.config.d.ts

@@ -20,6 +20,12 @@ declare module './index' {
      * - custom 自定义导航栏
      */
     navigationStyle?: 'default' | 'custom'
+    /**
+     * 在非首页、非页面栈最底层页面或非 tabbar 内页面中的导航栏展示 home 键
+     * @default false
+     * @supported weapp
+     */
+    homeButton?: boolean
     /** 窗口的背景色， HexColor
      * @default: "#ffffff"
      */
@@ -44,11 +50,11 @@ declare module './index' {
      * @default: 50
      */
     onReachBottomDistance?: number
-    /** 屏幕旋转设置
+    /** 屏幕旋转设置，支持 auto / portrait / landscape
      * @see https://developers.weixin.qq.com/miniprogram/dev/framework/view/resizable.html
      */
     pageOrientation?: 'auto' | 'portrait' | 'landscape'
-    /** 页面初始渲染缓存配置，支持 static / dynamic */
+    /** 页面[初始渲染缓存](https://developers.weixin.qq.com/miniprogram/dev/framework/view/initial-rendering-cache.html)配置，支持 static / dynamic */
     initialRenderingCache?: 'static' | 'dynamic'
     /** 重新启动策略配置
      * - homePage: 如果从这个页面退出小程序，下次将从首页冷启动
@@ -56,6 +62,90 @@ declare module './index' {
      * @default "homePage"
      */
     restartStrategy?: 'homePage' | 'homePageAndLatestPage'
+    /**
+     * 切入系统后台时，隐藏页面内容，保护用户隐私。支持 hidden / none
+     * @default "none"
+     */
+    visualEffectInBackground?: 'hidden' | 'none'
+    /**
+     * 控制[预加载下个页面的时机](https://developers.weixin.qq.com/miniprogram/dev/framework/performance/tips/runtime_nav.html#_2-4-%E6%8E%A7%E5%88%B6%E9%A2%84%E5%8A%A0%E8%BD%BD%E4%B8%8B%E4%B8%AA%E9%A1%B5%E9%9D%A2%E7%9A%84%E6%97%B6%E6%9C%BA)。
+     * 支持 static / manual / auto
+     */
+    handleWebviewPreload?: string
+    /** 是否允许向下拉拽。
+     * @default: "YES"
+     * @supported alipay
+     */
+    allowsBounceVertical?: 'YES' | 'NO'
+    /**
+     * 下拉露出显示背景图的底色。例：白色 "#FFFFFF"。**仅安卓下有效，iOS 下页面背景图底色会使用 backgroundColor 的值**
+     * @supported alipay
+     * @type {HexColor}
+     */
+    backgroundImageColor?: string
+    /**
+     * 下拉露出显示背景图的链接
+     * @supported alipay
+     */
+    backgroundImageUrl?: string
+    /**
+     * 页面默认标题
+     * @supported alipay
+     */
+    defaultTitle?: string
+    /**
+     * 仅支持 Android，是否显示 WebView 滚动条。默认 YES，支持 YES / NO。
+     * @default "YES"
+     * @supported alipay
+     */
+    enableScrollBar?: string
+    /**
+     * 仅支持 iOS，是否支持手势返回。默认 YES，支持 YES / NO。
+     * @supported alipay
+     */
+    gestureBack?: string
+    /** 是否允许下拉刷新
+     * @desc
+     * 1. 下拉刷新生效的前提是 allowsBounceVertical 值为 true
+     * 2. window 全局配置后全局生效，但是如果单个页面配置了该参数，以页面的配置为准。
+     * @default true
+     * @supported alipay
+     */
+    pullRefresh?: boolean
+    /**
+     * rpx 单位是否宽度自适应 ，默认 true，当设置为 false 时，2 rpx 将恒等于 1 px，不再根据屏幕宽度进行自适应，注意，此时 750 rpx 将不再等于 100% 宽度。
+     * @supported alipay
+     */
+    responsive?: boolean
+    /**
+     * 	是否进入时显示导航栏的 loading。默认 NO，支持 YES / NO。
+     * @default "NO"
+     * @supported alipay
+     */
+    showTitleLoading?: string
+    /**
+     * 导航栏透明设置。默认 none，支持 always 一直透明 / auto 滑动自适应 / none 不透明。
+     * @default "none"
+     * @supported alipay
+     */
+    transparentTitle?: string
+    /**
+     * 是否允许导航栏点击穿透。默认 NO，支持 YES / NO。
+     * @default "NO"
+     * @supported alipay
+     */
+    titlePenetrate?: string
+    /**
+     * 导航栏图片地址。
+     * @supported alipay
+     */
+    titleImage?: string
+    /**
+     * 导航栏背景色。例：白色 "#FFFFFF"。
+     * @supported alipay
+     * @type {HexColor}
+     */
+    titleBarColor?: string
   }
 
   interface PageConfig extends CommonConfig {
@@ -91,24 +181,51 @@ declare module './index' {
     style?: string
     /** 单页模式相关配置 */
     singlePage?: SinglePage
-  }
-
-  interface WindowConfig extends CommonConfig {
-    /** 切入系统后台时，隐藏页面内容，保护用户隐私。支持 hidden / none
-     * @default none
+    /**
+     * 事件监听是否为 passive
+     * @default false
+     * @see https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#enablePassiveEvent
+     */
+    enablePassiveEvent?:
+      | boolean
+      | {
+          /**
+           * 是否设置 touchstart 事件为 passive
+           * @default false
+           */
+          touchstart?: boolean
+          /**
+           * 是否设置 touchmove 事件为 passive
+           * @default false
+           */
+          touchmove?: boolean
+          /**
+           * 是否设置 wheel 事件为 passive
+           * @default false
+           */
+          wheel?: boolean
+        }
+    /**
+     * 渲染后端
+     * @default "webview"
      */
-    visualEffectInBackground?: 'hidden' | 'none'
-    /** 是否允许下拉刷新
-     * 备注：下拉刷新生效的前提是 allowsBounceVertical 值为 YES
-     * @default: "NO"
+    renderer?: 'webview' | 'skyline'
+    /**
+     * 设置导航栏额外图标，目前支持设置属性 icon，值为图标 url（以 https/http 开头）或 base64 字符串，大小建议 30*30 px
+     *
+     * 点击后触发 onOptionMenuClick（**注意**：该配置即将废弃。）。
+     *  @supported alipay
      */
-    pullRefresh?: 'YES' | 'NO' | boolean
-    /** 是否允许向下拉拽
-     * @default: "YES"
+    optionMenu?: Record<string, string>
+    /**
+     * 设置导航栏图标主题，仅支持真机预览。"default" 为蓝色图标，"light" 为白色图标。
+     * @supported alipay
      */
-    allowsBounceVertical?: 'YES' | 'NO'
+    barButtonTheme?: string
   }
 
+  interface WindowConfig extends CommonConfig {}
+
   interface TabBarItem {
     /** 页面路径，必须在 pages 中先定义 */
     pagePath: string
@@ -283,7 +400,16 @@ declare module './index' {
      * - chooseAddress: 获取用户地址信息
      *  @see https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#requiredPrivateInfos
      */
-    requiredPrivateInfos?: ('getFuzzyLocation' | 'getLocation' | 'onLocationChange' | 'startLocationUpdate' | 'startLocationUpdateBackground' | 'chooseLocation' | 'choosePoi' | 'chooseAddress')[] 
+    requiredPrivateInfos?: (
+      | 'getFuzzyLocation'
+      | 'getLocation'
+      | 'onLocationChange'
+      | 'startLocationUpdate'
+      | 'startLocationUpdateBackground'
+      | 'chooseLocation'
+      | 'choosePoi'
+      | 'chooseAddress'
+    )[]
     /** 使用到的插件
      * @since 1.9.6
      */
@@ -377,15 +503,32 @@ declare module './index' {
       /** 是否开启 FPS 面板，默认false */
       enableFPSPanel?: boolean
     }
-    /** touch 事件监听是否为 passive，默认false */
-    enablePassiveEvent?: boolean | {
-      /** 是否设置 touchstart 事件为 passive，默认false */
-      touchstart?: boolean
-      /** 是否设置 touchmove 事件为 passive，默认false */
-      touchmove?: boolean
-      /** 是否设置 wheel 事件为 passive，默认false */
-      wheel?: boolean
-    }
+    /**
+     * touch 相关事件默认的 passive 为 false。如果小程序不使用 catchtouch 事件时，可以通过这个选项将 passive 置为 true，以提高滚动性能。
+     * 具体原理可参考[MDN](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#improving_scrolling_performance_with_passive_listeners)
+     *
+     * 可以直接设置这个选项为 true，也可以分别控制某个事件。
+     * @default false
+     */
+    enablePassiveEvent?:
+      | boolean
+      | {
+          /**
+           * 是否设置 touchstart 事件为 passive
+           * @default false
+           */
+          touchstart?: boolean
+          /**
+           * 是否设置 touchmove 事件为 passive
+           * @default false
+           */
+          touchmove?: boolean
+          /**
+           * 是否设置 wheel 事件为 passive
+           * @default false
+           */
+          wheel?: boolean
+        }
     /** 自定义模块映射规则 */
     resolveAlias?: Record<string, string>
     /** 接受一个数组，每一项都是字符串，来指定编译为原生小程序组件的组件入口 */
@@ -400,6 +543,11 @@ declare module './index' {
      * @since 3.3.18
      */
     animation?: RouterAnimate | boolean
+    /**
+     * 指定小程序全局的默认渲染后端。
+     * @default "webview"
+     */
+    renderer?: 'webview' | 'skyline'
   }
 
   interface Config extends PageConfig, AppConfig {
@@ -422,4 +570,3 @@ declare module './index' {
     Config: Config
   }
 }
-

package/types/taro.hooks.d.ts

@@ -83,6 +83,12 @@ declare module './index' {
      */
     useError(callback: (error: string) => void): void
 
+    /**
+     * 小程序有未处理的 Promise reject 时触发。也可以使用 Taro.onUnhandledRejection 绑定监听。
+     * @supported weapp, alipay
+     */
+     useUnhandledRejection(callback: (error: { reason: Error, promise: Promise<Error> }) => void): void
+
     /**
      * 小程序要打开的页面不存在时触发的回调。
      * @supported weapp, h5