@spcsn/taro 0.1.0

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

@@ -0,0 +1,383 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace sendSocketMessage {
+    interface Option {
+      /** 需要发送的内容 */
+      data: string | ArrayBuffer
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace onSocketOpen {
+    /** WebSocket 连接打开事件的回调函数 */
+    type Callback = (result: OpenCallbackResult) => void
+    interface OpenCallbackResult {
+      /** 连接成功的 HTTP 响应 Header */
+      header: TaroGeneral.IAnyObject
+    }
+  }
+
+  namespace onSocketMessage {
+    /** WebSocket 接受到服务器的消息事件的回调函数 */
+    type Callback<T = any> = (result: CallbackResult<T>) => void
+    interface CallbackResult<T extends any | string | ArrayBuffer = any> {
+      /** 服务器返回的消息 */
+      data: T
+    }
+  }
+
+  namespace onSocketError {
+    /** WebSocket 错误事件的回调函数 */
+    type Callback = (result: CallbackResult) => void
+    interface CallbackResult extends TaroGeneral.CallbackResult {
+      /** 错误信息 */
+      errMsg: string
+    }
+  }
+
+  namespace onSocketClose {
+    /** WebSocket 连接关闭事件的回调函数 */
+    type Callback = (result: CallbackResult) => void
+    interface CallbackResult {
+      /** 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 */
+      code: number
+      /** 一个可读的字符串，表示连接被关闭的原因。 */
+      reason: string
+    }
+  }
+
+  namespace connectSocket {
+    interface Option {
+      /** 开发者服务器 wss 接口地址 */
+      url: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** HTTP Header，Header 中不能设置 Referer */
+      header?: TaroGeneral.IAnyObject
+      /** 子协议数组 */
+      protocols?: string[]
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+      /** 建立 TCP 连接的时候的 TCP_NODELAY 设置 */
+      tcpNoDelay?: boolean
+    }
+  }
+
+  namespace closeSocket {
+    interface Option {
+      /** 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 */
+      code?: number
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本（不是字符）。 */
+      reason?: string
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace SocketTask {
+    interface CloseOption {
+      /** 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 */
+      code?: number
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本（不是字符）。 */
+      reason?: string
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+    /** WebSocket 连接关闭事件的回调函数 */
+    type OnCloseCallback = (result: OnCloseCallbackResult) => void
+    interface OnCloseCallbackResult {
+      /** 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 */
+      code: number
+      /** 一个可读的字符串，表示连接被关闭的原因。 */
+      reason: string
+    }
+    /** WebSocket 错误事件的回调函数 */
+    type OnErrorCallback = (result: OnErrorCallbackResult) => void
+    interface OnErrorCallbackResult extends TaroGeneral.CallbackResult {
+      /** 错误信息 */
+      errMsg: string
+    }
+    /** WebSocket 接受到服务器的消息事件的回调函数 */
+    type OnMessageCallback<T = any> = (result: OnMessageCallbackResult<T>) => void
+    interface OnMessageCallbackResult<T extends any | string | ArrayBuffer = any> {
+      /** 服务器返回的消息 */
+      data: T
+    }
+    /** WebSocket 连接打开事件的回调函数 */
+    type OnOpenCallback = (result: OnOpenCallbackResult) => void
+    interface OnOpenCallbackResult {
+      /** 连接成功的 HTTP 响应 Header*/
+      header: TaroGeneral.IAnyObject
+    }
+    interface SendOption {
+      /** 需要发送的内容 */
+      data: string | ArrayBuffer
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  /** WebSocket 任务，可通过 [Taro.connectSocket()](/docs/apis/network/websocket/SocketTask) 接口创建返回。
+   * @supported weapp, h5, rn, alipay, swan, harmony_hybrid
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.html
+   */
+  interface SocketTask {
+    /** 通过 WebSocket 连接发送数据
+     * @supported weapp, h5, rn, alipay, swan, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.send.html
+     */
+    send(option: SocketTask.SendOption): void
+    /** 关闭 WebSocket 连接
+     * @supported weapp, h5, rn, alipay, swan, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.close.html
+     */
+    close(option: SocketTask.CloseOption): void
+    /** 监听 WebSocket 连接打开事件
+     * @supported weapp, h5, rn, alipay, swan, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.onOpen.html
+     */
+    onOpen(
+      /** WebSocket 连接打开事件的回调函数 */
+      callback: SocketTask.OnOpenCallback
+    ): void
+    /** 监听 WebSocket 连接关闭事件
+     * @supported weapp, h5, rn, alipay, swan, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.onClose.html
+     */
+    onClose(
+      /** WebSocket 连接关闭事件的回调函数 */
+      callback: SocketTask.OnCloseCallback
+    ): void
+    /** 监听 WebSocket 错误事件
+     * @supported weapp, h5, rn, alipay, swan, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.onError.html
+     */
+    onError(
+      /** WebSocket 错误事件的回调函数 */
+      callback: SocketTask.OnErrorCallback
+    ): void
+    /** 监听 WebSocket 接受到服务器的消息事件
+     * @supported weapp, h5, rn, alipay, swan, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.onMessage.html
+     */
+    onMessage<T = any>(
+      /** WebSocket 接受到服务器的消息事件的回调函数 */
+      callback: SocketTask.OnMessageCallback<T>
+    ): void
+
+    /** websocket 当前的连接 ID。 */
+    readonly socketTaskId: number
+    /** websocket 当前的连接状态。 */
+    readonly readyState: number
+    /** websocket 接口调用结果。 */
+    readonly errMsg: string
+    /** websocket 状态值：连接中。 */
+    readonly CONNECTING: number
+    /** websocket 状态值：已连接。 */
+    readonly OPEN: number
+    /** websocket 状态值：关闭中。 */
+    readonly CLOSING: number
+    /** websocket 状态值：已关闭。 */
+    readonly CLOSED: number
+    /** 浏览器 websocket 实例。（h5 端独有） */
+    readonly ws: WebSocket
+  }
+
+  interface TaroStatic {
+    /** 通过 WebSocket 连接发送数据。需要先 Taro.connectSocket，并在 Taro.onSocketOpen 回调之后才能发送。
+     * @supported weapp, alipay, swan
+     * @example
+     * ```tsx
+     * let socketOpen = false
+     * const socketMsgQueue = []
+     * Taro.connectSocket({
+     *   url: 'test.php'
+     * })
+     * Taro.onSocketOpen(function(res) {
+     *   socketOpen = true
+     *   for (let i = 0; i < socketMsgQueue.length; i++){
+     *     sendSocketMessage(socketMsgQueue[i])
+     *   }
+     *   socketMsgQueue = []
+     * })
+     * function sendSocketMessage(msg) {
+     *   if (socketOpen) {
+     *     Taro.sendSocketMessage({
+     *       data:msg
+     *     })
+     *   } else {
+     *     socketMsgQueue.push(msg)
+     *   }
+     * }
+     * ```
+     @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.sendSocketMessage.html
+     */
+    sendSocketMessage(option: sendSocketMessage.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 监听 WebSocket 连接打开事件
+     * @supported weapp, alipay, swan
+     * @example
+     * ```tsx
+     * Taro.connectSocket({
+     *   url: 'test.php'
+     * })
+     * Taro.onSocketOpen(function (res) {
+     *   console.log('WebSocket连接已打开！')
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.onSocketOpen.html
+     */
+    onSocketOpen(
+      /** WebSocket 连接打开事件的回调函数 */
+      callback: onSocketOpen.Callback
+    ): void
+
+    /** 监听 WebSocket 接受到服务器的消息事件
+     * @supported weapp, alipay, swan
+     * @example
+     * ```tsx
+     * Taro.connectSocket({
+     *   url: 'test.php'
+     * })
+     * Taro.onSocketMessage(function (res) {
+     *   console.log('收到服务器内容：' + res.data)
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.onSocketMessage.html
+     */
+    onSocketMessage<T = any>(
+      /** WebSocket 接受到服务器的消息事件的回调函数 */
+      callback: onSocketMessage.Callback<T>
+    ): void
+
+    /** 监听 WebSocket 错误事件
+     * @supported weapp, alipay, swan
+     * @example
+     * ```tsx
+     * Taro.connectSocket({
+     *   url: 'test.php'
+     * })
+     * Taro.onSocketOpen(function (res){
+     *   console.log('WebSocket连接已打开！')
+     * })
+     * Taro.onSocketError(function (res){
+     *   console.log('WebSocket连接打开失败，请检查！')
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.onSocketError.html
+     */
+    onSocketError(
+      /** WebSocket 错误事件的回调函数 */
+      callback: onSocketError.Callback
+    ): void
+
+    /** 监听 WebSocket 连接关闭事件
+     * @supported weapp, alipay, swan
+     * @example
+     * ```tsx
+     * Taro.connectSocket({
+     *   url: 'test.php'
+     * })
+     * //注意这里有时序问题，
+     * //如果 Taro.connectSocket 还没回调 Taro.onSocketOpen，而先调用 Taro.closeSocket，那么就做不到关闭 WebSocket 的目的。
+     * //必须在 WebSocket 打开期间调用 Taro.closeSocket 才能关闭。
+     * Taro.onSocketOpen(function () {
+     *   Taro.closeSocket()
+     * })
+     * Taro.onSocketClose(function (res) {
+     *   console.log('WebSocket 已关闭！')
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.onSocketClose.html
+     */
+    onSocketClose(
+      /** WebSocket 连接关闭事件的回调函数 */
+      callback: onSocketClose.Callback
+    ): void
+
+    /** 创建一个 WebSocket 连接。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)。
+     *
+     * **并发数**
+     * - 1.7.0 及以上版本，最多可以同时存在 5 个 WebSocket 连接。
+     * - 1.7.0 以下版本，一个小程序同时只能有一个 WebSocket 连接，如果当前已存在一个 WebSocket 连接，会自动关闭该连接，并重新创建一个 WebSocket 连接。
+     * @supported weapp, h5, rn, alipay, swan, harmony_hybrid
+     * @example
+     * ```tsx
+     * Taro.connectSocket({
+     *   url: 'wss://example.qq.com',
+     *   header:{
+     *     'content-type': 'application/json'
+     *   },
+     *   protocols: ['protocol1']
+     * })
+     * ```
+     * @example
+     * ```tsx
+     * Taro.connectSocket({
+     *   url: 'ws://echo.websocket.org/echo',
+     *   success: function () {
+     *     console.log('connect success')
+     *   }
+     * }).then(task => {
+     *   task.onOpen(function () {
+     *     console.log('onOpen')
+     *     task.send({ data: 'xxx' })
+     *   })
+     *   task.onMessage(function (msg) {
+     *     console.log('onMessage: ', msg)
+     *     task.close()
+     *   })
+     *   task.onError(function () {
+     *     console.log('onError')
+     *   })
+     *   task.onClose(function (e) {
+     *     console.log('onClose: ', e)
+     *   })
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.connectSocket.html
+     */
+    connectSocket(option: connectSocket.Option): Promise<SocketTask>
+
+    /** 关闭 WebSocket 连接
+     * @supported weapp, alipay, swan
+     * @example
+     * ```tsx
+     * Taro.connectSocket({
+     *   url: 'test.php'
+     * })
+     * //注意这里有时序问题，
+     * //如果 Taro.connectSocket 还没回调 Taro.onSocketOpen，而先调用 Taro.closeSocket，那么就做不到关闭 WebSocket 的目的。
+     * //必须在 WebSocket 打开期间调用 Taro.closeSocket 才能关闭。
+     * Taro.onSocketOpen(function() {
+     *   Taro.closeSocket()
+     * })
+     * Taro.onSocketClose(function(res) {
+     *   console.log('WebSocket 已关闭！')
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.closeSocket.html
+     */
+    closeSocket(option?: closeSocket.Option): Promise<TaroGeneral.CallbackResult>
+  }
+}

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

@@ -0,0 +1,51 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace getAccountInfoSync {
+    /** 帐号信息 */
+    interface AccountInfo {
+      /** 小程序帐号信息 */
+      miniProgram: MiniProgram
+      /** 插件帐号信息（仅在插件中调用时包含这一项） */
+      plugin: Plugin
+    }
+    /** 小程序帐号信息 */
+    interface MiniProgram {
+      /** 小程序 appId */
+      appId: string
+      /**
+       * 小程序版本
+       * @since 2.10.0
+       */
+      envVersion: 'develop' | 'trial' | 'release'
+      /**
+       * 线上小程序版本号
+       * @since 2.10.2
+       */
+      version: string
+    }
+    /** 插件帐号信息（仅在插件中调用时包含这一项） */
+    interface Plugin {
+      /** 插件 appId */
+      appId: string
+      /** 插件版本号 */
+      version: string
+    }
+  }
+
+  interface TaroStatic {
+    /** 获取当前帐号信息
+     * @supported weapp, alipay, qq
+     * @example
+     * ```tsx
+     * const accountInfo = Taro.getAccountInfoSync();
+     *
+     * console.log(accountInfo.miniProgram.appId) // 小程序 appId
+     * console.log(accountInfo.plugin.appId) // 插件 appId
+     * console.log(accountInfo.plugin.version) // 插件版本号， 'a.b.c' 这样的形式
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/account-info/wx.getAccountInfoSync.html
+     */
+    getAccountInfoSync(): getAccountInfoSync.AccountInfo
+  }
+}

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

@@ -0,0 +1,68 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace chooseAddress {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: SuccessCallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 收货人姓名 */
+      userName: string
+      /** 邮编
+       * @supported weapp, qq
+       */
+      postalCode: string
+      /** 国标收货地址第一级地址 */
+      provinceName: string
+      /** 国标收货地址第二级地址 */
+      cityName: string
+      /** 国标收货地址第三级地址 */
+      countyName: string
+      /** 国标收货地址第四级地址
+       * @supported weapp, qq
+       */
+      streetName: string
+      /** 详细收货地址信息 */
+      detailInfo: string
+      /** 新选择器详细收货地址信息
+       * @supported weapp, qq
+       */
+      detailInfoNew: string
+      /** 收货地址国家码
+       * @supported weapp, qq
+       */
+      nationalCode: string
+      /** 收货人手机号码 */
+      telNumber: string
+    }
+  }
+
+  interface TaroStatic {
+    /** 获取用户收货地址。调起用户编辑收货地址原生界面，并在编辑完成后返回用户选择的地址。
+     * @supported weapp, qq, tt, jd
+     * @example
+     * ```tsx
+     * Taro.chooseAddress({
+     *   success: function (res) {
+     *     console.log(res.userName)
+     *     console.log(res.postalCode)
+     *     console.log(res.provinceName)
+     *     console.log(res.cityName)
+     *     console.log(res.countyName)
+     *     console.log(res.detailInfo)
+     *     console.log(res.nationalCode)
+     *     console.log(res.telNumber)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/address/wx.chooseAddress.html
+     */
+    chooseAddress(option?: chooseAddress.Option): Promise<chooseAddress.SuccessCallbackResult>
+  }
+}

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

@@ -0,0 +1,80 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace authorizeForMiniProgram {
+    interface Option {
+      /** 需要获取权限的 scope，详见 [scope 列表](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html#scope-%E5%88%97%E8%A1%A8) */
+      scope: keyof Scope | string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+
+    /** scope 合法值
+     * @see https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html#scope-%E5%88%97%E8%A1%A8
+     */
+    interface Scope {
+      'scope.record'
+      'scope.writePhotosAlbum'
+      'scope.camera'
+    }
+  }
+
+  namespace authorize {
+    interface Option {
+      /** 需要获取权限的 scope，详见 [scope 列表](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html#scope-%E5%88%97%E8%A1%A8) */
+      scope: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  interface TaroStatic {
+    /** **仅小程序插件中能调用该接口**，用法同 [Taro.authorize](../authorize)。目前仅支持三种 scope
+     * @supported weapp
+     * @example
+     * ```tsx
+     * // 可以通过 Taro.getSetting 先查询一下用户是否授权了 "scope.record" 这个 scope
+     * Taro.authorizeForMiniProgram({
+     *   scope: 'scope.record',
+     *   success () {
+     *     // 用户已经同意小程序使用录音功能，后续调用 Taro.startRecord 接口不会弹窗询问
+     *     Taro.startRecord()
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/authorize/wx.authorizeForMiniProgram.html
+     */
+     authorizeForMiniProgram(option: authorizeForMiniProgram.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据，但不会实际调用对应接口。如果用户之前已经同意授权，则不会出现弹窗，直接返回成功。更多用法详见 [用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html)。
+     * @supported weapp, swan, qq, tt, rn
+     * @example
+     * ```tsx
+     * // 可以通过 Taro.getSetting 先查询一下用户是否授权了 "scope.record" 这个 scope
+     * Taro.getSetting({
+     *   success: function (res) {
+     *     if (!res.authSetting['scope.record']) {
+     *       Taro.authorize({
+     *         scope: 'scope.record',
+     *         success: function () {
+     *           // 用户已经同意小程序使用录音功能，后续调用 Taro.startRecord 接口不会弹窗询问
+     *           Taro.startRecord()
+     *         }
+     *       })
+     *     }
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/authorize/wx.authorize.html
+     */
+     authorize(option: authorize.Option): Promise<TaroGeneral.CallbackResult>
+  }
+}

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

@@ -0,0 +1,110 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace openCard {
+    interface Option {
+      /** 需要打开的卡券列表 */
+      cardList: RequestInfo[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+
+    /** 需要打开的卡券列表 */
+    interface RequestInfo {
+      /** 卡券 ID */
+      cardId: string
+      /** 由 Taro.addCard 的返回对象中的加密 code 通过解密后得到，解密请参照：[code 解码接口](https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1499332673_Unm7V) */
+      code: string
+    }
+  }
+
+  namespace addCard {
+    interface Option {
+      /** 需要添加的卡券列表 */
+      cardList: RequestInfo[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+
+    /** 需要添加的卡券列表 */
+    interface RequestInfo {
+      /** 卡券的扩展参数。需将 CardExt 对象 JSON 序列化为**字符串**传入 */
+      cardExt: string
+      /** 卡券 ID */
+      cardId: string
+    }
+
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 卡券添加结果列表 */
+      cardList: AddCardResponseInfo[]
+      /** 调用结果 */
+      errMsg: string
+    }
+    /** 卡券添加结果列表 */
+    interface AddCardResponseInfo {
+      /** 卡券的扩展参数，结构请参考下文 */
+      cardExt: string
+      /** 用户领取到卡券的 ID */
+      cardId: string
+      /** 加密 code，为用户领取到卡券的code加密后的字符串，解密请参照：[code 解码接口](https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1499332673_Unm7V) */
+      code: string
+      /** 是否成功 */
+      isSuccess: boolean
+    }
+  }
+
+  interface TaroStatic {
+    /** 查看微信卡包中的卡券。只有通过 [认证](https://developers.weixin.qq.com/miniprogram/product/renzheng.html) 的小程序或文化互动类目的小游戏才能使用。更多文档请参考 [微信卡券接口文档](https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&key=1490190158&version=1&lang=zh_CN&platform=2)。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.openCard({
+     *   cardList: [{
+     *     cardId: '',
+     *     code: ''
+     *   }, {
+     *     cardId: '',
+     *     code: ''
+     *   }],
+     *   success: function (res) { }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/card/wx.openCard.html
+     */
+    openCard(option: openCard.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 批量添加卡券。只有通过 [认证](https://developers.weixin.qq.com/miniprogram/product/renzheng.html) 的小程序或文化互动类目的小游戏才能使用。更多文档请参考 [微信卡券接口文档](https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&key=1490190158&version=1&lang=zh_CN&platform=2)。
+     *
+     * **cardExt 说明**
+     * cardExt 是卡券的扩展参数，其值是一个 JSON 字符串。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.addCard({
+     *   cardList: [
+     *     {
+     *       cardId: '',
+     *       cardExt: '{"code": "", "openid": "", "timestamp": "", "signature":""}'
+     *     }, {
+     *       cardId: '',
+     *       cardExt: '{"code": "", "openid": "", "timestamp": "", "signature":""}'
+     *     }
+     *   ],
+     *   success: function (res) {
+     *     console.log(res.cardList) // 卡券添加结果
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/card/wx.addCard.html
+     */
+    addCard(option: addCard.Option): Promise<addCard.SuccessCallbackResult>
+  }
+}