@tarojs/taro 3.5.0-canary.1 → 3.5.0

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

@@ -51,14 +51,68 @@ declare module '../../index' {
     }
   }
 
-  namespace hideShareMenu {
+  namespace showShareImageMenu {
     interface Option {
+      /** 要分享的图片地址，必须为本地路径或临时路径 */
+      path: string
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace shareVideoMessage {
+    interface Option {
+      /** 要分享的视频地址，必须为本地路径或临时路径 */
+      videoPath: string
+      /** 缩略图路径，若留空则使用视频首帧 */
+      thumbPath?: string
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace shareFileMessage {
+    interface Option {
+      /** 要分享的视频地址，必须为本地路径或临时路径 */
+      filePath: string
+      /** 自定义文件名，若留空则使用 filePath 中的文件名 */
+      fileName?: string
       /** 接口调用成功的回调函数 */
       success?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+  namespace onCopyUrl {
+    /** 用户点击右上角菜单的「复制链接」按钮时触发的事件的回调函数 */
+    type Callback = (result: CallbackResult) => void
+
+    interface CallbackResult {
+      /** 用短链打开小程序时当前页面携带的查询字符串。小程序中使用时，应在进入页面时调用 `Taro.onCopyUrl` 自定义 `query`，退出页面时调用 `Taro.offCopyUrl`，防止影响其它页面。 */
+      query: string
+    }
+  }
+
+  namespace hideShareMenu {
+    interface Option {
+      /** 本接口为 Beta 版本，暂只在 Android 平台支持。需要隐藏的转发按钮名称列表，默认['shareAppMessage', 'shareTimeline']。按钮名称合法值包含 "shareAppMessage"、"shareTimeline" 两种 */
+      menus?: string[]
+      /** 接口调用成功的回调函数 */
+      success?: (result: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
     }
   }
 
@@ -66,14 +120,38 @@ declare module '../../index' {
     interface Option {
       /** shareTicket */
       shareTicket: string
-      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 超时时间，单位 ms */
+      timeout?: number
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+    }
+
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 敏感数据对应的云 ID，开通[云开发](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/basis/getting-started.html)的小程序才会返回，可通过云调用直接获取开放数据，详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#method-cloud) */
+      cloudID?: string
+      /** 包括敏感数据在内的完整转发信息的加密数据，详细见[加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html) */
+      encryptedData: string
+      /** 错误信息 */
+      errMsg: string
+      /** 加密算法的初始向量，详细见[加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html) */
+      iv: string
+    }
+  }
+
+  namespace authPrivateMessage {
+    interface Option {
+      /** shareTicket */
+      shareTicket: string
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
-      /** 超时时间，单位 ms */
-      timeout?: number
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
     }
 
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
@@ -103,7 +181,7 @@ declare module '../../index' {
     updateShareMenu(option: updateShareMenu.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 显示当前页面的转发按钮
-     * @supported weapp
+     * @supported weapp, qq, tt
      * @example
      * ```tsx
      * Taro.showShareMenu({
@@ -114,8 +192,88 @@ declare module '../../index' {
      */
     showShareMenu(option: showShareMenu.Option): Promise<TaroGeneral.CallbackResult>
 
-    /** 隐藏转发按钮
+    /** 打开分享图片弹窗，可以将图片发送给朋友、收藏或下载
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.downloadFile({
+     *   url: 'https://res.wx.qq.com/wxdoc/dist/assets/img/demo.ef5c5bef.jpg',
+     *   success: (res) => {
+     *     wx.showShareImageMenu({
+     *       path: res.tempFilePath
+     *     })
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.showShareImageMenu.html
+     */
+    showShareImageMenu(option: showShareImageMenu.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 转发视频到聊天
+     * @supported weapp
+     * @example
+     * callback 写法
+     *
+     * ```tsx
+     * Taro.downloadFile({
+     *   url: URL, // 下载url
+     *   success (res) {
+     *     // 下载完成后转发
+     *     Taro.shareVideoMessage({
+     *       videoPath: res.tempFilePath,
+     *       success() {},
+     *       fail: console.error,
+     *     })
+     *   },
+     *   fail: console.error,
+     * })
+     * ```
+     *
+     * async await 写法
+     *
+     * ```tsx
+     * const { tempFilePath } = await Taro.downloadFile({
+     *   url: URL, // 下载url
+     * })
+     * // 下载完成后转发
+     * await Taro.shareVideoMessage({
+     *   videoPath: res.tempFilePath,
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.shareVideoMessage.html
+     */
+    shareVideoMessage(option: shareVideoMessage.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 转发文件到聊天
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.shareFileMessage.html
+     */
+    shareFileMessage(option: shareFileMessage.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 监听用户点击右上角菜单的「复制链接」按钮时触发的事件
+     *
+     * > 本接口为 Beta 版本，暂只在 Android 平台支持。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.onCopyUrl.html
+     */
+    onCopyUrl(
+      /** 用户点击右上角菜单的「复制链接」按钮时触发的事件的回调函数 */
+      callback: onCopyUrl.Callback,
+    ): void
+
+    /** 取消监听用户点击右上角菜单的「复制链接」按钮时触发的事件
+     *
+     * > 本接口为 Beta 版本，暂只在 Android 平台支持。
      * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.offCopyUrl.html
+     */
+    offCopyUrl(
+      /** 用户点击右上角菜单的「复制链接」按钮时触发的事件的回调函数 */
+      callback: onCopyUrl.Callback,
+    ): void
+
+    /** 隐藏当前页面的转发按钮
+     * @supported weapp, tt
      * @example
      * ```tsx
      * Taro.hideShareMenu()
@@ -127,10 +285,10 @@ declare module '../../index' {
     /** 获取转发详细信息
      *
      * **Tips**
-     * - 如需要展示群名称，可以使用[开放数据组件](https://developers.weixin.qq.com/miniprogram/dev/component/open-ability/open-data.html)
+     * - 如需要展示群名称，可以使用[开放数据组件](/docs/components/open/open-data)
      * @supported weapp
      * @example
-     * 敏感数据有两种获取方式，一是使用 [加密数据解密算法]((open-ability/signature#加密数据解密算法)) 。
+     * 敏感数据有两种获取方式，一是使用 [加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) 。
      * 获取得到的开放数据为以下 json 结构（其中 openGId 为当前群的唯一标识）：
      * ```json
      * {
@@ -140,5 +298,30 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.getShareInfo.html
      */
     getShareInfo(option: getShareInfo.Option): Promise<getShareInfo.SuccessCallbackResult>
+
+    /** 验证私密消息
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.authPrivateMessage({
+     *   shareTicket: 'xxxxxx',
+     *   success(res) {
+     *     console.log('authPrivateMessage success', res)
+     *     // res
+     *     // {
+     *     //   errMsg: 'authPrivateMessage:ok'
+     *     //   valid: true
+     *     //   iv: 'xxxx',
+     *     //   encryptedData: 'xxxxxx'
+     *     // }
+     *   },
+     *   fail(res) {
+     *     console.log('authPrivateMessage fail', res)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.authPrivateMessage.html
+     */
+    authPrivateMessage(option: authPrivateMessage.Option): Promise<authPrivateMessage.SuccessCallbackResult>
   }
 }

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

@@ -1,6 +1,18 @@
 import Taro from '../../index'
 
 declare module '../../index' {
+  /** @ignore */
+  type TypedArray =
+    | Int8Array
+    | Uint8Array
+    | Uint8ClampedArray
+    | Int16Array
+    | Uint16Array
+    | Int32Array
+    | Uint32Array
+    | Float32Array
+    | Float64Array
+
   namespace setStorage {
     interface Option {
       /** 需要存储的内容。只支持原生类型、Date、及能够通过`JSON.stringify`序列化的对象。 */
@@ -92,7 +104,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** Taro.setStorage 的同步版本
-     * @supported weapp, h5
+     * @supported weapp, h5, tt
      * @example
      * ```tsx
      * Taro.setStorage({
@@ -116,7 +128,7 @@ declare module '../../index' {
     ): void
 
     /** 将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * Taro.setStorage({
@@ -133,33 +145,19 @@ declare module '../../index' {
      */
     setStorage(option: setStorage.Option): Promise<TaroGeneral.CallbackResult>
 
-    /**
-     * 从本地缓存中同步移除指定 key 。
-     * @supported weapp, h5
-     * @example
-     * ```tsx
-     * try {
-     *   Taro.removeStorageSync('key')
-     * } catch (e) {
-     *   // Do something when catch error
-     * }
-     * ```
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.removeStorageSync.html
+    /** 根据 URL 销毁存在内存中的数据
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.revokeBufferURL.html
      */
-    removeStorageSync(key: string): void
+    revokeBufferURL(
+      /** 需要销毁的二进制数据 URL */
+      url: string
+    ): void
 
     /** Taro.removeStorage 的同步版本
+     * @supported weapp, h5, tt
      * @example
      * ```tsx
-     * Taro.removeStorage({
-     *   key: 'key',
-     *   success: function (res) {
-     *     console.log(res)
-     *   }
-     * })
-     * ```
-     *
-     * ```tsx
      * try {
      *   Taro.removeStorageSync('key')
      * } catch (e) {
@@ -174,7 +172,7 @@ declare module '../../index' {
     ): void
 
     /** 从本地缓存中移除指定 key
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * Taro.removeStorage({
@@ -184,31 +182,14 @@ declare module '../../index' {
      *   }
      * })
      * ```
-     *
-     * ```tsx
-     * try {
-     *   Taro.removeStorageSync('key')
-     * } catch (e) {
-     *   // Do something when catch error
-     * }
-     * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.removeStorage.html
      */
     removeStorage(option: removeStorage.Option): Promise<TaroGeneral.CallbackResult>
 
     /** Taro.getStorage 的同步版本
-     * @supported weapp, h5
+     * @supported weapp, h5, tt
      * @example
      * ```tsx
-     * Taro.getStorage({
-     *   key: 'key',
-     *   success: function (res) {
-     *     console.log(res.data)
-     *   }
-     * })
-     * ```
-     *
-     * ```tsx
      * try {
      *   var value = Taro.getStorageSync('key')
      *   if (value) {
@@ -226,19 +207,9 @@ declare module '../../index' {
     ): T
 
     /** Taro.getStorageInfo 的同步版本
-     * @supported weapp, h5
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
-     * Taro.getStorageInfo({
-     *   success: function (res) {
-     *     console.log(res.keys)
-     *     console.log(res.currentSize)
-     *     console.log(res.limitSize)
-     *   }
-     * })
-     * ```
-     *
-     * ```tsx
      * try {
      *   const res = Taro.getStorageInfoSync()
      *   console.log(res.keys)
@@ -253,7 +224,7 @@ declare module '../../index' {
     getStorageInfoSync(): getStorageInfoSync.Option
 
     /** 异步获取当前storage的相关信息
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * Taro.getStorageInfo({
@@ -264,23 +235,12 @@ declare module '../../index' {
      *   }
      * })
      * ```
-     *
-     * ```tsx
-     * try {
-     *   const res = Taro.getStorageInfoSync()
-     *   console.log(res.keys)
-     *   console.log(res.currentSize)
-     *   console.log(res.limitSize)
-     * } catch (e) {
-     *   // Do something when catch error
-     * }
-     * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.getStorageInfo.html
      */
     getStorageInfo(option?: getStorageInfo.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 从本地缓存中异步获取指定 key 的内容
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * Taro.getStorage({
@@ -290,29 +250,23 @@ declare module '../../index' {
      *   }
      * })
      * ```
-     *
-     * ```tsx
-     * try {
-     *   var value = Taro.getStorageSync('key')
-     *   if (value) {
-     *     // Do something with return value
-     *   }
-     * } catch (e) {
-     *   // Do something when catch error
-     * }
-     * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.getStorage.html
      */
     getStorage<T = any>(option: getStorage.Option<T>): Promise<getStorage.SuccessCallbackResult<T>>
 
+    /** 根据传入的 buffer 创建一个唯一的 URL 存在内存中
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.createBufferURL.html
+     */
+    createBufferURL(
+      /** 需要存入内存的二进制数据 */
+      buffer: ArrayBuffer | TypedArray
+    ): void
+
     /** Taro.clearStorage 的同步版本
-     * @supported weapp, h5
+     * @supported weapp, h5, tt
      * @example
      * ```tsx
-     * Taro.clearStorage()
-     * ```
-     *
-     * ```tsx
      * try {
      *   Taro.clearStorageSync()
      * } catch(e) {
@@ -324,19 +278,11 @@ declare module '../../index' {
     clearStorageSync(): void
 
     /** 清理本地数据缓存
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * Taro.clearStorage()
      * ```
-     *
-     * ```tsx
-     * try {
-     *   Taro.clearStorageSync()
-     * } catch(e) {
-     *   // Do something when catch error
-     * }
-     * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.clearStorage.html
      */
     clearStorage(option?: clearStorage.Option): Promise<TaroGeneral.CallbackResult>

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

@@ -67,7 +67,7 @@ declare module '../../index' {
      *   articleTitle: '晒元宵节活动红包，爱奇艺60张年卡、600张季卡等你拿！',
      *   releaseDate: '2019-01-02 12:01:30',
      *   image: [
-     *       'http://c.hiphotos.baidu.com/forum/w%3D480/sign=73c62dda83b1cb133e693d1bed5456da/f33725109313b07e8dee163d02d7912396dd8cfe.jpg',
+     *       'https://c.hiphotos.baidu.com/forum/w%3D480/sign=73c62dda83b1cb133e693d1bed5456da/f33725109313b07e8dee163d02d7912396dd8cfe.jpg',
      *       'https://hiphotos.baidu.com/fex/%70%69%63/item/43a7d933c895d143e7b745607ef082025baf07ab.jpg'
      *   ],
      *   video: [{