@spcsn/taro 0.1.0

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

@@ -0,0 +1,139 @@
+import { Interface } from 'node: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

@@ -0,0 +1,233 @@
+import React from 'react'
+
+import Taro from '../index'
+
+declare module '../index' {
+  namespace getAppInfo {
+    /** 应用信息 */
+    interface AppInfo {
+      platform: string
+      taroVersion: string
+      designWidth: number | ((size?: string | number) => number)
+    }
+  }
+
+  namespace getCurrentInstance {
+    interface Current {
+      app: AppInstance | null
+      router: RouterInfo | null
+      page: PageInstance | null
+      onReady: string
+      onHide: string
+      onShow: string
+      preloadData?: Record<any, any>
+      /**
+       * RN 私有对象 navigationRef，用于使用底层接口控制路由
+       */
+      rnNavigationRef?: React.RefObject<any>
+    }
+  }
+
+  namespace setGlobalDataPlugin {
+    /** Vue3 插件，用于设置 `getApp()` 中的全局变量 */
+    interface Plugin {
+      install(app: any, data: any): void
+    }
+  }
+
+  /** @ignore */
+  interface TARO_ENV_TYPE {
+    [TaroGeneral.ENV_TYPE.WEAPP]: TaroGeneral.ENV_TYPE.WEAPP
+    [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
+    [TaroGeneral.ENV_TYPE.ASCF]: TaroGeneral.ENV_TYPE.ASCF
+  }
+
+  namespace interceptorify {
+    type promisifyApi<T, R> = (requestParams: T) => Promise<R>
+    interface InterceptorifyChain<T, R> {
+      requestParams: T
+      proceed: promisifyApi<T, R>
+    }
+    type InterceptorifyInterceptor<T, R> = (chain: InterceptorifyChain<T, R>) => Promise<R>
+    interface Interceptorify<T, R> {
+      request(requestParams: T): Promise<R>
+      addInterceptor(interceptor: InterceptorifyInterceptor<T, R>): void
+      cleanInterceptors(): void
+    }
+  }
+
+  interface TaroStatic {
+    /** @ignore */
+    Events: {
+      new (): TaroGeneral.Events
+    }
+
+    /** 事件中心
+     * @supported global
+     */
+    eventCenter: TaroGeneral.Events
+
+    /** @ignore */
+    ENV_TYPE: TARO_ENV_TYPE
+
+    /** 获取环境变量
+     * @supported global
+     */
+    getEnv(): TaroGeneral.ENV_TYPE
+
+    /** 尺寸转换
+     * @supported global
+     */
+    pxTransform(size: number): string
+
+    /** 尺寸转换初始化
+     * @supported global
+     */
+    initPxTransform(config: {
+      baseFontSize?: number
+      deviceRatio?: TaroGeneral.TDeviceRatio
+      designWidth?: number | ((size?: string | number) => number)
+      targetUnit?: string
+      unitPrecision?: number
+    }): void
+
+    /** 小程序获取和 Taro 相关的 App 信息
+     * @supported weapp, alipay, jd, qq, swan, tt, h5, harmony, harmony_hybrid
+     */
+    getAppInfo(): getAppInfo.AppInfo
+
+    getEnvInfoSync(): {
+      /** 小程序信息 */
+      microapp: {
+        /** 小程序版本号 */
+        mpVersion: string
+        /** 小程序环境 */
+        envType: string
+        /** 小程序 appId */
+        appId: string
+      }
+      /** 插件信息 */
+      plugin: Record<string, unknown>
+      /** 通用参数 */
+      common: {
+        /** 用户数据存储的路径 */
+        USER_DATA_PATH: string
+        /** 校验白名单属性中的 appInfoLaunchFrom 后返回额外信息 */
+        location: string | undefined
+        launchFrom: string | undefined
+        schema: string | undefined
+      }
+    }
+
+    /** 小程序引用插件 JS 接口
+     * @supported weapp, alipay, h5, rn, jd, qq, swan, tt, quickapp
+     */
+    requirePlugin: {
+      (pluginName: string): any
+      /** @supported weapp */
+      (pluginName: string, success?: (mod: any) => any, error?: (e: { mod: any; errMsg: string }) => any): any;
+      /** @supported weapp */
+      async?: (pluginName: string) => Promise<any>
+    }
+
+    /** 获取当前页面实例
+     * @supported global
+     */
+    getCurrentInstance(): getCurrentInstance.Current
+
+    /** @ignore */
+    Current: getCurrentInstance.Current
+
+    /** Vue3 插件，用于设置 `getApp()` 中的全局变量
+     * @supported weapp, alipay, h5, rn, jd, qq, swan, tt, quickapp, harmony_hybrid
+     * @example
+     * ```js
+     * // 使用插件
+     * const App = createApp(...)
+     * App.use(setGlobalDataPlugin, {
+     *   xxx: 999
+     * })
+     * // 获取全局变量
+     * Taro.getApp().xxx
+     * ```
+     */
+    setGlobalDataPlugin: setGlobalDataPlugin.Plugin
+
+    /** 获取自定义 TabBar 对应的 React 或 Vue 组件实例
+     * @supported weapp, jd
+     * @param page 小程序页面对象，可以通过 Taro.getCurrentInstance().page 获取
+     */
+    getTabBar<T>(page: getCurrentInstance.Current['page']): T | undefined
+
+    /** 获取当前页面渲染引擎类型
+     * @supported weapp
+     */
+    getRenderer(): 'webview' | 'skyline'
+
+    /**
+     * 包裹 promisify api 的洋葱圈模型
+     * @supported global
+     * @param promisifyApi
+     * @example
+     * ```tsx
+     * // 创建实例
+     * const modalInterceptorify = interceptorify(taro.showModal)
+     * // 添加拦截器
+     * modalInterceptorify.addInterceptor(async function (chain) {
+     *   const res = await chain.proceed({
+     *     ...chain.requestParams,
+     *     title: 'interceptor1'
+     *   })
+     *   return res
+     * })
+     * modalInterceptorify.addInterceptor(async function (chain) {
+     *   const res = await chain.proceed({
+     *     ...chain.requestParams,
+     *     content: 'interceptor2'
+     *   })
+     *   return res
+     * })
+     * // 使用
+     * modalInterceptorify.request({})
+     * ```
+     * @example
+     * ```tsx
+     * // 创建实例
+     * const fetchDataInterceptorify = interceptorify(taro.request)
+     * // 添加拦截器
+     * fetchDataInterceptorify.addInterceptor(async function (chain) {
+     *   taro.showLoading({
+     *     title: 'Loading...'
+     *   })
+     *   const res = await chain.proceed(chain.requestParams)
+     *   taro.hideLoading()
+     *   return res
+     * })
+     * fetchDataInterceptorify.addInterceptor(async function (chain) {
+     *   const params = chain.requestParams
+     *   const res = await chain.proceed({
+     *     url: 'http://httpbin.org' + params.url,
+     *   })
+     *   return res.data
+     * })
+     * // 使用
+     * fetchDataInterceptorify.request({
+     *   url: '/ip'
+     * }).then((res) => {
+     *   // log my ip
+     *   console.log(res.origin)
+     * })
+     * ```
+     */
+    interceptorify<T, R>(api: interceptorify.promisifyApi<T, R>): interceptorify.Interceptorify<T, R>
+  }
+}

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

@@ -0,0 +1,148 @@
+import Taro from '../index'
+
+declare module '../index' {
+  interface TaroStatic {
+    /**
+     * 页面展示时的回调。
+     * @supported global
+     */
+    useDidShow(callback: (options?: getLaunchOptionsSync.LaunchOptions) => void): void
+
+    /**
+     * 页面隐藏时的回调。
+     * @supported global
+     */
+    useDidHide(callback: () => void): void
+
+    /**
+     * 下拉刷新时的回调。
+     * @supported global
+     */
+    usePullDownRefresh(callback: () => void): void
+
+    /**
+     * 上拉触底时的回调。
+     * @supported global
+     */
+    useReachBottom(callback: () => void): void
+
+    /**
+     * 页面滚动时的回调。
+     * @supported global
+     */
+    usePageScroll(callback: (payload: PageScrollObject) => void): void
+
+    /**
+     * 页面尺寸改变时的回调。
+     * @supported global
+     */
+    useResize(callback: (payload: PageResizeObject) => void): void
+
+    /**
+     * 页面转发时的回调。
+     * @supported weapp
+     */
+    useShareAppMessage(callback: (payload: ShareAppMessageObject) => ShareAppMessageReturn): void
+
+    /**
+     * 当前是 tab 页时，tab 被点击时的回调。
+     * @supported weapp, h5, rn, harmony_hybrid
+     */
+    useTabItemTap(callback: (payload: TabItemTapObject) => void): void
+
+    /**
+     * 用户点击右上角菜单“收藏”按钮时的回调。
+     * @supported weapp
+     */
+    useAddToFavorites(callback: (payload: AddToFavoritesObject) => AddToFavoritesReturnObject): void
+
+    /**
+     * 用户点击右上角菜单“分享到朋友圈”按钮时的回调。
+     * @supported weapp
+     */
+    useShareTimeline(callback: () => ShareTimelineReturnObject): void
+
+    /**
+     * 页面销毁前保留状态回调
+     * @supported weapp
+     */
+    useSaveExitState(callback: () => {
+      data: Record<any, any>
+      expireTimeStamp?: number
+    }): void
+
+    /**
+     * 小程序初始化完成时的回调。
+     * @supported weapp, h5, harmony_hybrid
+     */
+    useLaunch(callback: (options: getLaunchOptionsSync.LaunchOptions) => void): void
+
+    /**
+     * 小程序发生脚本错误或 API 调用报错时触发的回调。
+     * @supported weapp, h5, harmony_hybrid
+     */
+    useError(callback: (error: string) => void): void
+
+    /**
+     * 小程序有未处理的 Promise reject 时触发。也可以使用 Taro.onUnhandledRejection 绑定监听。
+     * @supported weapp, alipay, h5, harmony_hybrid
+     */
+    useUnhandledRejection(callback: (error: { reason: Error, promise: Promise<Error> }) => void): void
+
+    /**
+     * 小程序要打开的页面不存在时触发的回调。
+     * @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, harmony_hybrid, harmony
+     */
+    useLoad<T extends {} = Record<string, any>>(callback: (param: T) => void): void
+
+    /**
+     * 页面卸载时的回调。
+     * @supported weapp, h5, harmony_hybrid, harmony
+     */
+    useUnload(callback: () => void): void
+
+    /**
+     * 页面初次渲染完成的回调。
+     * 此时页面已经准备妥当，可以和视图层进行交互。
+     * @supported weapp, h5, harmony_hybrid, harmony
+     */
+    useReady(callback: () => void): void
+
+    /**
+     * 获取当前路由参数。
+     * @supported global
+     */
+    useRouter<TParams extends Partial<Record<string, string>> = Partial<Record<string, string>>>(dynamic?: boolean): RouterInfo<TParams>
+
+    /**
+     * 导航栏的标题被点击时的回调。
+     * @supported alipay
+     */
+    useTitleClick(callback: () => void): void
+
+    /**
+     * 导航栏的额外图标被点击时的回调。
+     * @supported alipay
+     */
+    useOptionMenuClick(callback: () => void): void
+
+    /**
+     * 键盘高度变化时的回调。
+     * @supported alipay
+     */
+    useKeyboardHeight(callback: (payload: { height: number }) => void): void
+
+    /**
+     * 下拉中断时的回调。
+     * @supported alipay, h5, harmony_hybrid
+     */
+    usePullIntercept(callback: () => void): void
+  }
+}