@tarojs/taro 3.5.0-beta.2 → 3.5.0-beta.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tarojs/taro",
-  "version": "3.5.0-beta.2",
+  "version": "3.5.0-beta.5",
   "description": "Taro framework",
   "homepage": "https://github.com/nervjs/taro/tree/master/packages/taro#readme",
   "main": "index.js",
@@ -11,9 +11,6 @@
     "html.css",
     "html5.css"
   ],
-  "scripts": {
-    "test": "echo \"Error: run tests from root\" && exit 1"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/NervJS/taro.git"
@@ -24,8 +21,8 @@
   "author": "O2Team",
   "license": "MIT",
   "dependencies": {
-    "@tarojs/api": "3.5.0-beta.2",
-    "@tarojs/runtime": "3.5.0-beta.2"
+    "@tarojs/api": "3.5.0-beta.5",
+    "@tarojs/runtime": "3.5.0-beta.5"
   },
   "peerDependenciesMeta": {
     "@types/react": {
@@ -41,5 +38,7 @@
       "optional": true
     }
   },
-  "gitHead": "c85adaa45959e6cafc15e6531f4735a7dfa2aab0"
-}
+  "scripts": {
+    "test": "echo \"Error: run tests from root\" && exit 1"
+  }
+}

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

@@ -28,19 +28,58 @@ declare module '../../../index' {
       path: string
       /** 小程序切前台的 query 参数 */
       query: TaroGeneral.IAnyObject
-      /** 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意) */
-      referrerInfo: ResultReferrerInfo
-      /** 小程序切前台的[场景值](https://developers.weixin.qq.com/miniprogram/dev/framework/app-service/scene.html) */
-      scene: number
       /** shareTicket，详见[获取更多转发信息](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share.html) */
       shareTicket: string
+      /** 小程序切前台的[场景值](https://developers.weixin.qq.com/miniprogram/dev/framework/app-service/scene.html) */
+      scene: number
+      /** 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意) */
+      referrerInfo: ResultReferrerInfo
+      /** 打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数 */
+      forwardMaterials?: ForwardMaterial[]
+      /** 从微信群聊/单聊打开小程序时，chatType 表示具体微信群聊/单聊类型 */
+      chatType?: keyof ChatType
+      /** API 类别 */
+      apiCategory?: keyof ApiCategory
     }
     /** 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意) */
     interface ResultReferrerInfo {
       /** 来源小程序、公众号或 App 的 appId */
-      appId: string
+      appId?: string
       /** 来源小程序传过来的数据，scene=1037或1038时支持 */
-      extraData: TaroGeneral.IAnyObject
+      extraData?: TaroGeneral.IAnyObject
+    }
+    /** ChatType 类型合法值 */
+    interface ForwardMaterial {
+      /** 文件的mimetype类型 */
+      type: string
+      /** 文件名 */
+      name: string
+      /** 文件路径（如果是webview则是url） */
+      path: string
+      /** 文件大小 */
+      size: number
+    }
+    /** ChatType 类型合法值 */
+    interface ChatType {
+      /** 微信联系人单聊 */
+      1
+      /** 企业微信联系人单聊 */
+      2
+      /** 普通微信群聊 */
+      3
+      /** 企业微信互通群聊 */
+      4
+    }
+    /** API 类别合法值 */
+    interface ApiCategory {
+      /** 默认类别 */
+      default
+      /** 原生功能化，视频号直播商品、商品橱窗等场景打开的小程序 */
+      nativeFunctionalized
+      /** 仅浏览，朋友圈快照页等场景打开的小程序 */
+      browseOnly
+      /** 内嵌，通过打开半屏小程序能力打开的小程序 */
+      embedded
     }
   }
 
@@ -71,7 +110,7 @@ declare module '../../../index' {
 
   interface TaroStatic {
     /** 监听未处理的 Promise 拒绝事件。该事件与 [`App.onUnhandledRejection`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onUnhandledRejection-Object-object) 的回调时机与参数一致。
-     * 
+     *
      * **注意**
      *  - 所有的 unhandledRejection 都可以被这一监听捕获，但只有 Error 类型的才会在小程序后台触发报警。
      * @supported weapp, tt
@@ -139,7 +178,7 @@ declare module '../../../index' {
      * **注意**
      *
      * 部分版本在无`referrerInfo`的时候会返回 `undefined`，建议使用 `options.referrerInfo && options.referrerInfo.appId` 进行判断。
-     * @supported weapp, tt
+     * @supported weapp, h5, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onAppShow.html
      */
     onAppShow(
@@ -148,7 +187,7 @@ declare module '../../../index' {
     ): void
 
     /** 监听小程序切后台事件。该事件与 [`App.onHide`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onhide) 的回调时机一致。
-     * @supported weapp, tt
+     * @supported weapp, h5, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onAppHide.html
      */
     onAppHide(
@@ -206,7 +245,7 @@ declare module '../../../index' {
     ): void
 
     /** 取消监听小程序切前台事件
-     * @supported weapp, tt
+     * @supported weapp, h5, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offAppShow.html
      */
     offAppShow(
@@ -215,7 +254,7 @@ declare module '../../../index' {
     ): void
 
     /** 取消监听小程序切后台事件
-     * @supported weapp, tt
+     * @supported weapp, h5, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offAppHide.html
      */
     offAppHide(

package/types/api/base/weapp/life-cycle.d.ts

@@ -21,14 +21,14 @@ declare module '../../../index' {
       /** API 类别 */
       apiCategory?: keyof LaunchOptions.ApiCategory
     }
-  
+
     namespace LaunchOptions {
       /** 来源信息 */
       interface ReferrerInfo {
         /** 来源小程序、公众号或 App 的 appId */
-        appId: string
+        appId?: string
         /** 来源小程序传过来的数据，scene=1037或1038时支持 */
-        extraData: TaroGeneral.IAnyObject
+        extraData?: TaroGeneral.IAnyObject
       }
       /** ChatType 类型合法值 */
       interface ForwardMaterial {
@@ -86,14 +86,14 @@ declare module '../../../index' {
       /** API 类别 */
       apiCategory?: keyof EnterOptions.ApiCategory
     }
-  
+
     namespace EnterOptions {
       /** 来源信息 */
       interface ReferrerInfo {
         /** 来源小程序、公众号或 App 的 appId */
-        appId: string
+        appId?: string
         /** 来源小程序传过来的数据，scene=1037或1038时支持 */
-        extraData: TaroGeneral.IAnyObject
+        extraData?: TaroGeneral.IAnyObject
       }
       /** ChatType 类型合法值 */
       interface ForwardMaterial {

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

@@ -4,7 +4,7 @@ declare module '../../index' {
   namespace canvasToTempFilePath {
     interface Option {
       /** 画布标识，传入 [canvas](/docs/components/canvas) 组件实例 （canvas type="2d" 时使用该属性）。 */
-      canvas?: CanvasProps
+      canvas?: Canvas
       /** 画布标识，传入 [canvas](/docs/components/canvas) 组件的 canvas-id */
       canvasId?: string
       /** 图片的质量，目前仅对 jpg 有效。取值范围为 (0, 1]，不在范围内时当作 1.0 处理。 */

package/types/api/device/vibrate.d.ts

@@ -3,6 +3,8 @@ import Taro from '../../index'
 declare module '../../index' {
   namespace vibrateShort {
     interface Option {
+      /** 震动强度类型，有效值为：heavy、medium、light */
+      type: 'heavy' | 'medium' | 'light'
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
@@ -25,6 +27,8 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 使手机发生较短时间的振动（15 ms）。仅在 iPhone `7 / 7 Plus` 以上及 Android 机型生效
+     * @h5 不支持 type 参数
+     * @rn 不支持 type 参数
      * @supported weapp, h5, rn, tt
      * @example
      * ```tsx

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

@@ -188,6 +188,26 @@ declare module '../../index' {
     }
   }
 
+  namespace getFuzzyLocation {
+    interface Option {
+      /** wgs84 返回 gps 坐标，gcj02 返回可用于 Taro.openLocation 的坐标 */
+      type?: 'wgs84' | 'gcj02'
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 纬度，范围为 -90~90，负数表示南纬 */
+      latitude: string
+      /** 经度，范围为 -180~180，负数表示西经 */
+      longitude: string
+    }
+  }
+
   interface TaroStatic {
     /** 关闭监听实时位置变化，前后台都停止消息接收
      * @supported weapp, rn, tt
@@ -329,5 +349,21 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.chooseLocation.html
      */
     chooseLocation(option: chooseLocation.Option): Promise<chooseLocation.SuccessCallbackResult>
+
+    /** 获取当前的模糊地理位置
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.getFuzzyLocation({
+     *   type: 'wgs84',
+     *   success (res) {
+     *     const latitude = res.latitude
+     *     const longitude = res.longitude
+     *   },
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.getFuzzyLocation.html
+     */
+    getFuzzyLocation(option: getFuzzyLocation.Option): Promise<getFuzzyLocation.SuccessCallbackResult>
   }
 }

package/types/compile.d.ts

@@ -1,6 +1,8 @@
+import swc from '@swc/core'
 export { Current } from '@tarojs/runtime'
 import webpack from 'webpack'
 import webpackDevServer from 'webpack-dev-server'
+import HtmlWebpackPlugin from 'html-webpack-plugin'
 
 export const enum TEMPLATE_TYPES {
   WEAPP = '.wxml',
@@ -195,6 +197,7 @@ export interface IH5Config {
   useHtmlComponents?: boolean
 
   postcss?: IPostcssOption
+  htmlPluginOption?: HtmlWebpackPlugin.Options
 }
 
 type FeatureItem = {
@@ -368,6 +371,7 @@ interface IPrebundle {
   include?: string[]
   exclude?: string[]
   esbuild?: Record<string, any>
+  swc?: swc.Config
   webpack?: {
     provide?: any[]
   }
@@ -384,6 +388,8 @@ interface ILogger {
 }
 
 export interface IProjectBaseConfig {
+  isWatch?: boolean
+  port?: number
   projectName?: string
   date?: string
   designWidth?: number
@@ -406,9 +412,17 @@ export interface IProjectBaseConfig {
   presets?: PluginItem[]
   baseLevel?: number
   framework?: string
+  frameworkExts?: string[]
   compiler?: Compiler
   cache?: ICache
   logger?: ILogger
+  enableSourceMap?: boolean
+  /** hooks */
+  modifyWebpackChain?: HookModifyWebpackChain
+  modifyMiniConfigs?: (configMap) => Promise<any>
+  modifyBuildAssets?: (assets, plugin?) => Promise<any>
+  onWebpackChainReady?: (webpackChain: Chain) => Promise<any>
+  onBuildFinish?: (res: { error, stats, isWatch }) => Promise<any>
 }
 
 export interface IProjectConfig extends IProjectBaseConfig {

package/types/global.d.ts

@@ -215,7 +215,7 @@ declare namespace TaroGeneral {
      * @illustrate 正常
      */
     0
-    /** unsupport
+    /** nonsupport
      * @illustrate 系统或设备不支持
      */
     11000

package/types/taro.component.d.ts

@@ -15,13 +15,7 @@ declare module './index' {
     componentDidShow?(): void
     componentDidHide?(): void
     componentDidCatchError?(err: string): void
-    componentDidNotFound?(obj: PageNotFoundObject): void
-    onPullDownRefresh?(): void
-    onReachBottom?(): void
-    onPageScroll?(obj: PageScrollObject): void
-    onShareAppMessage?(obj: ShareAppMessageObject): ShareAppMessageReturn
-    onTabItemTap?(obj: TabItemTapObject): void
-    onResize?(obj: PageResizeObject): void
+    componentDidNotFound?(opt: PageNotFoundObject): void
   }
   interface ComponentOptions {
     addGlobalClass?: boolean
@@ -47,6 +41,7 @@ declare module './index' {
 
     shareTicket: string | undefined
     scene: number | undefined
+    exitState?: any
   }
   interface Component<P = {}, S = {}, SS = any> extends ComponentLifecycle<P, S, SS> {
     $scope?: any
@@ -73,10 +68,10 @@ declare module './index' {
     onHide?(): void
   }
   interface AppInstance extends Show {
-    mount(component: React.Component | Vue.ComponentOptions<Vue>, id: string, cb: () => void): void
+    mount(component: React.Component | Vue.ComponentOptions<Vue>, id: string, cb: (...args: any[]) => void): void
     componentDidShow?(options?: Record<string, unknown>): void
     onShow?(options?: Record<string, unknown>): void
-    unmount(id: string, cb: () => void): void
+    unmount(id: string, cb?: () => void): void
   }
   type Target = Record<string, unknown> & { dataset: Record<string, unknown>; id: string }
   interface MpEvent {
@@ -86,18 +81,18 @@ declare module './index' {
     currentTarget: Target
   }
   interface PageLifeCycle extends Show {
-    onPullDownRefresh?(): void
-    onReachBottom?(): void
-    onPageScroll?(obj: { scrollTop: number }): void
-    onShareAppMessage?(obj: { from: string; target?: any; webViewUrl: string }): void
-    onResize?(options: unknown): void
-    onTabItemTap?(obj: { index: string; pagePath: string; text: string }): void
-    onTitleClick?(): void
+    eh?(event: MpEvent): void
+    onLoad(options: Record<string, unknown>): void
     onOptionMenuClick?(): void
+    onPageScroll?(opt: PageScrollObject): void
     onPopMenuClick?(): void
+    onPullDownRefresh?(): void
     onPullIntercept?(): void
-    eh?(event: MpEvent): void
-    onLoad(options: Record<string, unknown>): void
+    onReachBottom?(): void
+    onResize?(opt: PageResizeObject): void
+    onShareAppMessage?(opt: ShareAppMessageObject): ShareAppMessageReturn
+    onTabItemTap?(opt: TabItemTapObject): void
+    onTitleClick?(): void
     onUnload(): void
   }
   interface ComponentInstance<
@@ -184,10 +179,4 @@ declare module './index' {
     /** 页面的组件选项 */
     options?: Record<string, unknown>
   }
-  interface TaroStatic {
-    memo<P = {}>(
-      FunctionComponent: FunctionComponent<P>,
-      compare?: (oldProps: P, newProps: P) => boolean
-    ): FunctionComponent<P>
-  }
 }

package/types/taro.config.d.ts

@@ -359,6 +359,22 @@ declare module './index' {
       /** 视频号直播打开的第一个页面的全屏状态使用自定义顶部，支持 */
       firstPageNavigationStyle?: 'default' | 'custom'
     }
+    /** 小程序调试相关配置项 */
+    debugOptions?: {
+      /** 是否开启 FPS 面板，默认false */
+      enableFPSPanel?: boolean
+    }
+    /** touch 事件监听是否为 passive，默认false */
+    enablePassiveEvent?: boolean | {
+      /** 是否设置 touchstart 事件为 passive，默认false */
+      touchstart?: boolean
+      /** 是否设置 touchmove 事件为 passive，默认false */
+      touchmove?: boolean
+      /** 是否设置 wheel 事件为 passive，默认false */
+      wheel?: boolean
+    }
+    /** 自定义模块映射规则 */
+    resolveAlias?: Record<string, string>
     /** 接受一个数组，每一项都是字符串，来指定编译为原生小程序组件的组件入口 */
     components?: string[]
     /** 渲染页面的容器 id

package/types/taro.hooks.d.ts

@@ -4,90 +4,132 @@ declare module './index' {
   interface TaroStatic {
     /**
      * 页面展示时的回调。
+     * @supported global
      */
     useDidShow(callback: () => 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, rn
      */
     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
+     */
+    useLaunch(callback: (options: getLaunchOptionsSync.LaunchOptions) => void): void
+
+    /**
+     * 小程序发生脚本错误或 API 调用报错时触发的回调。
+     * @supported weapp, h5
+     */
+    useError(callback: (error: string) => void): void
+
+    /**
+     * 小程序要打开的页面不存在时触发的回调。
+     * @supported weapp, h5
+     * @h5 多页面模式不支持该方法
+     */
+    usePageNotFound(callback: (res: { path: string, query: Record<any, any>, isEntryPage: boolean, [key: string]: any }) => void): void
+
     /**
      * 页面加载完成时的回调。
+     * @supported weapp, h5
      */
     useLoad(callback: () => void): void
 
     /**
      * 页面卸载时的回调。
+     * @supported weapp, h5
      */
     useUnload(callback: () => void): void
 
     /**
      * 页面初次渲染完成的回调。
      * 此时页面已经准备妥当，可以和视图层进行交互。
+     * @supported weapp, h5
      */
     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, h5
      */
     usePullIntercept(callback: () => void): void
   }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2018 
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.