@tarojs/taro 3.3.10 → 3.3.14

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

@@ -1,4 +1,6 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace getAccountInfoSync {
     /** 帐号信息 */
     interface AccountInfo {
@@ -31,17 +33,19 @@ declare namespace Taro {
     }
   }
 
-  /** 获取当前帐号信息
-   * @supported weapp
-   * @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
-   */
-  function getAccountInfoSync(): getAccountInfoSync.AccountInfo
+  interface TaroStatic {
+    /** 获取当前帐号信息
+     * @supported weapp
+     * @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

@@ -1,10 +1,12 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace chooseAddress {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
     }
@@ -31,24 +33,26 @@ declare namespace Taro {
     }
   }
 
-  /** 获取用户收货地址。调起用户编辑收货地址原生界面，并在编辑完成后返回用户选择的地址。
-   * @supported weapp
-   * @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
-   */
-  function chooseAddress(option?: chooseAddress.Option): Promise<chooseAddress.SuccessCallbackResult>
+  interface TaroStatic {
+    /** 获取用户收货地址。调起用户编辑收货地址原生界面，并在编辑完成后返回用户选择的地址。
+     * @supported weapp
+     * @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

@@ -1,37 +1,41 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace authorize {
     interface Option {
       /** 需要获取权限的 scope，详见 [scope 列表]((authorize#scope-列表)) */
       scope: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
 
-  /** 提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据，但不会实际调用对应接口。如果用户之前已经同意授权，则不会出现弹窗，直接返回成功。更多用法详见 [用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html)。
-   * @supported weapp
-   * @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
-   */
-  function authorize(option: authorize.Option): Promise<General.CallbackResult>
+  interface TaroStatic {
+    /** 提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据，但不会实际调用对应接口。如果用户之前已经同意授权，则不会出现弹窗，直接返回成功。更多用法详见 [用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html)。
+     * @supported weapp
+     * @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

@@ -1,14 +1,16 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace openCard {
     interface Option {
       /** 需要打开的卡券列表 */
       cardList: RequestInfo[]
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
 
     /** 需要打开的卡券列表 */
@@ -20,33 +22,14 @@ declare namespace Taro {
     }
   }
 
-  /** 查看微信卡包中的卡券。只有通过 [认证](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
-   */
-  function openCard(option: openCard.Option): Promise<General.CallbackResult>
-
   namespace addCard {
     interface Option {
       /** 需要添加的卡券列表 */
       cardList: RequestInfo[]
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
     }
@@ -59,7 +42,7 @@ declare namespace Taro {
       cardId: string
     }
 
-    interface SuccessCallbackResult extends General.CallbackResult {
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 卡券添加结果列表 */
       cardList: AddCardResponseInfo[]
       /** 调用结果 */
@@ -78,29 +61,50 @@ declare namespace Taro {
     }
   }
 
-  /** 批量添加卡券。只有通过 [认证](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
-   */
-  function addCard(option: addCard.Option): Promise<addCard.SuccessCallbackResult>
+  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>
+  }
 }

package/types/api/open-api/customer-service.d.ts

@@ -0,0 +1,45 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace openCustomerServiceChat {
+    interface ExtInfo {
+      url: string
+    }
+    interface Option {
+      /** 客服信息 */
+      extInfo: ExtInfo
+      /** 企业ID */
+      corpId: string
+      /** 是否发送小程序气泡消息，默认值：false */
+      showMessageCard?: boolean
+      /** 气泡消息标题 */
+      sendMessageTitle?: string
+      /** 气泡消息小程序路径 */
+      sendMessagePath?: string
+      /** 气泡消息图片 */
+      sendMessageImg?: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  interface TaroStatic {
+    /** 打开微信客服。了解更多信息，可以参考微信客服介绍：https://work.weixin.qq.com/kf/。
+     * @supported weapp 基础库 2.19.0 开始支持，低版本需做兼容处理。
+     * @example
+     * ```tsx
+     * Taro.openCustomerServiceChat({
+     *   extInfo: {url: ''},
+     *   corpId: '',
+     *   success: function (res) { }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/service-chat/wx.openCustomerServiceChat.html
+     */
+    openCustomerServiceChat(option?: openCustomerServiceChat.Option): Promise<TaroGeneral.CallbackResult>
+  }
+}

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

@@ -1,4 +1,6 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace checkIsSupportFacialRecognition {
     interface Option {
       /** 交互方式 */
@@ -10,7 +12,7 @@ declare namespace Taro {
       /** 接口调用成功的回调函数 */
       success?: (result: CallbackResult) => void
     }
-    interface CallbackResult extends General.CallbackResult {
+    interface CallbackResult extends TaroGeneral.CallbackResult {
       /** 错误信息 */
       errMsg: string
       /** 错误码 */
@@ -18,13 +20,6 @@ declare namespace Taro {
     }
   }
 
-  /** 检查是否支持面部识别
-   * @supported weapp
-   */
-  function checkIsSupportFacialRecognition(
-    option?: checkIsSupportFacialRecognition.Option
-  ): Promise<checkIsSupportFacialRecognition.CallbackResult>
-
   namespace startFacialRecognitionVerify {
     interface Option {
       /** 身份证名称 */
@@ -40,7 +35,7 @@ declare namespace Taro {
       /** 接口调用成功的回调函数 */
       success?: (result: CallbackResult) => void
     }
-    interface CallbackResult extends General.CallbackResult {
+    interface CallbackResult extends TaroGeneral.CallbackResult {
       /** 错误信息 */
       errMsg: string
       /** 错误码 */
@@ -50,13 +45,6 @@ declare namespace Taro {
     }
   }
 
-  /** 开始人脸识别认证
-   * @supported weapp
-   */
-  function startFacialRecognitionVerify(
-    option?: startFacialRecognitionVerify.Option
-  ): Promise<startFacialRecognitionVerify.CallbackResult>
-
   namespace startFacialRecognitionVerifyAndUploadVideo {
     interface Option {
       /** 身份证名称 */
@@ -72,7 +60,7 @@ declare namespace Taro {
       /** 接口调用成功的回调函数 */
       success?: (result: CallbackResult) => void
     }
-    interface CallbackResult extends General.CallbackResult {
+    interface CallbackResult extends TaroGeneral.CallbackResult {
       /** 错误信息 */
       errMsg: string
       /** 错误码 */
@@ -82,10 +70,26 @@ declare namespace Taro {
     }
   }
 
-  /** 开始人脸识别认证并上传认证视频
-   * @supported weapp
-   */
-  function startFacialRecognitionVerifyAndUploadVideo(
-    option?: startFacialRecognitionVerifyAndUploadVideo.Option
-  ): Promise<startFacialRecognitionVerifyAndUploadVideo.CallbackResult>
+  interface TaroStatic {
+    /** 检查是否支持面部识别
+     * @supported weapp
+     */
+    checkIsSupportFacialRecognition(
+      option?: checkIsSupportFacialRecognition.Option
+    ): Promise<checkIsSupportFacialRecognition.CallbackResult>
+
+    /** 开始人脸识别认证
+     * @supported weapp
+     */
+    startFacialRecognitionVerify(
+      option?: startFacialRecognitionVerify.Option
+    ): Promise<startFacialRecognitionVerify.CallbackResult>
+
+    /** 开始人脸识别认证并上传认证视频
+     * @supported weapp
+     */
+    startFacialRecognitionVerifyAndUploadVideo(
+      option?: startFacialRecognitionVerifyAndUploadVideo.Option
+    ): Promise<startFacialRecognitionVerifyAndUploadVideo.CallbackResult>
+  }
 }

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

@@ -1,15 +1,17 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace chooseInvoiceTitle {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
     }
 
-    interface SuccessCallbackResult extends General.CallbackResult {
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 银行账号 */
       bankAccount: string
       /** 银行名称 */
@@ -35,29 +37,17 @@ declare namespace Taro {
     }
   }
 
-  /** 选择用户的发票抬头。当前小程序必须关联一个公众号，且这个公众号是完成了[微信认证](https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1496554031_RD4xe)的，才能调用 chooseInvoiceTitle。
-   * @supported weapp
-   * @example
-   * ```tsx
-   * Taro.chooseInvoiceTitle({
-   *   success: function(res) {}
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/invoice/wx.chooseInvoiceTitle.html
-   */
-  function chooseInvoiceTitle(option?: chooseInvoiceTitle.Option): Promise<chooseInvoiceTitle.SuccessCallbackResult>
-
   namespace chooseInvoice {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
     }
 
-    interface SuccessCallbackResult extends General.CallbackResult {
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 用户选中的发票信息，格式为一个 JSON 字符串，包含三个字段： card_id：所选发票卡券的 cardId，encrypt_code：所选发票卡券的加密 code，报销方可以通过 cardId 和 encryptCode 获得报销发票的信息，app_id： 发票方的 appId。 */
       invoiceInfo: string
       /** 调用结果 */
@@ -65,19 +55,33 @@ declare namespace Taro {
     }
   }
 
-  /** 选择用户已有的发票。
-   *
-   * **通过 cardId 和 encryptCode 获得报销发票的信息**
-   * 请参考[微信电子发票文档](https://mp.weixin.qq.com/wiki?t=resource/res_main&id=21517918939oae3U)中，「查询报销发票信息」部分。
-   * 其中 `access_token` 的获取请参考[auth.getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)文档
-   * @supported weapp
-   * @example
-   ```tsx
-   * Taro.chooseInvoice({
-   *   success: function (res) {}
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/invoice/wx.chooseInvoice.html
-   */
-  function chooseInvoice(option?: chooseInvoice.Option): Promise<chooseInvoice.SuccessCallbackResult>
+  interface TaroStatic {
+    /** 选择用户的发票抬头。当前小程序必须关联一个公众号，且这个公众号是完成了[微信认证](https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1496554031_RD4xe)的，才能调用 chooseInvoiceTitle。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.chooseInvoiceTitle({
+     *   success: function(res) {}
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/invoice/wx.chooseInvoiceTitle.html
+     */
+    chooseInvoiceTitle(option?: chooseInvoiceTitle.Option): Promise<chooseInvoiceTitle.SuccessCallbackResult>
+
+    /** 选择用户已有的发票。
+     *
+     * **通过 cardId 和 encryptCode 获得报销发票的信息**
+     * 请参考[微信电子发票文档](https://mp.weixin.qq.com/wiki?t=resource/res_main&id=21517918939oae3U)中，「查询报销发票信息」部分。
+     * 其中 `access_token` 的获取请参考[auth.getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)文档
+     * @supported weapp
+     * @example
+     ```tsx
+     * Taro.chooseInvoice({
+     *   success: function (res) {}
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/invoice/wx.chooseInvoice.html
+     */
+    chooseInvoice(option?: chooseInvoice.Option): Promise<chooseInvoice.SuccessCallbackResult>
+  }
 }