@tarojs/taro 3.6.6-alpha.1 → 3.6.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tarojs/taro",
-  "version": "3.6.6-alpha.1",
+  "version": "3.6.6",
   "description": "Taro framework",
   "homepage": "https://github.com/nervjs/taro/tree/master/packages/taro#readme",
   "main": "index.js",
@@ -21,8 +21,11 @@
   "author": "O2Team",
   "license": "MIT",
   "dependencies": {
-    "@tarojs/api": "3.6.6-alpha.1",
-    "@tarojs/runtime": "3.6.6-alpha.1"
+    "@tarojs/api": "3.6.6",
+    "@tarojs/runtime": "3.6.6"
+  },
+  "devDependencies": {
+    "@tarojs/helper": "3.6.6"
   },
   "peerDependenciesMeta": {
     "@types/react": {

package/types/api/base/weapp/app-event.d.ts

@@ -18,7 +18,7 @@ declare module '../../../index' {
     /** 小程序错误事件的回调函数 */
     type Callback = (
       /** 错误信息，包含堆栈 */
-      error: string,
+      error: string | ErrorEvent | Error,
     ) => void
   }
 
@@ -113,13 +113,13 @@ declare module '../../../index' {
      *
      * **注意**
      *  - 所有的 unhandledRejection 都可以被这一监听捕获，但只有 Error 类型的才会在小程序后台触发报警。
-     * @supported weapp, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onUnhandledRejection.html
      */
     onUnhandledRejection<T = any>(callback: onUnhandledRejection.Callback<T>): void
 
     /** 监听系统主题改变事件。该事件与 [`App.onThemeChange`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onThemeChange-Object-object) 的回调时机一致。
-     * @supported weapp
+     * @supported weapp, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onThemeChange.html
      */
     onThemeChange(callback: onThemeChange.Callback): void
@@ -131,13 +131,13 @@ declare module '../../../index' {
      * - 开发者可以在回调中进行页面重定向，但必须在回调中**同步**处理，异步处理（例如 `setTimeout` 异步执行）无效。
      * - 若开发者没有调用 [Taro.onPageNotFound](/docs/apis/base/weapp/app-event/onPageNotFound) 绑定监听，也没有声明 `App.onPageNotFound`，当跳转页面不存在时，将推入微信客户端原生的页面不存在提示页面。
      * - 如果回调中又重定向到另一个不存在的页面，将推入微信客户端原生的页面不存在提示页面，并且不再第二次回调。
-     * @supported weapp, h5, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onPageNotFound.html
      */
     onPageNotFound(callback: onPageNotFound.Callback): void
 
     /** 监听小程序错误事件。如脚本错误或 API 调用报错等。该事件与 [`App.onError`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onerrorstring-error) 的回调时机与参数一致。
-     * @supported weapp, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onError.html
      */
     onError(callback: onError.Callback): void
@@ -178,16 +178,16 @@ declare module '../../../index' {
      * **注意**
      *
      * 部分版本在无`referrerInfo`的时候会返回 `undefined`，建议使用 `options.referrerInfo && options.referrerInfo.appId` 进行判断。
-     * @supported weapp, h5, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onAppShow.html
      */
     onAppShow(
       /** 小程序切前台事件的回调函数 */
-      callback: (result: onAppShow.CallbackResult) => void,
+      callback: (res: onAppShow.CallbackResult) => void,
     ): void
 
     /** 监听小程序切后台事件。该事件与 [`App.onHide`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onhide) 的回调时机一致。
-     * @supported weapp, h5, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onAppHide.html
      */
     onAppHide(
@@ -196,34 +196,34 @@ declare module '../../../index' {
     ): void
 
     /** 取消监听未处理的 Promise 拒绝事件
-     * @supported weapp, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offUnhandledRejection.html
      */
     offUnhandledRejection<T = any>(callback: onUnhandledRejection.Callback<T>): void
 
     /** 取消监听系统主题改变事件
-     * @supported weapp
+     * @supported weapp, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offThemeChange.html
      */
     offThemeChange(callback: onThemeChange.Callback): void
 
     /** 取消监听小程序要打开的页面不存在事件
-     * @supported weapp, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offPageNotFound.html
      */
     offPageNotFound(
       /** 小程序要打开的页面不存在事件的回调函数 */
-      callback: (res: onPageNotFound.Callback) => void,
+      callback: onPageNotFound.Callback,
     ): void
 
     /** 取消监听音频播放错误事件
-     * @supported weapp, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/InnerAudioContext.offError.html
      */
 
     offError(
       /** 音频播放错误事件的回调函数 */
-      callback: (res: onError.Callback) => void,
+      callback: onError.Callback,
     ): void
 
     /** 取消监听音频中断结束事件
@@ -245,21 +245,21 @@ declare module '../../../index' {
     ): void
 
     /** 取消监听小程序切前台事件
-     * @supported weapp, h5, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offAppShow.html
      */
     offAppShow(
       /** 小程序切前台事件的回调函数 */
-      callback: (res: TaroGeneral.CallbackResult) => void,
+      callback: (res: onAppShow.CallbackResult) => void,
     ): void
 
     /** 取消监听小程序切后台事件
-     * @supported weapp, h5, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offAppHide.html
      */
     offAppHide(
       /** 小程序切后台事件的回调函数 */
-      callback: (res: TaroGeneral.CallbackResult) => void,
+      callback: (res: onAppHide.CallbackResult) => void,
     ): void
   }
 }

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

@@ -0,0 +1,203 @@
+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.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
+  }
+
+  namespace interceptorify {
+    type promiseifyApi<T, R> = (requestParams: T) => Promise<R>
+    interface InterceptorifyChain<T, R> {
+      requestParams: T
+      proceed: promiseifyApi<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, designWidth?: number): string
+
+    /** 尺寸转换初始化
+     * @supported global
+     */
+    initPxTransform(config: {
+      baseFontSize?: number
+      deviceRatio?: TaroGeneral.TDeviceRatio
+      designWidth?: number | ((size?: string | number) => number)
+      targetUnit?: string
+      unitPrecision?: number
+    }): void
+
+    /** @ignore */
+    initAppInfo(appInfo: getAppInfo.AppInfo): void
+
+    /** 小程序获取和 Taro 相关的 App 信息
+     * @supported weapp, alipay, jd, qq, swan, tt, h5
+     */
+    getAppInfo(): getAppInfo.AppInfo
+
+    /** 小程序引用插件 JS 接口
+     * @supported weapp, alipay, h5, rn, jd, qq, swan, tt, quickapp
+     */
+    requirePlugin(pluginName: string): any
+
+    /** 获取当前页面实例
+     * @supported global
+     */
+    getCurrentInstance(): getCurrentInstance.Current
+
+    /** @ignore */
+    Current: getCurrentInstance.Current
+
+    /** Vue3 插件，用于设置 `getApp()` 中的全局变量
+     * @supported weapp, alipay, h5, rn, jd, qq, swan, tt, quickapp
+     * @example
+     * ```js
+     * // 使用插件
+     * const App = createApp(...)
+     * App.use(setGlobalDataPlugin, {
+     *   xxx: 999
+     * })
+     * // 获取全局变量
+     * Taro.getApp().xxx
+     * ```
+     */
+    setGlobalDataPlugin: setGlobalDataPlugin.Plugin
+
+    /** 获取自定义 TabBar 对应的 React 或 Vue 组件实例
+     * @supported weapp
+     * @param page 小程序页面对象，可以通过 Taro.getCurrentInstance().page 获取
+     */
+    getTabBar<T>(page: getCurrentInstance.Current['page']): T | undefined
+
+    /** 获取当前页面渲染引擎类型
+     * @supported weapp
+     */
+    getRenderer(): 'webview' | 'skyline'
+
+    /**
+     * 包裹 promiseify api 的洋葱圈模型
+     * @supported global
+     * @param promiseifyApi
+     * @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>(promiseifyApi: interceptorify.promiseifyApi<T, R>): interceptorify.Interceptorify<T, R>
+  }
+}

package/types/{taro.hooks.d.ts → api/taro.hooks.d.ts}

@@ -1,6 +1,6 @@
-import Taro from './index'
+import Taro from '../index'
 
-declare module './index' {
+declare module '../index' {
   interface TaroStatic {
     /**
      * 页面展示时的回调。
@@ -46,7 +46,7 @@ declare module './index' {
 
     /**
      * 当前是 tab 页时，tab 被点击时的回调。
-     * @supported weapp, rn
+     * @supported weapp, h5, rn
      */
     useTabItemTap(callback: (payload: TabItemTapObject) => void): void
 
@@ -85,7 +85,7 @@ declare module './index' {
 
     /**
      * 小程序有未处理的 Promise reject 时触发。也可以使用 Taro.onUnhandledRejection 绑定监听。
-     * @supported weapp, alipay
+     * @supported weapp, alipay, h5
      */
     useUnhandledRejection(callback: (error: { reason: Error, promise: Promise<Error> }) => void): void
 

package/types/compile/compiler.d.ts

@@ -1,4 +1,4 @@
-import type swc from '@swc/core'
+import type { swc } from '@tarojs/helper'
 import type Webpack from 'webpack'
 
 type CompilerTypes = 'webpack4' | 'webpack5'

package/types/compile/config/project.d.ts

@@ -24,7 +24,7 @@ export interface IProjectBaseConfig {
   port?: number
   projectName?: string
   date?: string
-  designWidth?: number | ((size: number) => number)
+  designWidth?: number | ((size?: string | number) => number)
   deviceRatio?: TaroGeneral.TDeviceRatio
   watcher?: any[]
   sourceRoot?: string

package/types/index.d.ts

@@ -108,13 +108,13 @@
  * │   │   └── interaction.d.ts             界面 -> 交互 API
  * │   ├── worker
  * │   │   └── index.d.ts                   Worker API
- * │   └── wxml
- * │       └── index.d.ts                   WXML API
+ * │   ├── wxml
+ * │   │   └── index.d.ts                   WXML API
+ * │   ├── taro.extend.d.ts                 Taro 扩展 API 类型定义
+ * │   └── taro.hooks.d.ts                  Taro Hooks 类型定义
  * ├── index.d.ts                           此文件
  * ├── taro.component.d.ts                  Taro Component 类型定义
- * ├── taro.config.d.ts                     Taro 小程序 App 与 Window 设置类型定义
- * ├── taro.extend.d.ts                     Taro 扩展 API 类型定义
- * ├── taro.hooks.d.ts                      Taro Hooks 类型定义
+ * ├── taro.config.d.ts                      Taro 小程序 App 与 Window 设置类型定义
  * └── taro.lifecycle.d.ts                  Taro 生命周期类型定义
  */
 
@@ -123,8 +123,6 @@
 /// <reference path="taro.api.d.ts" />
 /// <reference path="taro.component.d.ts" />
 /// <reference path="taro.config.d.ts" />
-/// <reference path="taro.extend.d.ts" />
-/// <reference path="taro.hooks.d.ts" />
 /// <reference path="taro.lifecycle.d.ts" />
 
 /// <reference types="@tarojs/plugin-platform-alipay/types/shims-alipay" />

package/types/taro.api.d.ts

@@ -2,7 +2,7 @@
  *
  * 微信端能力
  * original code from: https://github.com/wx-minapp/minapp-wx/blob/master/typing/wx.d.ts
- * Lincenced under MIT license: https://github.com/qiu8310/minapp/issues/69
+ * Licensed under MIT license: https://github.com/qiu8310/minapp/issues/69
  * thanks for the great work by @qiu8310 👍👍👍
  *
  */
@@ -110,3 +110,6 @@
 /// <reference path="api/alipay/index.d.ts" />
 /// <reference path="api/qq/index.d.ts" />
 /// <reference path="api/swan/index.d.ts" />
+
+/// <reference path="api/taro.extend.d.ts" />
+/// <reference path="api/taro.hooks.d.ts" />

package/types/taro.component.d.ts

@@ -1,7 +1,7 @@
 import React from 'react'
 import Vue from 'vue'
 
-import Taro, { Config } from './index'
+import Taro from './index'
 
 declare module './index' {
   // ref: packages/taro-runtime/src/current.ts

package/types/taro.extend.d.ts

@@ -1,126 +0,0 @@
-import React from 'react'
-
-import Taro from './index'
-
-declare module './index' {
-  type MessageType = 'info' | 'success' | 'error' | 'warning'
-
-  interface AtMessageOptions {
-    message: string
-    type?: MessageType
-    duration?: number
-  }
-
-  interface AppInfo {
-    platform: string,
-    taroVersion: string
-    designWidth: number
-  }
-
-  interface RequestParams<T=any> extends request.Option<T, any> {
-    [propName: string]: any
-  }
-
-  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>
-  }
-
-  interface SetGlobalDataPlugin {
-    install (app: any, data: any): void
-  }
-
-  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
-  }
-
-  interface TaroStatic {
-    Events: {
-      new (): TaroGeneral.Events
-    }
-
-    /** 事件中心
-     * @supported global
-     */
-    eventCenter: TaroGeneral.Events
-
-    ENV_TYPE: TARO_ENV_TYPE
-
-    /** 获取环境变量
-     * @supported global
-     */
-    getEnv(): TaroGeneral.ENV_TYPE
-
-    /** 尺寸转换
-     * @supported global
-     */
-    pxTransform(size: number, designWidth?: number): string
-
-    /** 尺寸转换初始化
-     * @supported global
-     */
-    initPxTransform(config: {
-      baseFontSize?: number
-      deviceRatio?: TaroGeneral.TDeviceRatio
-      designWidth?: number
-      targetUnit?: string
-      unitPrecision?: number
-    }): void
-
-    /** @ignore */
-    initAppInfo(appInfo: AppInfo): void
-
-    /** 小程序获取和 Taro 相关的 App 信息
-     * @supported weapp, alipay, jd, qq, swan, tt
-     */
-    getAppInfo(): AppInfo
-
-    /** 小程序引用插件 JS 接口
-     * @supported weapp, alipay, h5, rn, jd, qq, swan, tt, quickapp
-     */
-    requirePlugin(pluginName: string): any
-
-    /** 获取当前页面实例
-     * @supported global
-     */
-    getCurrentInstance(): Current
-    Current: Current
-
-    /** Vue3 插件，用于设置 `getApp()` 中的全局变量
-     * @supported weapp, alipay, h5, rn, jd, qq, swan, tt, quickapp
-     * @example
-     * ```js
-     * // 使用插件
-     * const App = createApp(...)
-     * App.use(setGlobalDataPlugin, {
-     *   xxx: 999
-     * })
-     * // 获取全局变量
-     * Taro.getApp().xxx
-     * ```
-     */
-    setGlobalDataPlugin: SetGlobalDataPlugin
-
-    /** 获取自定义 TabBar 对应的 React 或 Vue 组件实例
-     * @supported weapp
-     * @param page 小程序页面对象，可以通过 Taro.getCurrentInstance().page 获取
-     */
-    getTabBar<T>(page: Current['page']): T | undefined
-  }
-}