@tarojs/taro 3.5.0-canary.1 → 3.5.0

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

@@ -16,7 +16,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 拨打电话
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * Taro.makePhoneCall({

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

@@ -85,7 +85,7 @@ declare module '../../index' {
   interface TaroStatic {
     /**
      * 调起客户端扫码界面，扫码成功后返回对应的结果
-     * @supported weapp, h5
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * // 允许从相机和相册扫码

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

@@ -1,6 +1,21 @@
 import Taro from '../../index'
 
 declare module '../../index' {
+  namespace setVisualEffectOnCapture {
+    interface Option {
+      /** 截屏/录屏时的表现，仅支持 none / hidden，传入 hidden 则表示在截屏/录屏时隐藏屏幕
+       * @default "none"
+       */
+      visualEffect?: 'none' | 'hidden'
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
   namespace setScreenBrightness {
     interface Option {
       /** 屏幕亮度值，范围 0 ~ 1。0 最暗，1 最亮 */
@@ -31,6 +46,13 @@ declare module '../../index' {
     }
   }
 
+  namespace onUserCaptureScreen {
+    /** 用户主动截屏事件的回调函数 */
+    type Callback = (
+        result: TaroGeneral.CallbackResult,
+    ) => void
+  }
+
   namespace getScreenBrightness {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
@@ -48,8 +70,14 @@ declare module '../../index' {
   }
 
   interface TaroStatic {
+    /** 设置截屏/录屏时屏幕表现，仅支持在 Android 端调用
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.setVisualEffectOnCapture.html
+     */
+    setVisualEffectOnCapture(option: setVisualEffectOnCapture.Option): Promise<TaroGeneral.CallbackResult>
+
     /** 设置屏幕亮度。
-     * @supported weapp, rn
+     * @supported weapp, rn, tt
      * @example
      * ```tsx
      * Taro.setScreenBrightness(params).then(...)
@@ -60,7 +88,7 @@ declare module '../../index' {
 
     /**
      * 设置是否保持常亮状态。仅在当前小程序生效，离开小程序后设置失效。
-     * @supported weapp
+     * @supported weapp, rn, tt
      * @example
      * ```tsx
      * // 保持屏幕常亮
@@ -74,7 +102,7 @@ declare module '../../index' {
 
     /**
      * 监听用户主动截屏事件，用户使用系统截屏按键截屏时触发此事件
-     * @supported weapp
+     * @supported weapp, tt
      * @example
      * ```tsx
      * Taro.onUserCaptureScreen(function (res) {
@@ -85,7 +113,16 @@ declare module '../../index' {
      */
     onUserCaptureScreen(
       /** 用户主动截屏事件的回调函数 */
-      callback: (res: TaroGeneral.CallbackResult) => void,
+      callback: onUserCaptureScreen.Callback,
+    ): void
+
+    /** 用户主动截屏事件。取消事件监听。
+     * @supported weapp, tt
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.offUserCaptureScreen.html
+     */
+    offUserCaptureScreen(
+      /** 用户主动截屏事件的回调函数 */
+      callback: onUserCaptureScreen.Callback,
     ): void
 
     /**
@@ -93,20 +130,11 @@ declare module '../../index' {
      *
      * **说明**
      * - 若安卓系统设置中开启了自动调节亮度功能，则屏幕亮度会根据光线自动调整，该接口仅能获取自动调节亮度之前的值，而非实时的亮度值。
-     * @supported weapp
+     * @supported weapp, rn, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.getScreenBrightness.html
      */
     getScreenBrightness(
       option?: getScreenBrightness.Option
     ): Promise<getScreenBrightness.SuccessCallbackOption>
-
-    /** 用户主动截屏事件。取消事件监听。
-     * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.offUserCaptureScreen.html
-     */
-    offUserCaptureScreen(
-      /** 用户主动截屏事件的回调函数 */
-      callback: (...args: any[]) => any,
-    ): void
   }
 }

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

@@ -3,6 +3,8 @@ import Taro from '../../index'
 declare module '../../index' {
   namespace vibrateShort {
     interface Option {
+      /** 震动强度类型，有效值为：heavy、medium、light */
+      type: 'heavy' | 'medium' | 'light'
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
@@ -25,7 +27,9 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 使手机发生较短时间的振动（15 ms）。仅在 iPhone `7 / 7 Plus` 以上及 Android 机型生效
-     * @supported weapp, h5, rn
+     * @h5 不支持 type 参数
+     * @rn 不支持 type 参数
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * Taro.vibrateShort(params).then(...)
@@ -35,7 +39,7 @@ declare module '../../index' {
     vibrateShort(option?: vibrateShort.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 使手机发生较长时间的振动（400ms）
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * Taro.vibrateLong(params).then(...)

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

@@ -46,6 +46,17 @@ declare module '../../index' {
     }
   }
 
+  namespace onWifiConnectedWithPartialInfo {
+    /** 连接上 Wi-Fi 的事件的回调函数 */
+    type Callback = (
+        result: CallbackResult,
+    ) => void
+    interface CallbackResult {
+      /** 只包含 SSID 属性的 WifiInfo 对象 */
+      wifi: Pick<WifiInfo, 'SSID'>
+    }
+  }
+
   namespace onWifiConnected {
     /** 连接上 Wi-Fi 的事件的回调函数 */
     type Callback = (
@@ -111,16 +122,22 @@ declare module '../../index' {
     }
   }
 
-  /** Wifi 信息 */
+  /** Wifi 信息
+   * 
+   * 注意:
+   * 安卓 Taro.connectWifi / Taro.getConnectedWifi 若设置了 partialInfo:true ，或者调用了 Taro.onWifiConnectedWithPartialInfo 事件。将会返回只包含 SSID 属性的 WifiInfo 对象。 在某些情况下，可能 Wi-Fi 已经连接成功，但会因为获取不到完整的 WifiInfo 对象报错。具体错误信息为 errCode: 12010, errMsg: can't gain current wifi 。如果开发者不需要完整的 WifiInfo 对象，则可以通过采取上述策略解决报错问题。
+   */
   interface WifiInfo {
-    /** Wi-Fi 的 BSSID */
-    BSSID: string
     /** Wi-Fi 的 SSID */
     SSID: string
+    /** Wi-Fi 的 BSSID */
+    BSSID: string
     /** Wi-Fi 是否安全 */
     secure: boolean
-    /** Wi-Fi 信号强度 */
+    /** Wi-Fi 信号强度, 安卓取值 0 ～ 100 ，iOS 取值 0 ～ 1 ，值越大强度越大 */
     signalStrength: number
+    /** Wi-Fi 频段单位 MHz */
+    frequency?: number
   }
 
   interface TaroStatic {
@@ -182,6 +199,15 @@ declare module '../../index' {
      */
     setWifiList(option: setWifiList.Option): Promise<TaroGeneral.WifiError>
 
+    /** 监听连接上 Wi-Fi 的事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.onWifiConnectedWithPartialInfo.html
+     */
+    onWifiConnectedWithPartialInfo(
+      /** 连接上 Wi-Fi 的事件的回调函数 */
+      callback: onWifiConnectedWithPartialInfo.Callback,
+    ): void
+
     /** 监听连接上 Wi-Fi 的事件。
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.onWifiConnected.html
@@ -192,7 +218,7 @@ declare module '../../index' {
     ): void
 
     /** 监听获取到 Wi-Fi 列表数据事件
-     * @supported weapp
+     * @supported weapp, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.onGetWifiList.html
      */
     onGetWifiList(
@@ -200,6 +226,15 @@ declare module '../../index' {
       callback: onGetWifiList.Callback,
     ): void
 
+    /** 取消监听连接上 Wi-Fi 的事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.offWifiConnectedWithPartialInfo.html
+     */
+     offWifiConnectedWithPartialInfo(
+      /** 连接上 Wi-Fi 的事件的回调函数 */
+      callback: onWifiConnectedWithPartialInfo.Callback,
+    ): void
+
     /**
      * 取消监听连接上 Wi-Fi 的事件。
      * @supported weapp
@@ -207,23 +242,23 @@ declare module '../../index' {
      */
     offWifiConnected(
       /** 连接上 Wi-Fi 的事件的回调函数 */
-      callback: (...args: any[]) => any,
+      callback: onWifiConnected.Callback,
     ): void
 
     /**
      * 取消监听获取到 Wi-Fi 列表数据事件。
-     * @supported weapp
+     * @supported weapp, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.offGetWifiList.html
      */
     offGetWifiList(
       /** 获取到 Wi-Fi 列表数据事件的回调函数 */
-      callback: (...args: any[]) => any,
+      callback: onGetWifiList.Callback,
     ): void
 
     /** 请求获取 Wi-Fi 列表。在 `onGetWifiList` 注册的回调中返回 `wifiList` 数据。 **Android 调用前需要 [用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.userLocation。**
      *
      * iOS 将跳转到系统的 Wi-Fi 界面，Android 不会跳转。 iOS 11.0 及 iOS 11.1 两个版本因系统问题，该方法失效。但在 iOS 11.2 中已修复。
-     * @supported weapp
+     * @supported weapp, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.getWifiList.html
      */
     getWifiList(option?: getWifiList.Option): Promise<TaroGeneral.WifiError>

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

@@ -31,7 +31,7 @@ declare module '../../index' {
      *
      * **Tips**
      * 1. 本接口暂时无法通过 Taro.canIUse 判断是否兼容，开发者需要自行判断 Taro.getExtConfigSync 是否存在来兼容
-     * @supported weapp
+     * @supported weapp, tt
      * @example
      * ```tsx
      * let extConfig = Taro.getExtConfigSync? Taro.getExtConfigSync(): {}
@@ -46,7 +46,7 @@ declare module '../../index' {
      *
      * **Tips**
      * 1. 本接口暂时无法通过 Taro.canIUse 判断是否兼容，开发者需要自行判断 Taro.getExtConfig 是否存在来兼容
-     * @supported weapp
+     * @supported weapp, tt
      * @example
      * ```tsx
      * if(Taro.getExtConfig) {