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

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

@@ -18,11 +18,23 @@ declare module '../../index' {
     interface Option {
       /** 需要预览的图片链接列表。 */
       urls: string[]
-      /** 当前显示图片的链接 */
-      current?: string
-      /** @support weapp 最低版本：2.13.0。是否显示长按菜单，默认值：true */
+      /**
+       * 微信端为当前显示图片的链接，支付宝端为当前显示图片的索引值
+       */
+      current?: string | number
+      /**
+       * 是否支持长按下载图片
+       * @supported alipay 基础库: 1.13.0
+       */
+      enablesavephoto?: boolean
+      /**
+       * 是否在右下角显示下载入口
+       * @supported alipay 基础库: 1.13.0
+       */
+      enableShowPhotoDownload?: boolean
+      /** @supported weapp 最低版本：2.13.0。是否显示长按菜单，默认值：true */
       showmenu?: boolean
-      /** @support weapp 最低版本：2.13.0。origin: 发送完整的referrer; no-referrer: 不发送。格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；默认值：no-referrer */
+      /** @supported weapp 最低版本：2.13.0。origin: 发送完整的referrer; no-referrer: 不发送。格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；默认值：no-referrer */
       referrerPolicy?: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
@@ -46,7 +58,7 @@ declare module '../../index' {
       /** 需要预览的资源列表 */
       sources: Sources[]
       /** 当前显示的资源序号，默认值：0 */
-      current?:	number
+      current?: number
       /** 是否显示长按菜单	2.13.0，默认值：true */
       showmenu?: boolean
       /** origin: 发送完整的referrer; no-referrer: 不发送。格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；默认值：no-referrer */
@@ -127,19 +139,30 @@ declare module '../../index' {
 
   namespace chooseImage {
     interface Option {
+      /** 最多可以选择的图片张数
+       * @default 9
+       * @supported weapp, alipay, swan, tt, h5, rn
+       */
+      count?: number
+      /** 所选的图片的尺寸
+       * @default ['original', 'compressed']
+       * @supported weapp, alipay, swan, tt, rn
+       */
+      sizeType?: Array<keyof sizeType>
+      /** 选择图片的来源
+       * @default ['album', 'camera']
+       * @supported weapp, alipay, swan, tt, h5, rn
+       */
+      sourceType?: Array<keyof sourceType>
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
-      /** 最多可以选择的图片张数 */
-      count?: number
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
-      /** 所选的图片的尺寸 */
-      sizeType?: Array<keyof sizeType>
-      /** 选择图片的来源 */
-      sourceType?: Array<keyof sourceType>
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
-      /** 用来上传的input元素ID（仅h5端）@supported h5 */
+      /** 用来上传的input元素ID（仅h5端
+       * @supported h5
+       */
       imageId?: string
     }
     /** 图片的尺寸 */
@@ -301,7 +324,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 保存图片到系统相册。需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.writePhotosAlbum
-     * @supported weapp, rn, alipay, swan, tt
+     * @supported weapp, alipay, swan, tt, h5, rn
      * @example
      * ```tsx
      * Taro.saveImageToPhotosAlbum({
@@ -325,7 +348,7 @@ declare module '../../index' {
     previewMedia(option: previewMedia.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 在新页面中全屏预览图片。预览的过程中用户可以进行保存图片、发送给朋友等操作。
-     * @supported weapp, h5, rn, alipay, swan, tt
+     * @supported weapp, alipay, swan, tt, h5, rn
      * @example
      * ```tsx
      * Taro.previewImage({
@@ -338,7 +361,7 @@ declare module '../../index' {
     previewImage(option: previewImage.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 获取图片信息。网络图片需先配置download域名才能生效。
-     * @supported weapp, h5, rn, alipay, swan, tt
+     * @supported weapp, alipay, swan, tt, h5, rn
      * @example
      * ```tsx
      * Taro.getImageInfo({
@@ -377,7 +400,7 @@ declare module '../../index' {
     editImage(option: editImage.Option): Promise<editImage.SuccessCallbackResult>
 
     /** 压缩图片接口，可选压缩质量
-     * @supported weapp, rn, tt
+     * @supported weapp, tt, rn
      * @example
      * ```tsx
      * Taro.compressImage({
@@ -408,7 +431,7 @@ declare module '../../index' {
 
     /**
      * 从本地相册选择图片或使用相机拍照。
-     * @supported weapp, h5, rn, alipay, swan, tt
+     * @supported weapp, alipay, swan, tt, h5, rn
      * @example
      * ```tsx
      * Taro.chooseImage({

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

@@ -227,6 +227,14 @@ declare module '../../index' {
     toggleTorch(option?: LivePusherContext.ToggleTorchOption): void
   }
   namespace LivePlayerContext {
+    interface ExitCastingOption {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
     interface ExitFullScreenOption {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
@@ -267,6 +275,14 @@ declare module '../../index' {
       /** 接口调用成功的回调函数 */
       success?: (res: TaroGeneral.CallbackResult) => void
     }
+    interface ReconnectCastingOption {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void      
+    }
     interface RequestFullScreenOption {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
@@ -316,6 +332,14 @@ declare module '../../index' {
       /** 调用结果 */
       errMsg: string
     }
+    interface StartCastingOption {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
     interface StopOption {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
@@ -324,6 +348,14 @@ declare module '../../index' {
       /** 接口调用成功的回调函数 */
       success?: (res: TaroGeneral.CallbackResult) => void
     }
+    interface SwitchCastingOption {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
   }
 
   /** `LivePlayerContext` 实例，可通过 `Taro.createLivePlayerContext` 获取。
@@ -332,6 +364,11 @@ declare module '../../index' {
    * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.html
    */
   interface LivePlayerContext {
+    /** 退出投屏。仅支持在 tap 事件回调内调用。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.exitCasting.html
+     */
+    exitCasting(option?: LivePlayerContext.ExitCastingOption): void
     /** 退出全屏
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.exitFullScreen.html
@@ -357,6 +394,11 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.play.html
      */
     play(option?: LivePlayerContext.PlayOption): void
+    /** 重连投屏设备。仅支持在 tap 事件回调内调用。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.reconnectCasting.html
+     */
+    reconnectCasting(option?: LivePlayerContext.ReconnectCastingOption): void
     /** 进入全屏
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.requestFullScreen.html
@@ -381,11 +423,21 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.snapshot.html
      */
     snapshot(option?: LivePlayerContext.SnapshotOption): void
+    /** 开始投屏, 拉起半屏搜索设备。仅支持在 tap 事件回调内调用
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.startCasting.html
+     */
+    startCasting(option?: LivePlayerContext.StartCastingOption): void
     /** 停止
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.stop.html
      */
     stop(option?: LivePlayerContext.StopOption): void
+    /** 切换投屏设备。仅支持在 tap 事件回调内调用。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.switchCasting.html
+     */
+    switchCasting(option?: LivePlayerContext.SwitchCastingOption): void
   }
 
   interface TaroStatic {

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

@@ -233,30 +233,42 @@ declare module '../../index' {
 
   namespace chooseVideo {
     interface Option {
-      /** 默认拉起的是前置或者后置摄像头。部分 Android 手机下由于系统 ROM 不支持无法生效 */
+      /** 默认拉起的是前置或者后置摄像头。部分 Android 手机下由于系统 ROM 不支持无法生效
+       * @default "back"
+       * @supported weapp, h5
+       */
       camera?: keyof Camera
+      /** 是否压缩所选择的视频文件
+       * @default true
+       * @supported weapp
+       */
+      compressed?: boolean
+      /** 拍摄视频最长拍摄时间，单位秒
+       * @default 60
+       * @supported weapp
+       */
+      maxDuration?: number
+      /** 视频选择的来源
+       * @default ['album', 'camera']
+       * @supported weapp, h5
+       */
+      sourceType?: Array<keyof sourceType>
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
-      /** 是否压缩所选择的视频文件 */
-      compressed?: boolean
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
-      /** 拍摄视频最长拍摄时间，单位秒 */
-      maxDuration?: number
-      /** 视频选择的来源 */
-      sourceType?: Array<keyof sourceType>
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
     }
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 选定视频的临时文件路径 */
+      tempFilePath: string
       /** 选定视频的时间长度 */
       duration: number
-      /** 返回选定视频的高度 */
-      height: number
       /** 选定视频的数据量大小 */
       size: number
-      /** 选定视频的临时文件路径 */
-      tempFilePath: string
+      /** 返回选定视频的高度 */
+      height: number
       /** 返回选定视频的宽度 */
       width: number
       /** 调用结果 */
@@ -276,30 +288,53 @@ declare module '../../index' {
     }
   }
 
-
   namespace chooseMedia {
     interface Option {
-      /** 最多可以选择的文件个数 */
+      /** 最多可以选择的文件个数
+       * @default 9
+       * @supported weapp, h5
+       */
       count?: number
-      /** 文件类型 */
+      /** 文件类型
+       * @default ['image', 'video']
+       * @supported weapp, h5
+       */
       mediaType?: Array<keyof mediaType>
-      /** 图片和视频选择的来源 */
+      /** 图片和视频选择的来源
+       * @default ['album', 'camera']
+       * @supported weapp, h5
+       */
       sourceType?: Array<keyof sourceType>
-      /** 拍摄视频最长拍摄时间，单位秒。时间范围为 3s 至 30s 之间 */
+      /** 拍摄视频最长拍摄时间，单位秒。时间范围为 3s 至 60s 之间
+       * @default 10
+       * @supported weapp
+       */
       maxDuration?: number
-      /** 仅对 mediaType 为 image 时有效，是否压缩所选文件 */
+      /** 是否压缩所选文件
+       * @default ['original', 'compressed']
+       * @supported weapp
+       */
       sizeType?: Array<'original' | 'compressed'>
-      /** 仅在 sourceType 为 camera 时生效，使用前置或后置摄像头 */
+      /** 仅在 sourceType 为 camera 时生效，使用前置或后置摄像头
+       * @default "back"
+       * @supported weapp, h5
+       */
       camera?: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
+      /** 用来上传的input元素ID
+       * @supported h5
+       */
+      mediaId?: string
     }
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 本地临时文件列表 */
       tempFiles: ChooseMedia[]
-      /** 文件类型，有效值有 image 、video */
+      /** 文件类型，有效值有 image 、video、mix */
       type: string
     }
     /** 本地临时文件列表 */
@@ -316,6 +351,12 @@ declare module '../../index' {
       width: number
       /** 视频缩略图临时文件路径 */
       thumbTempFilePath: string
+      /** 选择的文件的类型 */
+      fileType: string
+      /** 原始的浏览器 File 对象
+       * @supported h5
+       */
+      originalFileObj?: File
     }
     interface mediaType {
       /** 只能拍摄视频或从相册选择视频 */
@@ -346,11 +387,11 @@ declare module '../../index' {
      * **Bug & Tip：**
      *
      * 1.  `tip`: camera 参数在部分 Android 手机下由于系统 ROM 不支持无法生效
-     * @supported weapp, rn
+     * @supported weapp, h5, rn
      * @example
      ```tsx
      * Taro.saveVideoToPhotosAlbum({
-     *   filePath: 'wxfile://xxx',
+     *   filePath: 'file://xxx',
      *   success: function (res) {
      *     console.log(res.errMsg)
      *   }
@@ -447,7 +488,7 @@ declare module '../../index' {
     compressVideo(option: compressVideo.Option): Promise<compressVideo.SuccessCallbackResult>
 
     /** 拍摄视频或从手机相册中选视频。
-     * @supported weapp, rn
+     * @supported weapp, h5, rn
      * @example
      * ```tsx
      * Taro.chooseVideo({
@@ -464,7 +505,7 @@ declare module '../../index' {
     chooseVideo(option: chooseVideo.Option): Promise<chooseVideo.SuccessCallbackResult>
 
     /** 拍摄或从手机相册中选择图片或视频。
-     * @supported weapp
+     * @supported weapp, h5
      * @example
      * ```tsx
      * Taro.chooseMedia({

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

@@ -202,6 +202,98 @@ declare module '../../index' {
     }
   }
 
+  namespace join1v1Chat {
+    interface Caller {
+      /** 昵称 */
+      nickname: string
+      /** 头像 */
+      headImage?: string
+      /** 小程序内 openid */
+      openid: string
+    }
+    interface Listener {
+      /** 昵称 */
+      nickname: string
+      /** 头像 */
+      headImage?: string
+      /** 小程序内 openid */
+      openid: string
+    }
+    interface RoomType {
+      /** 语音通话 */
+      voice
+      /** 视频通话 */
+      video
+    }
+    interface Option {
+      /** 呼叫方信息 */
+      caller: Caller
+      /** 接听方信息 */
+      listener: Listener
+      /** 窗口背景色
+       * @default 0
+       */
+      backgroundType?: keyof setEnable1v1Chat.ColorType
+      /** 通话类型 */
+      roomType?: keyof RoomType
+      /** 小窗样式
+       * @default 1
+       */
+      minWindowType?: keyof setEnable1v1Chat.ColorType
+      /** 不允许切换到语音通话
+       * @default false
+       */
+      disableSwitchVoice?: boolean
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+    interface ChatErrCode {
+      /** 未开通双人通话 */
+      [-20000]
+      /** 当前设备不支持 */
+      [-20001]
+      /** 正在通话中 */
+      [-20002]
+      /** 其它小程序正在通话中 */
+      [-20003]
+      /** 内部系统错误 */
+      [-30000]
+      /** 微信缺失相机权限 */
+      [-30001]
+      /** 微信缺失录音权限  */
+      [-30002]
+      /** 小程序缺失录音权限 */
+      [-30003]
+      /** 小程序缺失相机权限 */
+      [-30004]
+      /** 当前已在房间内 */
+      [-1]
+      /** 录音设备被占用，可能是当前正在使用微信内语音通话或系统通话 */
+      [-2]
+      /** 加入会话期间退出（可能是用户主动退出，或者退后台、来电等原因），因此加入失败 */
+      [-3]
+      /** 系统错误 */
+      [-1000]
+    }
+    interface FailCallbackResult extends TaroGeneral.CallbackResult {
+      /** 错误信息 */
+      errMsg: string
+      /** 错误码 */
+      errCode: keyof ChatErrCode
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 错误码 */
+      errCode: number
+      /** 调用结果 */
+      errMsg: string
+    }
+    type Promised = FailCallbackResult | SuccessCallbackResult
+  }
+
   namespace exitVoIPChat {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
@@ -264,6 +356,12 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPChatStateChanged.html
      */
     offVoIPChatStateChanged(callback: onVoIPChatStateChanged.Callback): void
+    /**
+     * 取消监听实时语音通话成员通话状态变化事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPChatSpeakersChanged.html
+     */
+    offVoIPChatSpeakersChanged(callback: onVoIPChatSpeakersChanged.Callback): void
     /** 取消监听实时语音通话成员在线状态变化事件
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPChatMembersChanged.html
@@ -281,6 +379,11 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.joinVoIPChat.html
      */
     joinVoIPChat(option: joinVoIPChat.Option): Promise<joinVoIPChat.Promised>
+    /**加入（创建）双人通话
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.join1v1Chat.html
+     */
+    join1v1Chat(option: join1v1Chat.Option): Promise<join1v1Chat.Promised>
     /** 退出（销毁）实时语音通话
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.exitVoIPChat.html

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

@@ -60,58 +60,61 @@ declare module '../../index' {
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
-      /** 设置 H5 端是否使用jsonp方式获取数据
+      /** 设置是否使用 jsonp 方式获取数据
        * @default false
        * @supported h5
        */
-      jsonp?: boolean
-      /** 设置 H5 端 jsonp 请求 url 是否需要被缓存
-       * @default false
+      jsonp?: boolean | string
+      /** 设置 jsonp 请求 url 是否需要被缓存
        * @supported h5
        */
-      jsonpCache?: boolean
-      /** 设置 H5 端是否允许跨域请求
+      jsonpCache?: RequestCache
+      /** 设置是否允许跨域请求
        * @default "same-origin"
        * @supported h5
        */
       mode?: keyof CorsMode
-      /** 设置 H5 端是否携带 Cookie
+      /** 设置是否携带 Cookie
        * @default "omit"
        * @supported h5
        */
       credentials?: keyof Credentials
-      /** 设置 H5 端缓存模式
+      /** 设置缓存模式
        * @default "default"
        * @supported h5
        */
       cache?: keyof Cache
-      /** 设置 H5 端请求重试次数
+      /** 设置请求重试次数
        * @default 2
        * @supported h5
        */
       retryTimes?: number
-      /** 设置 H5 端请求的兜底接口
+      /** 设置请求的兜底接口
        * @supported h5
        */
       backup?: string | string[]
-      /** 设置 H5 端请求响应的数据校验函数，若返回 false，则请求兜底接口，若无兜底接口，则报请求失败
+      /** 设置请求中止信号
+       * @supported h5
+       */
+      signal?: AbortSignal
+      /** 设置请求响应的数据校验函数，若返回 false，则请求兜底接口，若无兜底接口，则报请求失败
        * @supported h5
        */
       dataCheck?(): boolean
-      /** 设置 H5 端请求是否使用缓存
+      /** 设置请求是否使用缓存
        * @default false
        * @supported h5
        */
       useStore?: boolean
-      /** 设置 H5 端请求缓存校验的 key
+      /** 设置请求缓存校验的 key
        * @supported h5
        */
       storeCheckKey?: string
-      /** 设置 H5 端请求缓存签名
+      /** 设置请求缓存签名
        * @supported h5
        */
       storeSign?: string
-      /** 设置 H5 端请求校验函数，一般不需要设置
+      /** 设置请求校验函数，一般不需要设置
        * @supported h5
        */
       storeCheck?(): boolean

package/types/api/open-api/channels.d.ts

@@ -68,6 +68,31 @@ declare module '../../index' {
     }
   }
 
+  namespace getChannelsShareKey {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 分享者 openid  */
+      sharerOpenId: string
+      /** 推广员 */
+      promoter: Promoter
+    }
+    interface Promoter {
+      /** 推广员昵称 */
+      finderNickname: string
+      /** 推广员id */
+      promoterId: string
+      /** 推广员openid */
+      promoterOpenId: string
+    }
+  }
+
   namespace getChannelsLiveNoticeInfo {
     interface Option {
       /** 视频号 id，以“sph”开头的id，可在视频号助手获取 */
@@ -164,6 +189,12 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.openChannelsActivity.html
      */
     openChannelsActivity(option?: openChannelsActivity.Option): Promise<TaroGeneral.CallbackResult>
+    /** 获取视频号直播卡片/视频卡片的分享来源，
+     * 仅当卡片携带了分享信息、同时用户已授权该小程序获取视频号分享信息且启动场景值为 1177、1184、1195、1208 时可用
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.getChannelsShareKey.html
+     */
+    getChannelsShareKey(option?: getChannelsShareKey.Option): Promise<getChannelsShareKey.SuccessCallbackResult>
     /** 获取视频号直播预告信息
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.getChannelsLiveNoticeInfo.html