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

package/types/api/swan/download-package.d.ts

@@ -0,0 +1,80 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace downloadPackage {
+    interface Option {
+      /** 预下载的小程序的 appKey */
+      appKey: string
+      /** 预下载的小程序的 pageUrl ，默认值为小程序的首页页面 */
+      pageUrl?: string
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: TaroGeneral.CallbackResult) => any
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => any
+    }
+  }
+
+  namespace downloadPackages {
+    interface Option {
+      /** 预下载的小程序的列表。 */
+      pageList: IPageItem[]
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: TaroGeneral.CallbackResult) => any
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => any
+    }
+    interface IPageItem {
+      /** 预下载的小程序的 appKey */
+      appKey: string
+      /** 页面路径 */
+      pages: string[]
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 小程序包预下载结果回调 */
+      [key: string]: IAppKeyResult[]
+    }
+    interface IAppKeyResult {
+      /** 页面路径 */
+      pageUrl: string
+      /** 预下载能力调用结果。值为 "0" 时是成功，非 "0" 时是失败 */
+      status: string
+      /** 预下载结果信息 */
+      message: string
+    }
+  }
+
+  namespace loadSubPackage {
+    interface Option {
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: TaroGeneral.CallbackResult) => any
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => any
+    }
+  }
+
+  interface TaroStatic {
+    /** 针对在小程序中调用其他小程序的场景，预下载其他小程序的包内容。
+     * Web 态说明：Web 态不支持预下载的能力。
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-downloadPackage/
+     */
+    downloadPackage(option: downloadPackage.Option): void
+    /** 针对在小程序中调用其他小程序的场景，预下载其他小程序的包内容。
+     * Web 态说明：Web 态不支持预下载的能力。
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-downloadPackages/
+     */
+    downloadPackages(option: downloadPackages.Option): void
+    /** 提前下载好子包的资源，目录结构配置参考[分包加载](https://smartprogram.baidu.com/docs/develop/framework/subpackages/)。
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-loadSubPackage/
+     */
+    loadSubPackage(option: loadSubPackage.Option): void
+  }
+}

package/types/api/swan/index.d.ts

@@ -54,6 +54,116 @@ declare module '../../index' {
     }
   }
 
+  namespace setMetaDescription {
+    interface Option {
+      /** 需要设置的 description 内容 */
+      content: string
+      /** 接口调用成功的回调函数 */
+      success?: (res: any) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: any) => any
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: any) => any
+    }
+  }
+
+  namespace setMetaKeywords {
+    interface Option {
+      /** 需要设置的 keywords 内容 */
+      content: string
+      /** 接口调用成功的回调函数 */
+      success?: (res: any) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: any) => any
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: any) => any
+    }
+  }
+
+  namespace setDocumentTitle {
+    interface Option {
+      /** 页面中 title 标签中的内容 */
+      title: string
+      /** 接口调用成功的回调函数 */
+      success?: (res: any) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: any) => any
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: any) => any
+    }
+  }
+
+  namespace getSystemRiskInfo {
+    interface Option {
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: any) => any
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: any) => any
+    }
+    interface SuccessCallbackResult {
+      /** 用于获取风控信息的加密信息对象。
+       * 要获取风控信息，需要和[风控检测](https://smartprogram.baidu.com/docs/develop/serverapi/open_risk_power/#detectrisk/)接口联合使用，并作为风控检测接口的 xtoken 参数传入。
+       */
+      content: Object
+    }
+    interface IContent {
+      key: string
+      value: string
+    }
+  }
+
+  namespace getFavorStatus {
+    interface Option {
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: any) => any
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: any) => any
+    }
+    interface SuccessCallbackResult {
+      /** 用户关注关注状态，1表示已关注，0表示未关注 */
+      isFavor: string
+    }
+  }
+
+  namespace getTopStatus {
+    interface Option {
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: any) => any
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: any) => any
+    }
+    interface SuccessCallbackResult {
+      /** 置顶状态 */
+      isTop: boolean
+    }
+  }
+
+  namespace openBdboxWebview {
+    interface Option {
+      /** 跳转百度 App 特定页面的 scheme 的 module */
+      module?: string
+      /** 跳转百度 App 特定页面的 scheme 的 action */
+      action?: string
+      /** 跳转百度 App 特定页面的 scheme 的 path */
+      path?: string
+      /** 跳转百度 App 特定页面的 scheme 的 authority */
+      authority?: string
+      /** 跳转百度 App 特定页面的 scheme 的参数 */
+      parameters?: Object
+      /** 接口调用成功的回调函数 */
+      success?: (res: any) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: any) => any
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: any) => any
+    }
+  }
   interface TaroStatic {
     /**
      * 百度智能小程序可接入百度搜索和百度 App，setPageInfo 负责为小程序设置各类页面基础信息，包括标题、关键字、页面描述以及图片信息、视频信息等。开发者为智能小程序设置完备的页面基础信息，有助于智能小程序在搜索引擎和信息流中得到更加有效的展示和分发。
@@ -96,5 +206,46 @@ declare module '../../index' {
      * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-setPageInfo/
      */
     setPageInfo(option: setPageInfo.Option): void
+    /** 设置 web 版小程序 description meta 信息。此方法为 web 版小程序专用方法，使用前需判断方法是否存在。
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-setMetaDescription/
+     */
+    setMetaDescription(option: setMetaDescription.Option): void
+    /** 设置 web 版小程序 keywords meta 信息。此方法为 web 版小程序专用方法，使用前需判断方法是否存在。
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-setMetaKeywords/
+     */
+    setMetaKeywords(option: setMetaKeywords.Option): void
+    /** 动态设置当前页面的标题。此方法为 web 版小程序专用方法，使用前需判断方法是否存在。
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-setDocumentTitle/
+     */
+    setDocumentTitle(option: setDocumentTitle.Option): void
+    /** 获取用于得到风控信息的加密信息对象。更多小程序风控能力参见[风控服务](https://smartprogram.baidu.com/docs/develop/serverapi/open_risk_power/)。
+     * Web 态说明：Web 态小程序暂不支持获取用于得到风控信息的加密信息对象。
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-getSystemRiskInfo/
+     */
+    getSystemRiskInfo(option: getSystemRiskInfo.Option): void
+    /** 获取小程序用户关注状态。
+     * Web 态说明：Web 态小程序暂不支持关注小程序。
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-getFavorStatus/
+     */
+    getFavorStatus(option: getFavorStatus.Option): void
+    /** 获取小程序用户置顶状态。
+     * Web 态说明：Web 态小程序暂不支持获取置顶状态，降级调起百度 App。
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-getTopStatus/
+     */
+    getTopStatus(option: getTopStatus.Option): void
+    /** 小程序跳转百度 App 内特定页面。接入本 API 的开发者，需要了解跳转页面的 scheme，并根据文档调用 API 完成跳转。可在百度 App 中，通过将跳转页面 scheme 生成对应二维码，并使用百度 APP 相机扫描二维码调起的方式，来确保 scheme 是否正确。
+     *  Web 态说明：
+     *   1.由于浏览器的限制，Web 态暂时无法准确获取跳转百度 App 成功 / 失败状态，会执行失败回调；
+     *   2.在用户未安装手百、部分第三方浏览器封禁百度 App 的情况下，Web 态会尝试降级调起应用商店。
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-openBdboxWebview/
+     */
+    openBdboxWebview(option: openBdboxWebview.Option): void
   }
 }

package/types/api/swan/pay.d.ts

@@ -0,0 +1,139 @@
+import { Interface } from 'readline'
+import Taro from '../../index'
+
+declare module '../../index'  {
+
+  namespace requestPolymerPayment {
+    interface Option {
+      /** 订单信息 */
+      orderInfo: OrderInfo
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: FailCallbackResult) => any
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => any
+    }
+    interface OrderInfo {
+      /** 跳转百度收银台支付必带参数之一，是百度收银台的财务结算凭证，与账号绑定的结算协议一一对应，每笔交易将结算到 dealId 对应的协议主体。
+       * 详见[核心参数获取与组装](https://smartprogram.baidu.com/docs/develop/function/parameter/)。
+       */
+      dealId: string
+      /** 支付能力开通后分配的支付 appKey，用以表示应用身份的唯一 ID ，在应用审核通过后进行分配，一经分配后不会发生更改，来唯一确定一个应用。
+       * 详见[核心参数获取与组装](https://smartprogram.baidu.com/docs/develop/function/parameter/)。
+       */
+      appKey: string
+      /** 订单金额（单位：人民币分）。注：小程序测试包测试金额不可超过 1000 分 */
+      totalAmount: string
+      /** 小程序开发者系统创建的唯一订单 ID ，当支付状态发生变化时，会通过此订单 ID 通知开发者。 */
+      tpOrderId: string
+      /** 通知开发者支付状态的回调地址，必须是合法的 URL ，与开发者平台填写的支付回调地址作用一致，未填写的以平台回调地址为准 */
+      notifyUrl?: string
+      /** 订单的名称。 */
+      dealTitle: string
+      /** 用于区分验签字段范围，signFieldsRange 的值：0：原验签字段 appKey+dealId+tpOrderId；1：包含 totalAmount 的验签，验签字段包括appKey+dealId+tpOrderId+totalAmount。固定值为 1 。 */
+      signFieldsRange: string
+      /** 对appKey+dealId+totalAmount+tpOrderId进行 RSA 加密后的签名，防止订单被伪造。
+       * 签名过程见[签名与验签](https://smartprogram.baidu.com/docs/develop/function/sign_v2/)。
+       */
+      rsaSign: string
+      /** 订单详细信息，需要是一个可解析为 JSON Object 的字符串。
+       * 字段内容见： [bizInfo 组装](https://smartprogram.baidu.com/docs/develop/function/parameter/#%E9%80%9A%E7%94%A8%E5%8F%82%E6%95%B0%E7%BB%84%E8%A3%85)。
+       */
+      bizInfo?: string
+      /** 当前页面 path。Web 态小程序支付成功后跳回的页面路径，例如：'/pages/payResult/payResult' */
+      payResultUrl?: string
+      /**
+       * 内嵌支付组件返回的支付信息加密 key，与[内嵌支付组件](https://smartprogram.baidu.com/docs/develop/component/inline_payment_panel)配套使用，此值不传或者传空时默认调起支付面板。
+       */
+      inlinePaySign?: string
+      /** 平台营销信息，此处传可使用平台券的 spuid，支持通过英文逗号分割传入多个 spuid 值，仅与百度合作平台类目券的开发者需要填写 */
+      promotionTag?: string
+    }
+
+    interface FailCallbackResult extends TaroGeneral.CallbackResult {
+      /** 错误码 */
+      errCode: number
+      /** 详细错误信息。
+       * 注: 目前仅在内嵌支付组件调起 swan.requestPolymerPayment 时，选择数字人民币 APP 渠道支付且用户未下载数字人民币 APP 时，返回具体错误信息 data。
+       */
+      data: DetailFailData
+    }
+    interface DetailFailData {
+      /** 详细错误码。20014 表示【未下载数字人民币 APP】 */
+      subErrCode: number
+      /** 详细错误信息 */
+      subErrMsg: string
+    }
+  }
+
+  namespace getOptimalPriceInfo {
+    interface Option {
+      /** 商品信息 */
+      productsInfo: ProductInfo[]
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: TaroGeneral.CallbackResult) => any
+    }
+
+    interface ProductInfo {
+      /** 支付的 appKey */
+      appKey: string
+      /** 商品信息 */
+      products: Product[]
+    }
+    interface Product {
+      /** 商品单价(原价) */
+      amount: number
+      /** 商品标识 */
+      promotionTag?: string
+      /** 开发者自定义商品 ID，在success回调中，会与减免信息一起返回。*/
+      productId: string
+    }
+
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 商品信息 */
+      productsInfo: ProductInfoSuccess[]
+    }
+    interface ProductInfoSuccess {
+      /** 支付的 appKey */
+      appKey: string
+      /** 减免后的商品信息 */
+      products: ProductSuccess[]
+    }
+    interface ProductSuccess {
+      /** 商品单价(原价) */
+      amount: number
+      /** 开发者自定义商品 ID */
+      productId: string
+      /** 商品标识 */
+      promotionTag: string
+      /** 百度平台券减免金额 */
+      reduceAmount: number
+      /** 百度平台券减免后金额 */
+      afterPayAmount: number
+    }
+  }
+
+  interface TaroStatic {
+    /** 
+     * 1）百度收银台，聚合了主流的百度钱包、微信、支付宝、网银等多种支付渠道，方便开发者一站式快速接入多种支付渠道，让百度用户能在智能小程序场景下，直接完成支付、交易闭环，提升用户支付体验的同时，提高智能小程序的订单转化率。
+     * 2）上述支付渠道在 C 端收银台有两种展示方式，开发者可以选择其中一种实现。
+     * 方式一：将支付渠道内嵌在小程序提单页面中，实现方式参考文档[inline-payment-panel内嵌支付组件](https://smartprogram.baidu.com/docs/develop/component/inline_payment_panel/)。
+     * 方式二：在用户确认订单后，调起收银台半屏面板承载支付渠道，实现方式参考文档调起[百度收银台](https://smartprogram.baidu.com/docs/develop/function/tune_up_2.0/#%E7%99%BE%E5%BA%A6%E6%94%B6%E9%93%B6%E5%8F%B0%E6%8E%A5%E5%8F%A32-0-%E8%AF%B4%E6%98%8E)。
+     * 
+     * Web 态说明：为了保证用户交易行为全流程闭环体验，在 Web 态下调用该方法会做打开百度 App 对应小程序页面的降级处理。
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/payment_swan-requestPolymerPayment/
+     */
+    requestPolymerPayment(option: requestPolymerPayment.Option): void
+    /** 获取商品使用百度平台券后的价格
+     * 通过百度收银台支付的商品，用户在支付时可以享受百度平台券提供的优惠。
+     * 使用 API swan.getOptimalPriceInfo 可以提前获知用户在支付时享受的优惠价格。（当用户有多张平台券时，按照平台最优优惠价格计算，与支付时默认选中的优惠券对应的优惠一致）
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/payment_swan-getOptimalPriceInfo/
+     */
+    getOptimalPriceInfo(option: getOptimalPriceInfo.Option): void
+  }
+}

package/types/api/taro.extend.d.ts

@@ -38,13 +38,16 @@ declare module '../index' {
   /** @ignore */
   interface TARO_ENV_TYPE {
     [TaroGeneral.ENV_TYPE.WEAPP]: TaroGeneral.ENV_TYPE.WEAPP
-    [TaroGeneral.ENV_TYPE.WEB]: TaroGeneral.ENV_TYPE.WEB
-    [TaroGeneral.ENV_TYPE.RN]: TaroGeneral.ENV_TYPE.RN
     [TaroGeneral.ENV_TYPE.SWAN]: TaroGeneral.ENV_TYPE.SWAN
     [TaroGeneral.ENV_TYPE.ALIPAY]: TaroGeneral.ENV_TYPE.ALIPAY
     [TaroGeneral.ENV_TYPE.TT]: TaroGeneral.ENV_TYPE.TT
     [TaroGeneral.ENV_TYPE.QQ]: TaroGeneral.ENV_TYPE.QQ
     [TaroGeneral.ENV_TYPE.JD]: TaroGeneral.ENV_TYPE.JD
+    [TaroGeneral.ENV_TYPE.WEB]: TaroGeneral.ENV_TYPE.WEB
+    [TaroGeneral.ENV_TYPE.RN]: TaroGeneral.ENV_TYPE.RN
+    [TaroGeneral.ENV_TYPE.HARMONY]: TaroGeneral.ENV_TYPE.HARMONY
+    [TaroGeneral.ENV_TYPE.QUICKAPP]: TaroGeneral.ENV_TYPE.QUICKAPP
+    [TaroGeneral.ENV_TYPE.HARMONYHYBRID]: TaroGeneral.ENV_TYPE.HARMONYHYBRID
   }
 
   namespace interceptorify {
@@ -97,7 +100,7 @@ declare module '../index' {
     }): void
 
     /** 小程序获取和 Taro 相关的 App 信息
-     * @supported weapp, alipay, jd, qq, swan, tt, h5, harmony
+     * @supported weapp, alipay, jd, qq, swan, tt, h5, harmony, harmony_hybrid
      */
     getAppInfo(): getAppInfo.AppInfo
 

package/types/api/taro.hooks.d.ts

@@ -46,7 +46,7 @@ declare module '../index' {
 
     /**
      * 当前是 tab 页时，tab 被点击时的回调。
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, rn, harmony_hybrid
      */
     useTabItemTap(callback: (payload: TabItemTapObject) => void): void
 
@@ -73,45 +73,45 @@ declare module '../index' {
 
     /**
      * 小程序初始化完成时的回调。
-     * @supported weapp, h5
+     * @supported weapp, h5, harmony_hybrid
      */
     useLaunch(callback: (options: getLaunchOptionsSync.LaunchOptions) => void): void
 
     /**
      * 小程序发生脚本错误或 API 调用报错时触发的回调。
-     * @supported weapp, h5
+     * @supported weapp, h5, harmony_hybrid
      */
     useError(callback: (error: string) => void): void
 
     /**
      * 小程序有未处理的 Promise reject 时触发。也可以使用 Taro.onUnhandledRejection 绑定监听。
-     * @supported weapp, alipay, h5
+     * @supported weapp, alipay, h5, harmony_hybrid
      */
     useUnhandledRejection(callback: (error: { reason: Error, promise: Promise<Error> }) => void): void
 
     /**
      * 小程序要打开的页面不存在时触发的回调。
-     * @supported weapp, h5
+     * @supported weapp, h5, harmony_hybrid
      * @h5 多页面模式不支持该方法
      */
     usePageNotFound(callback: (res: { path: string, query: Record<any, any>, isEntryPage: boolean, [key: string]: any }) => void): void
 
     /**
      * 页面加载完成时的回调。
-     * @supported weapp, h5
+     * @supported weapp, h5, harmony_hybrid
      */
     useLoad<T extends {} = Record<string, any>>(callback: (param: T) => void): void
 
     /**
      * 页面卸载时的回调。
-     * @supported weapp, h5
+     * @supported weapp, h5, harmony_hybrid
      */
     useUnload(callback: () => void): void
 
     /**
      * 页面初次渲染完成的回调。
      * 此时页面已经准备妥当，可以和视图层进行交互。
-     * @supported weapp, h5
+     * @supported weapp, h5, harmony_hybrid
      */
     useReady(callback: () => void): void
 
@@ -135,7 +135,7 @@ declare module '../index' {
 
     /**
      * 下拉中断时的回调。
-     * @supported alipay, h5
+     * @supported alipay, h5, harmony_hybrid
      */
     usePullIntercept(callback: () => void): void
   }