@tarojs/taro 3.7.0-alpha.2 → 3.7.0-alpha.20

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

@@ -15,6 +15,42 @@ declare module '../../index' {
       response: string
     }
   }
+  namespace tradePay  {
+    interface Option {
+      /** 接入小程序支付时传入此参数。此参数为支付宝交易号，注意参数有大小写区分（调用 小程序支付 时必填） */
+      tradeNO?: string
+      /** 完整的支付参数拼接成的字符串，从服务端获取（调用 支付宝预授权 时必填） */
+      orderStr?: string
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?:(res: TaroGeneral.CallbackResult) => void
+    }
+    interface ResultCode {
+      /** 无权限调用（N22104） */
+      4
+      /** 订单处理成功 */
+      9000
+      /** 正在处理中。支付结果未知（有可能已经支付成功） */
+      8000
+      /** 订单处理失败 */
+      4000
+      /** 用户中途取消 */
+      6001
+      /** 网络连接出错 */
+      6002
+      /** 处理结果未知（有可能已经成功） */
+      6004
+    }
+    interface SuccessCallbackResult {
+      /** success 回调函数会携带一个 Object 类型的对象，其属性如下： */
+      response: {
+        resultCode: ResultCode
+      }
+    }
+  }
   interface TaroStatic {
     /**
      * 此接口可获取支付宝会员的基础信息（头像图片地址、昵称、性别、国家码、省份、所在市区），接入方法请参考 获取会员基础信息介绍。如需获取支付宝会员标识（user_id），请调用 my.getAuthCode 和 alipay.system.oauth.token 接口。
@@ -22,5 +58,12 @@ declare module '../../index' {
      * @see https://docs.alipay.com/mini/api/ch8chh
      */
     getOpenUserInfo(Option: getOpenUserInfo.Option): Promise<getOpenUserInfo.SuccessCallbackResult>
+
+    /**
+     * 此接口是用于发起支付的 API，此 API 暂仅支持企业支付宝小程序使用
+     * @supported alipay
+     * @see https://opendocs.alipay.com/mini/api/openapi-pay
+     */
+    tradePay(Option: tradePay.Option): Promise<tradePay.SuccessCallbackResult>
   }
 }

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

@@ -26,7 +26,7 @@ declare module '../../index' {
      * @supported weapp
      * @example
      * ```tsx
-     * Taro.getRandomValues({
+     * Taro.getUserCryptoManager().getRandomValues({
      *   length: 6 // 生成 6 个字节长度的随机数,
      *   success: res => {
      *     console.log(Taro.arrayBufferToBase64(res.randomValues)) // 转换为 base64 字符串后打印
@@ -35,14 +35,14 @@ declare module '../../index' {
      * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/crypto/UserCryptoManager.getRandomValues.html
      */
-    getRandomValues(option: UserCryptoManager.getRandomValues.Option): Promise<UserCryptoManager.getRandomValues.SuccessCallbackResult>
+    getRandomValues(option: UserCryptoManager.getRandomValues.Option): void
   }
 
   namespace UserCryptoManager {
     namespace getLatestUserKey {
       interface Option {
         /** 接口调用成功的回调函数 */
-        success?: (res: TaroGeneral.CallbackResult) => void
+        success?: (res: SuccessCallbackResult) => void
         /** 接口调用失败的回调函数 */
         fail?: (res: TaroGeneral.CallbackResult) => void
         /** 接口调用结束的回调函数（调用成功、失败都会执行） */
@@ -66,7 +66,7 @@ declare module '../../index' {
         /** 整数，生成随机数的字节数，最大 1048576 */
         length: number
         /** 接口调用成功的回调函数 */
-        success?: (res: TaroGeneral.CallbackResult) => void
+        success?: (res: SuccessCallbackResult) => void
         /** 接口调用失败的回调函数 */
         fail?: (res: TaroGeneral.CallbackResult) => void
         /** 接口调用结束的回调函数（调用成功、失败都会执行） */
@@ -86,5 +86,19 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/crypto/wx.getUserCryptoManager.html
      */
     getUserCryptoManager(): UserCryptoManager
+
+    /** 获取密码学安全随机数
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.getRandomValues({
+     *   length: 6 // 生成 6 个字节长度的随机数
+     * }).then(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>
   }
 }

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

@@ -3,7 +3,7 @@ import Taro from '../../index'
 declare module '../../index' {
   interface TaroStatic {
     /** 判断小程序的 API，回调，参数，组件等是否在当前版本可用。
-     * @supported weapp, tt
+     * @supported weapp, tt, h5
      * @example
      * ```tsx
      * Taro.canIUse('openBluetoothAdapter')
@@ -36,7 +36,7 @@ declare module '../../index' {
     ): boolean
 
     /** 判断能否使用 WebP 格式
-     * 
+     *
      * > 在小程序平台中仅在 android 和 devtools 设备时可用
      * @supported global
      */

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

@@ -32,7 +32,7 @@ declare module '../../index' {
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/Performance.createObserver.html
      */
-    createObserver(callback: Function): PerformanceObserver
+    createObserver(callback: TaroGeneral.TFunc): PerformanceObserver
     /** 该方法返回当前缓冲区中的所有性能数据
      * @supported weapp, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/Performance.getEntries.html
@@ -155,6 +155,52 @@ declare module '../../index' {
     }
   }
 
+  namespace preloadWebview {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace preloadSkylineView {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace preloadAssets {
+    interface AssetsObjectType {
+      /** 字体 */
+      font
+      /** 图片 */
+      image
+    }
+    interface AssetsObject {
+      /** 类型 */
+      type: keyof AssetsObjectType
+      /** 资源地址 */
+      src: string
+    }
+    interface Option {
+      data: AssetsObjectType[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
   interface TaroStatic {
     /** 小程序测速上报。使用前，需要在小程序管理后台配置。 详情参见[小程序测速](https://developers.weixin.qq.com/miniprogram/dev/framework/performanceReport/index.html)指南。
      * @supported weapp
@@ -174,8 +220,25 @@ declare module '../../index' {
       dimensions?: string | string[],
     ): void
 
+    /** 预加载下个页面的 WebView
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/wx.preloadWebview.html
+     */
+    preloadWebview(option: preloadWebview.Option): Promise<TaroGeneral.CallbackResult>
+
+    /**预加载下个页面所需要的 Skyline 运行环境
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/wx.preloadSkylineView.html
+     */
+    preloadSkylineView(option: preloadSkylineView.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 为视图层预加载媒体资源文件, 目前支持：font，image
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/wx.preloadAssets.html
+     */
+    preloadAssets(option: preloadAssets.Option): Promise<TaroGeneral.CallbackResult>
     /** 小程序测速上报。使用前，需要在小程序管理后台配置。 详情参见[小程序测速](https://developers.weixin.qq.com/miniprogram/dev/framework/performanceReport/index.html)指南。
-     * 
+     *
      * **注意**
      *  - 目前，当开启代码 [按需注入](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/lazyload.html) `时，evaluateScript` 将仅包含公有部分代码，页面和组件的代码注入的时间会包含在 `firstRender` 中（因为页面和组件的代码注入过程成为了首次渲染过程的一部分）。因此开启按需注入后，脚本耗时降低，渲染时间提高属于正常现象，优化效果可以关注整体启动耗时（`appLaunch`）来评估。
      *  - `firstPaint` 和 `firstContentfulPaint` 指标在开启 `vconsole` 的情况下，由于绘制 `vconsoel` 的面板，会导致数据提前。

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

@@ -351,6 +351,50 @@ declare module '../../index' {
     }
   }
 
+  namespace getSkylineInfoSync {
+    interface Result {
+      /** 当前运行环境是否支持 Skyline 渲染引擎 */
+      isSupported: boolean
+      /** 当前运行环境 Skyline 渲染引擎 的版本号，形如 0.9.7 */
+      version: string
+      /** 当前运行环境不支持 Skyline 渲染引擎 的原因，仅在 isSupported 为 false 时出现  */
+      reason?: string
+    }
+  }
+
+  namespace getSkylineInfo {
+    interface Option {
+      /** 接口调用成功的回调函数 */
+      success?: (res: Result) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult | Result) => void
+    }
+    interface Result {
+      /** 当前运行环境是否支持 Skyline 渲染引擎 */
+      isSupported: boolean
+      /** 当前运行环境 Skyline 渲染引擎 的版本号，形如 0.9.7 */
+      version: string
+      /** 当前运行环境不支持 Skyline 渲染引擎 的原因，仅在 isSupported 为 false 时出现  */
+      reason?: string
+    }
+  }
+
+  namespace getRendererUserAgent {
+    interface Option {
+      /** 接口调用成功的回调函数 */
+      success?: (res: Result) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult | Result) => void
+    }
+    interface Result {
+      userAgent: string
+    }
+  }
+
   namespace getDeviceInfo {
     interface Result {
       /** 应用二进制接口类型（仅 Android 支持） */
@@ -575,6 +619,27 @@ declare module '../../index' {
      */
     getSystemInfo(res?: getSystemInfo.Option): Promise<getSystemInfo.Result>
 
+    /** 获取当前运行环境对于 Skyline 渲染引擎 的支持情况
+     *  基础库 2.26.2 开始支持
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getSkylineInfoSync.html
+     */
+    getSkylineInfoSync(): getSkylineInfoSync.Result
+
+    /** 获取当前运行环境对于 Skyline 渲染引擎 的支持情况
+     *  基础库 2.26.2 开始支持
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getSkylineInfo.html
+     */
+    getSkylineInfo(option?: getSkylineInfo.Option): Promise<getSkylineInfo.Result>
+
+    /** 获取 Webview 小程序的 UserAgent
+     *  基础库 2.26.3 开始支持
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getRendererUserAgent.html
+     */
+    getRendererUserAgent(option?: getRendererUserAgent.Option): Promise<getRendererUserAgent.Result>
+
     /** 获取设备基础信息
      * @supported weapp, h5
      * @h5 不支持 abi、benchmarkLevel

package/types/api/base/weapp/app-event.d.ts

@@ -18,7 +18,7 @@ declare module '../../../index' {
     /** 小程序错误事件的回调函数 */
     type Callback = (
       /** 错误信息，包含堆栈 */
-      error: string,
+      error: string | ErrorEvent | Error,
     ) => void
   }
 
@@ -113,13 +113,13 @@ declare module '../../../index' {
      *
      * **注意**
      *  - 所有的 unhandledRejection 都可以被这一监听捕获，但只有 Error 类型的才会在小程序后台触发报警。
-     * @supported weapp, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onUnhandledRejection.html
      */
     onUnhandledRejection<T = any>(callback: onUnhandledRejection.Callback<T>): void
 
     /** 监听系统主题改变事件。该事件与 [`App.onThemeChange`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onThemeChange-Object-object) 的回调时机一致。
-     * @supported weapp
+     * @supported weapp, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onThemeChange.html
      */
     onThemeChange(callback: onThemeChange.Callback): void
@@ -131,13 +131,13 @@ declare module '../../../index' {
      * - 开发者可以在回调中进行页面重定向，但必须在回调中**同步**处理，异步处理（例如 `setTimeout` 异步执行）无效。
      * - 若开发者没有调用 [Taro.onPageNotFound](/docs/apis/base/weapp/app-event/onPageNotFound) 绑定监听，也没有声明 `App.onPageNotFound`，当跳转页面不存在时，将推入微信客户端原生的页面不存在提示页面。
      * - 如果回调中又重定向到另一个不存在的页面，将推入微信客户端原生的页面不存在提示页面，并且不再第二次回调。
-     * @supported weapp, h5, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onPageNotFound.html
      */
     onPageNotFound(callback: onPageNotFound.Callback): void
 
     /** 监听小程序错误事件。如脚本错误或 API 调用报错等。该事件与 [`App.onError`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onerrorstring-error) 的回调时机与参数一致。
-     * @supported weapp, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onError.html
      */
     onError(callback: onError.Callback): void
@@ -178,16 +178,16 @@ declare module '../../../index' {
      * **注意**
      *
      * 部分版本在无`referrerInfo`的时候会返回 `undefined`，建议使用 `options.referrerInfo && options.referrerInfo.appId` 进行判断。
-     * @supported weapp, h5, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onAppShow.html
      */
     onAppShow(
       /** 小程序切前台事件的回调函数 */
-      callback: (result: onAppShow.CallbackResult) => void,
+      callback: (res: onAppShow.CallbackResult) => void,
     ): void
 
     /** 监听小程序切后台事件。该事件与 [`App.onHide`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onhide) 的回调时机一致。
-     * @supported weapp, h5, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onAppHide.html
      */
     onAppHide(
@@ -196,34 +196,34 @@ declare module '../../../index' {
     ): void
 
     /** 取消监听未处理的 Promise 拒绝事件
-     * @supported weapp, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offUnhandledRejection.html
      */
     offUnhandledRejection<T = any>(callback: onUnhandledRejection.Callback<T>): void
 
     /** 取消监听系统主题改变事件
-     * @supported weapp
+     * @supported weapp, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offThemeChange.html
      */
     offThemeChange(callback: onThemeChange.Callback): void
 
     /** 取消监听小程序要打开的页面不存在事件
-     * @supported weapp, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offPageNotFound.html
      */
     offPageNotFound(
       /** 小程序要打开的页面不存在事件的回调函数 */
-      callback: (res: onPageNotFound.Callback) => void,
+      callback: onPageNotFound.Callback,
     ): void
 
     /** 取消监听音频播放错误事件
-     * @supported weapp, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/InnerAudioContext.offError.html
      */
 
     offError(
       /** 音频播放错误事件的回调函数 */
-      callback: (res: onError.Callback) => void,
+      callback: onError.Callback,
     ): void
 
     /** 取消监听音频中断结束事件
@@ -245,21 +245,21 @@ declare module '../../../index' {
     ): void
 
     /** 取消监听小程序切前台事件
-     * @supported weapp, h5, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offAppShow.html
      */
     offAppShow(
       /** 小程序切前台事件的回调函数 */
-      callback: (res: TaroGeneral.CallbackResult) => void,
+      callback: (res: onAppShow.CallbackResult) => void,
     ): void
 
     /** 取消监听小程序切后台事件
-     * @supported weapp, h5, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offAppHide.html
      */
     offAppHide(
       /** 小程序切后台事件的回调函数 */
-      callback: (res: TaroGeneral.CallbackResult) => void,
+      callback: (res: onAppShow.CallbackResult) => void,
     ): void
   }
 }