@tarojs/taro 3.8.0-canary.0 → 4.0.0-alpha.2

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

@@ -0,0 +1,107 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace getPrivacySetting {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 是否需要用户授权隐私协议（如果开发者没有在[mp后台-设置-服务内容声明-用户隐私保护指引]中声明隐私收集类型则会返回false；如果开发者声明了隐私收集，且用户之前同意过隐私协议则会返回false；如果开发者声明了隐私收集，且用户还没同意过则返回true；如果用户之前同意过、但后来小程序又新增了隐私收集类型也会返回true） */
+      needAuthorization: boolean
+      /** 隐私授权协议的名称 */
+      privacyContractName: string
+    }
+  }
+
+  namespace requirePrivacyAuthorize {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace openPrivacyContract {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace onNeedPrivacyAuthorization {
+    /**
+     * resolve 是 onNeedPrivacyAuthorization 的回调参数，是一个接口函数。
+     * 当触发 needPrivacyAuthorization 事件时，触发该事件的隐私接口或组件会处于 pending 状态。
+     * 如果调用 resolve({ buttonId: 'disagree-btn'， event:'agree' })，则触发当前 needPrivacyAuthorization 事件的原隐私接口或组件会继续执行。其中 buttonId 为隐私同意授权按钮的id，为确保用户有同意的操作，基础库会检查对应的同意按钮是否被点击过。
+     * 如果调用 resolve({ event: 'disagree' })，则触发当前 needPrivacyAuthorization 事件的原隐私接口或组件会失败并返回 API:fail privacy permission is not authorized 的错误信息。
+     * 在调用 resolve({ event: 'agree'/'disagree' }) 之前，开发者可以调用 resolve({ event: 'exposureAuthorization' }) 把隐私弹窗曝光告知平台。
+     */
+    interface ResolveOption {
+      /** 用户操作类型 */
+      event: 'exposureAuthorization' | 'agree' | 'disagree'
+      /** 同意授权按钮的id （仅event=agree时必填） */
+      buttonId?: string
+    }
+    /**
+     * 触发本次 onNeedPrivacyAuthorization 事件的关联信息
+     */
+    interface EventInfo {
+      referrer: string
+    }
+
+    /** 隐私授权监听函数 */
+    type Listener = (
+      /** 事件回调函数 */
+      resolve: (option: ResolveOption) => void,
+      /** 关联事件信息 */
+      eventInfo: EventInfo
+    ) => void
+  }
+
+  interface TaroStatic {
+    /**
+     * 查询隐私授权情况。隐私合规开发指南详情可见《小程序隐私协议开发指南》
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/privacy/wx.getPrivacySetting.html
+     */
+    getPrivacySetting(option?: getPrivacySetting.Option): void
+    /**
+     * 跳转至隐私协议页面。隐私合规开发指南详情可见《小程序隐私协议开发指南》
+     * @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
+    /**
+     * 模拟隐私接口调用，并触发隐私弹窗逻辑。隐私合规开发指南详情可见《小程序隐私协议开发指南》
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/privacy/wx.requirePrivacyAuthorize.html
+     */
+    requirePrivacyAuthorize(option?: requirePrivacyAuthorize.Option): void
+    /**
+     * 监听隐私接口需要用户授权事件。当需要用户进行隐私授权时会触发。触发该事件时，开发者需要弹出隐私协议说明，并在用户同意或拒绝授权后调用回调接口 resolve 触发原隐私接口或组件继续执行。隐私合规开发指南详情可见《小程序隐私协议开发指南》
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/privacy/wx.onNeedPrivacyAuthorization.html
+     */
+    onNeedPrivacyAuthorization(listener: onNeedPrivacyAuthorization.Listener): 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
+  }
+}

package/types/api/open-api/subscribe-message.d.ts

@@ -3,8 +3,19 @@ import Taro from '../../index'
 declare module '../../index' {
   namespace requestSubscribeMessage {
     interface Option {
-      /** 需要订阅的消息模板的id的集合（注意：iOS客户端7.0.6版本、Android客户端7.0.7版本之后的一次性订阅/长期订阅才支持多个模板消息，iOS客户端7.0.5版本、Android客户端7.0.6版本之前的一次订阅只支持一个模板消息）消息模板id在[微信公众平台(mp.weixin.qq.com)-功能-订阅消息]中配置 */
+      /**
+       * 需要订阅的消息模板的id的集合（注意：iOS客户端7.0.6版本、Android客户端7.0.7版本之后的一次性订阅/长期订阅才支持多个模板消息，iOS客户端7.0.5版本、Android客户端7.0.6版本之前的一次订阅只支持一个模板消息）消息模板id在[微信公众平台(mp.weixin.qq.com)-功能-订阅消息]中配置
+       * @supported weapp, tt
+       */
       tmplIds: string[]
+      /** 需要订阅的消息模板 id 集合（注意：1、一次性模板 id 和长期性模板 id 不可同时使用，2、一次最多传入三个模板 id
+       * @supported alipay
+       */
+      entityIds: string[]
+      /** 模板小程序 appId，仅在服务商代调用场景下需要传入
+       * @supported alipay
+       */
+      thirdTypeAppId?: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
@@ -37,20 +48,90 @@ declare module '../../index' {
        * @type "accept" | "reject" | "ban"
        */
       [TEMPLATE_ID: string]: keyof TemplateReflex | string
+      /** 用户订阅操作结果。
+       *
+       * | 枚举值 | 描述 |
+       * | --- | ---- |
+       * | subscribe | 订阅成功 |
+       *
+       * @supported alipay
+       */
+      behavior?: string
+      /** 一次性订阅，是否勾选 总是保持以上选择，不再询问。
+       *
+       * | 枚举值 | 描述 |
+       * | --- | ---- |
+       * | true | 勾选 |
+       * | false | 未勾选 |
+       *
+       * @supported alipay
+       */
+      keep?: boolean
+      /** 长期性订阅，是否点击 拒绝，不再询问。
+       *
+       * | 枚举值 | 描述 |
+       * | --- | ---- |
+       * | true | 点击 |
+       * | false | 未点击 |
+       *
+       * @supported alipay
+       */
+      refuse?: boolean
+      /** 订阅数据
+       * @supported alipay
+       */
+      result?: ISubscribeResult
+      /** 本次订阅过程是否弹出了订阅面板。
+       *
+       * | 枚举值 | 描述 |
+       * | --- | ---- |
+       * | true | 弹出 |
+       * | false | 未弹出 |
+       *
+       * @supported alipay
+       */
+      show?: boolean
       /** 接口调用成功时errMsg值为'requestSubscribeMessage:ok' */
       errMsg: string
     }
 
+    interface ISubscribeResult {
+      /** 订阅成功的模板列表 */
+      subscribeEntityIds: string[]
+      /** 最终订阅成功的模板列表 */
+      subscribedEntityIds: string[]
+      /** 未订阅的模板列表 */
+      unsubscribedEntityIds: string[]
+      /** 本次新增订阅成功的模板列表 */
+      currentSubscribedEntityIds: string[]
+    }
+
     /** 模版消息订阅类型 */
     interface TemplateReflex {
-      /** 表示用户同意订阅该条id对应的模板消息 */
+      /**
+       * 表示用户同意订阅该条id对应的模板消息
+       * @supported weapp, alipay, tt
+       */
       accept
-      /** 表示用户拒绝订阅该条id对应的模板消息 */
+      /**
+       * 表示用户拒绝订阅该条id对应的模板消息
+       * @supported weapp, alipay, tt
+       */
       reject
-      /** 表示已被后台封禁 */
+      /**
+       * 表示已被后台封禁
+       * @supported weapp, tt
+       */
       ban
-      /** 表示该模板因为模板标题同名被后台过滤 */
+      /**
+       * 表示该模板因为模板标题同名被后台过滤
+       * @supported weapp
+       */
       filter
+      /** 表示该条 id 对应的模版消息授权失败
+       * @supported tt
+       */
+      fail
     }
   }
 
@@ -114,6 +195,19 @@ declare module '../../index' {
     }
   }
 
+  namespace unsubscribeMessage {
+    interface Option {
+      /** 需要取消订阅的消息模板 id 集合（注意：1、一次性模板 id 和长期性模板 id 不可同时使用，2、一次最多传入三个模板 id）。 */
+      entityIds: string[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
   interface TaroStatic {
     /** 请求订阅消息
      *
@@ -133,7 +227,7 @@ declare module '../../index' {
     ): Promise<requestSubscribeMessage.SuccessCallbackResult | requestSubscribeMessage.FailCallbackResult>
 
     /** 订阅设备消息接口，调用后弹出授权框，用户同意后会允许开发者给用户发送订阅模版消息。当用户点击“允许”按钮时，模板消息会被添加到用户的小程序设置页，通过 wx.getSetting 接口可获取用户对相关模板消息的订阅状态。
-     * @supported weapp, tt
+     * @supported weapp
      * @example
      * ```tsx
      * Taro.requestSubscribeDeviceMessage({
@@ -154,5 +248,53 @@ declare module '../../index' {
      requestSubscribeDeviceMessage(
       option: requestSubscribeDeviceMessage.Option
     ): Promise<requestSubscribeDeviceMessage.SuccessCallbackResult | requestSubscribeDeviceMessage.FailCallbackResult>
+
+    /** 取消当前用户已订阅的消息
+     * @supported alipay
+     * @example
+     * ```tsx
+     * Taro.unsubscribeMessage({
+     *   entityIds: [
+     *     'ac768fca1ce245ccae9404bb5243c49b',
+     *     '9aa357acb7c6434aba294aded1cdfb7c',
+     *   ],
+     *   success(res) {
+     *     console.log(res);
+     *   },
+     *   fail(err) {
+     *     console.log(err);
+     *   }
+     * })
+     * ```
+     * @see https://opendocs.alipay.com/mini/07vg26?pathHash=8c9630ac
+     */
+    unsubscribeMessage(option: unsubscribeMessage.Option): void
+
+    /** 小程序消息订阅服务，包括取消订阅和查询订阅；订阅操作详见 [form 表单](https://smartprogram.baidu.com/docs/develop/component/formlist_form/)。
+     * @supported swan
+     * @example
+     * ```tsx
+     * Taro.subscribeService({
+     *   templateId: 'BD0003',
+     *   subscribeId: '8026',
+     *   type: 'query',
+     *   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-subscribeService/
+     */
+    subscribeService(option: subscribeService.Option): void
+
   }
 }

package/types/api/open-api/user-info.d.ts

@@ -39,6 +39,11 @@ declare module '../../index' {
       lang?: keyof UserInfo.Language
       /** 声明获取用户个人信息后的用途，不超过30个字符 */
       desc: string
+      /** 当宿主未登录时，是否强制拉起登录框
+       * @supported tt
+       * @default false
+       */
+      force?: boolean
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
       /** 接口调用失败的回调函数 */
@@ -102,7 +107,7 @@ declare module '../../index' {
      *
      * **接口调整说明**
      * 在用户未授权过的情况下调用此接口，将不再出现授权弹窗，会直接进入 fail 回调（详见[《公告》](https://developers.weixin.qq.com/community/develop/doc/0000a26e1aca6012e896a517556c01))。在用户已授权的情况下调用此接口，可成功获取用户信息。
-     * @supported weapp, tt
+     * @supported weapp, jd, qq, tt, harmony_hybrid
      * @example
      * ```tsx
      * // 必须是在用户已经授权的情况下调用