@tarojs/taro 4.0.0-beta.1 → 4.0.0-beta.2

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

@@ -35,7 +35,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 获取当前帐号信息
-     * @supported weapp
+     * @supported weapp, alipay, qq
      * @example
      * ```tsx
      * const accountInfo = Taro.getAccountInfoSync();

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

@@ -14,7 +14,9 @@ declare module '../../index' {
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 收货人姓名 */
       userName: string
-      /** 邮编 */
+      /** 邮编
+       * @supported weapp, qq
+       */
       postalCode: string
       /** 国标收货地址第一级地址 */
       provinceName: string
@@ -22,13 +24,19 @@ declare module '../../index' {
       cityName: string
       /** 国标收货地址第三级地址 */
       countyName: string
-      /** 国标收货地址第四级地址 */
+      /** 国标收货地址第四级地址
+       * @supported weapp, qq
+       */
       streetName: string
       /** 详细收货地址信息 */
       detailInfo: string
-      /** 新选择器详细收货地址信息 */
+      /** 新选择器详细收货地址信息
+       * @supported weapp, qq
+       */
       detailInfoNew: string
-      /** 收货地址国家码 */
+      /** 收货地址国家码
+       * @supported weapp, qq
+       */
       nationalCode: string
       /** 收货人手机号码 */
       telNumber: string
@@ -37,7 +45,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 获取用户收货地址。调起用户编辑收货地址原生界面，并在编辑完成后返回用户选择的地址。
-     * @supported weapp, tt
+     * @supported weapp, qq, tt, jd
      * @example
      * ```tsx
      * Taro.chooseAddress({

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

@@ -55,7 +55,7 @@ declare module '../../index' {
      authorizeForMiniProgram(option: authorizeForMiniProgram.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据，但不会实际调用对应接口。如果用户之前已经同意授权，则不会出现弹窗，直接返回成功。更多用法详见 [用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html)。
-     * @supported weapp, rn, tt
+     * @supported weapp, swan, qq, tt, rn
      * @example
      * ```tsx
      * // 可以通过 Taro.getSetting 先查询一下用户是否授权了 "scope.record" 这个 scope

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

@@ -0,0 +1,307 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace insertBookshelf {
+    interface Option {
+      /** 添加的内容分类 */
+      category: keyof Category | string
+      /** 要添加到书架内容的 id，支持传多个，最多 100 条；注释：contentId 为内容 id，内容的唯一标识，自定义，最长 22 字符（不能含有空格、中文字符） */
+      contentIds: string[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => void
+    }
+    interface Category {
+      /** 专栏模板 */
+      article
+      /** 文档模板 */
+      doc
+      /** 动漫模板 */
+      cartoon
+      /** 影音模板 */
+      av
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 添加到书架的结果列表 */
+      list: IListItem[]
+    }
+    interface IListItem {
+      /** 内容的唯一标识 */
+      contentId: string
+      /** 添加状态：值为 0 时是失败，为 1 时是成功 */
+      status: keyof Status
+      /** 添加信息 */
+      msg: string
+    }
+    interface Status {
+      /** 失败 */
+      0
+      /** 成功 */
+      1
+    }
+  }
+  
+  namespace deleteBookshelf {
+    interface Option {
+      /** 要删除的内容分类 */
+      category: keyof Category | string
+      /** 要删除书架内容的 id，支持传多个，最多 100 条；注释：contentId 为内容 id，内容的唯一标识，自定义，最长 22 字符（不能含有空格、中文字符）。支持批量删除的同一个 category 下的多个 id，不同 category 下的 id 请分别调用该接口删除 */
+      contentIds: string[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => void
+    }
+    interface Category {
+      /** 专栏模板 */
+      article
+      /** 文档模板 */
+      doc
+      /** 动漫模板 */
+      cartoon
+      /** 影音模板 */
+      av
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 添加到书架的结果列表 */
+      list: IListItem[]
+    }
+    interface IListItem {
+      /** 内容的唯一标识 */
+      contentId: string
+      /** 删除状态：值为 0 时是失败，为 1 时是成功 */
+      status: keyof Status
+      /** 删除信息 */
+      msg: string
+    }
+    interface Status {
+      /** 失败 */
+      0
+      /** 成功 */
+      1
+    }
+  }
+
+  namespace queryBookshelf {
+    interface Option {
+      /** 要查询内容的 id，支持传多个，最多 100 条；注释：contentId 为内容 id，内容的唯一标识，自定义，最长 22 字符（不能含有空格、中文字符） */
+      contentIds: string[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 查询的内容结果列表 */
+      list: IListItem[]
+    }
+    interface IListItem {
+      /** 内容的唯一标识 */
+      contentId: string
+      /** 状态 */
+      status: keyof Status
+    }
+    interface Status {
+      /** 不存在 */
+      0
+      /** 存在 */
+      1
+    }
+  }
+  
+  namespace updateBookshelfReadTime {
+    interface Option {
+      /** 添加的内容分类 */
+      category: keyof Category | string
+      /** 要更新内容的 id；注释：contentId 为内容 id，内容的唯一标识，自定义，最长 22 字符（不能含有空格、中文字符） */
+      contentIds: string[] 
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => void
+    }
+    interface Category {
+      /** 专栏模板 */
+      article
+      /** 文档模板 */
+      doc
+      /** 动漫模板 */
+      cartoon
+      /** 影音模板 */
+      av
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 更新状态 */
+      status: keyof Status
+      /** 更新的结果信息 */
+      msg: string
+    }
+    interface Status {
+      /** 失败 */
+      0
+      /** 成功 */
+      1
+    }
+  }
+
+  namespace navigateToBookshelf {
+    interface Option {
+      /** 跳转到指定的内容分类
+       * @supported swan
+       */
+      category: keyof Category | string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+    interface Category {
+      /** 专栏模板 */
+      article
+      /** 文档模板 */
+      doc
+      /** 动漫模板 */
+      cartoon
+      /** 影音模板 */
+      av
+    }
+  }
+
+  interface TaroStatic {
+    /** 添加内容到宿主书架
+     * @supported swan, qq
+     * @swan （需宿主支持书架入口）
+     * @example
+     * ```tsx
+     * Taro.insertBookshelf({
+     *   category: 'doc',
+     *   contentIds: ['test1', 'test2'],
+     *   success(res) {
+     *     Taro.showModal({
+     *       title: 'success',
+     *       content: JSON.stringify(res)
+     *     })
+     *   },
+     *   fail(err) {
+     *     Taro.showModal({
+     *       title: 'fail',
+     *       content: JSON.stringify(err)
+     *     })
+     *   }
+     * })
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-insertBookshelf/
+     */
+    insertBookshelf(option: insertBookshelf.Option): void
+
+    /** 删除书架中的内容（需宿主支持书架入口)
+     * @supported swan
+     * @example
+     * ```tsx
+     * Taro.deleteBookshelf({
+     *   category: 'doc',
+     *   contentIds: ['test1', 'test2'],
+     *   success(res) {
+     *     Taro.showModal({
+     *       title: 'success',
+     *       content: JSON.stringify(res)
+     *     })
+     *   },
+     *   fail(err) {
+     *     Taro.showModal({
+     *       title: 'fail',
+     *       content: JSON.stringify(err)
+     *     })
+     *   }
+     * })
+     * ```
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-deleteBookshelf/
+     */
+    deleteBookshelf(option: deleteBookshelf.Option): void
+
+    /** 查询宿主书架的相关内容
+     * @supported swan, qq
+     * @swan （需宿主支持书架入口）
+     * @example
+     * ```tsx
+     * Taro.queryBookshelf({
+     *   contentIds: ['test1', 'test2'],
+     *   success(res) {
+     *     Taro.showModal({
+     *       title: 'success',
+     *       content: JSON.stringify(res)
+     *     })
+     *   },
+     *   fail(err) {
+     *     Taro.showModal({
+     *       title: 'fail',
+     *       content: JSON.stringify(err)
+     *     })
+     *   }
+     * })
+     * ```
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-queryBookshelf/
+     */
+    queryBookshelf(option: queryBookshelf.Option): void
+
+    /** 更新已加入宿主书架的内容的阅读时间
+     * @supported swan, qq
+     * @swan （需宿主支持书架入口）
+     * @example
+     * ```tsx
+     * Taro.updateBookshelfReadTime({
+     *   category: 'doc',
+     *   contentIds: 'test1',
+     *   success(res) {
+     *     Taro.showModal({
+     *       title: 'success',
+     *       content: JSON.stringify(res)
+     *     })
+     *   },
+     *   fail(err) {
+     *     Taro.showModal({
+     *       title: 'fail',
+     *       content: JSON.stringify(err)
+     *     })
+     *   }
+     * })
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-queryBookshelf/
+     */
+    updateBookshelfReadTime(option: updateBookshelfReadTime.Option): void
+    
+    /** 跳转到宿主书架
+     * @supported swan
+     * @swan （需宿主支持书架入口）
+     * @example
+     * ```tsx
+     * Taro.navigateToBookshelf({
+     *   category: 'article',
+     *   contentIds: 'test1',
+     *   success(res) {
+     *     Taro.showModal({
+     *       title: 'navigateToBookshelf',
+     *       content: 'success'
+     *     })
+     *   },
+     *   fail(err) {
+     *     Taro.showModal({
+     *       title: 'fail',
+     *       content: JSON.stringify(err)
+     *     })
+     *   }
+     * })
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-navigateToBookshelf/
+     */
+    navigateToBookshelf(option: navigateToBookshelf.Option): void
+  }
+}

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

@@ -118,6 +118,8 @@ declare module '../../index' {
       nickname: string
       /** 是否可预约 */
       reservable: boolean
+      /** 除最近的一条预告信息外，其他的预告信息列表（注意：每次最多返回按时间戳增序排列的15个预告信息，其中时间最近的那个预告信息会在接口其他的返回参数中展示，其余的预告信息会在该字段中展示）。 */
+      otherInfos?: string[]
     }
     interface Status {
       /** 可用 */
@@ -154,6 +156,10 @@ declare module '../../index' {
       headUrl: string
       /** 视频号昵称 */
       nickname: string
+      /** 直播回放状态 */
+      replayStatus: keyof ReplayStatus | number
+      /** 除最近的一条直播外，其他的直播列表（注意：每次最多返回按时间戳增序排列的15个直播信息，其中时间最近的那个直播会在接口其他的返回参数中展示，其余的直播会在该字段中展示）。 */
+      otherInfos?: string[]
     }
     interface Status {
       /** 直播中 */
@@ -161,6 +167,16 @@ declare module '../../index' {
       /** 直播结束 */
       3
     }
+    interface ReplayStatus {
+      /** 未生成 */
+      0
+      /** 已生成 */
+      1
+      /** 生成中 */
+      3
+      /** 已过期 */
+      6
+    }
   }
 
   interface TaroStatic {

package/types/api/open-api/device-voip.d.ts

@@ -50,12 +50,52 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 请求用户授权与设备（组）间进行音视频通话
+     * @example
+     * ```tsx
+     * // 授权单台设备
+     * Taro.requestDeviceVoIP({
+     *   sn: 'xxxx',
+     *   snTicket: 'xxxxx',
+     *   modelId: 'xxx',
+     *   deviceName: 'xxx',
+     *   success(res) {
+     *     console.log(res)
+     *   },
+     *   fail(res) {
+     *     console.log(res)
+     *   }
+     * })
+     *
+     * // 批量授权（授权设备组）
+     * Taro.requestDeviceVoIP({
+     *   isGroup: true,
+     *   groupId: '设备组 ID',
+     *   success(res) {
+     *     console.log(res)
+     *   },
+     *   fail(res) {
+     *     console.log(res)
+     *   }
+     * })
+     * ```
+     *
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/device-voip/wx.requestDeviceVoIP.html
      */
     requestDeviceVoIP(option: requestDeviceVoIP.Option): Promise<TaroGeneral.CallbackResult>
     /** 查询当前用户授权的音视频通话设备（组）信息
      * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.getDeviceVoIPList({
+     *   success(res) {
+     *     console.log(res)
+     *   },
+     *   fail(res) {
+     *     console.log(res)
+     *   }
+     * })
+     * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/device-voip/wx.getDeviceVoIPList.html
      */
     getDeviceVoIPList(option: getDeviceVoIPList.Option): Promise<getDeviceVoIPList.SuccessCallbackResult>

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

@@ -75,7 +75,7 @@ declare module '../../index' {
      * 其中 `access_token` 的获取请参考[auth.getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)文档
      * @supported weapp
      * @example
-     ```tsx
+     * ```tsx
      * Taro.chooseInvoice({
      *   success: function (res) {}
      * })

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

@@ -26,12 +26,25 @@ declare module '../../index' {
       success?: (result: SuccessCallbackResult) => void
       /** 超时时间，单位ms */
       timeout?: number
+      /** 未登录时, 是否强制调起登录框
+       * @supported tt
+       * @default true
+       */
+      force?: boolean
     }
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 用户登录凭证（有效期五分钟）。开发者需要在开发者服务器后台调用 [auth.code2Session](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/login/auth.code2Session.html)，使用 code 换取 openid 和 session_key 等信息 */
       code: string
       /** 调用结果 */
       errMsg: string
+      /** 用于标识当前设备, 无论登录与否都会返回, 有效期 5 分钟。
+       * @supported tt
+       */
+      anonymousCode?: string
+      /** 判断在当前 APP（头条、抖音等）是否处于登录状态。
+       * @supported tt
+       */
+      isLogin?: boolean
     }
   }
 
@@ -54,7 +67,7 @@ declare module '../../index' {
     pluginLogin(option?: pluginLogin.Option): Promise<pluginLogin.SuccessCallbackResult>
 
     /** 调用接口获取登录凭证（code）。通过凭证进而换取用户登录态信息，包括用户的唯一标识（openid）及本次登录的会话密钥（session_key）等。用户数据的加解密通讯需要依赖会话密钥完成。更多使用方法详见 [小程序登录](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/login.html)。
-     * @supported weapp
+     * @supported weapp, jd, qq, tt, harmony_hybrid
      * @example
      * ```tsx
      * Taro.login({
@@ -82,7 +95,7 @@ declare module '../../index' {
      * 通过 Taro.login 接口获得的用户登录态拥有一定的时效性。用户越久未使用小程序，用户登录态越有可能失效。反之如果用户一直在使用小程序，则用户登录态一直保持有效。具体时效逻辑由微信维护，对开发者透明。开发者只需要调用 Taro.checkSession 接口检测当前用户登录态是否有效。
      *
      * 登录态过期后开发者可以再调用 Taro.login 获取新的用户登录态。调用 Taro.checkSession 成功说明当前 session_key 未过期，调用失败说明 session_key 已过期。更多使用方法详见 [小程序登录](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/login.html)。
-     * @supported weapp
+     * @supported weapp, swan, qq, tt
      * @example
      * ```tsx
      * Taro.checkSession({

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

@@ -80,6 +80,14 @@ declare module '../../index' {
     /**
      * 跳转至隐私协议页面。隐私合规开发指南详情可见《小程序隐私协议开发指南》
      * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.openPrivacyContract({
+     *   success: () => {}, // 打开成功
+     *   fail: () => {}, // 打开失败
+     *   complete: () => {}
+     * })
+     * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/privacy/wx.openPrivacyContract.html
      */
     openPrivacyContract(option?: openPrivacyContract.Option): void

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

@@ -5,6 +5,7 @@ declare module '../../index' {
     interface Option {
       /**
        * 是否同时获取用户订阅消息的订阅状态，默认不获取。注意：withSubscriptions 只返回用户勾选过订阅面板中的“总是保持以上选择，不再询问”的订阅消息。
+       * @default false
        */
       withSubscriptions?: boolean
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
@@ -135,7 +136,7 @@ declare module '../../index' {
     /** 调起客户端小程序设置界面，返回用户设置的操作结果。**设置界面只会出现小程序已经向用户请求过的[权限](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html)**。
      *
      * 注意：[2.3.0](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 版本开始，用户发生点击行为后，才可以跳转打开设置页，管理授权信息。[详情](https://developers.weixin.qq.com/community/develop/doc/000cea2305cc5047af5733de751008)
-     * @supported weapp, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, rn, harmony_hybrid
      * @example
      * ```tsx
      * Taro.openSetting({
@@ -153,7 +154,7 @@ declare module '../../index' {
     openSetting(option?: openSetting.Option): Promise<openSetting.SuccessCallbackResult>
 
     /** 获取用户的当前设置。**返回值中只会出现小程序已经向用户请求过的[权限](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html)**。
-     * @supported weapp, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, rn, harmony_hybrid
      * @example
      * ```tsx
      * Taro.getSetting({

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

@@ -0,0 +1,83 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace openStickerSetView {
+    interface Option {
+      /** 表情专辑链接，可前往[表情开放平台](https://sticker.weixin.qq.com/cgi-bin/mmemoticonwebnode-bin/pages/home)，在详情页中的「小程序跳转链接」入口复制 */
+      url: Object
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace openStickerIPView {
+    interface Option {
+      /** 表情IP合辑链接，可前往[表情开放平台](https://sticker.weixin.qq.com/cgi-bin/mmemoticonwebnode-bin/pages/home)，在详情页中的「小程序跳转链接」入口复制 */
+      url: Object
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace openSingleStickerView {
+    interface Option {
+      /** 表情链接，可前往(表情开放平台)[https://sticker.weixin.qq.com/cgi-bin/mmemoticonwebnode-bin/pages/home]，在详情页中的「小程序跳转链接」入口复制 */
+      url: Object
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  interface TaroStatic {
+    /** 打开表情专辑
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.openStickerSetView({
+     *   url: '',
+     *   success(res) {}
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/sticker/wx.openStickerSetView.html
+     */
+    openStickerSetView(option: openStickerSetView.Option): void
+
+    /** 打开表情IP合辑
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.openStickerIPView({
+     *   url: '',
+     *   success(res) {}
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/sticker/wx.openStickerIPView.html
+     */
+    openStickerIPView(option: openStickerIPView.Option): void
+    
+    /** 打开单个表情
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.openSingleStickerView({
+     *   url: '',
+     *   success(res) {}
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/sticker/wx.openSingleStickerView.html
+     */
+    openSingleStickerView(option: openSingleStickerView.Option): void
+  }
+}