@tarojs/taro 3.5.0-theta.0 → 3.5.1-aplha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tarojs/taro",
-  "version": "3.5.0-theta.0",
+  "version": "3.5.1-aplha.0",
   "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": "workspace:*",
-    "@tarojs/runtime": "workspace:*"
+    "@tarojs/api": "3.5.1-aplha.0",
+    "@tarojs/runtime": "3.5.1-aplha.0"
   },
   "peerDependenciesMeta": {
     "@types/react": {
@@ -40,5 +37,8 @@
     "vue": {
       "optional": true
     }
+  },
+  "scripts": {
+    "test": "echo \"Error: run tests from root\" && exit 1"
   }
-}
+}

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/framework/index.d.ts

@@ -3,10 +3,11 @@ import Taro from '../../index'
 declare module '../../index' {
   /** 注册小程序中的一个页面。接受一个 `Object` 类型参数，其指定页面的初始数据、生命周期回调、事件处理函数等。 */
   interface Page {
-    /**
-     * 当前页面的路径
+    /** 当前页面的路径
+     * @note 推荐使用 Taro.getCurrentInstance().router?.path 方法
      */
-    route: string
+    route?: string
+    __route__?: string
     /** @ignore */
     [k: string]: any
   }

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/api/network/download.d.ts

@@ -26,6 +26,26 @@ declare module '../../index' {
       tempFilePath: string
       /** 调用结果 */
       errMsg: string
+      /**
+       * 开发者服务器返回的 HTTP Response Header
+       * @supported weapp
+       * @weapp 非官方文档标注属性
+       */
+      header?: TaroGeneral.IAnyObject
+      /**
+       * 数据长度，单位 Byte
+       * @supported weapp
+       * @weapp 非官方文档标注属性
+       */
+      dataLength?: number
+      /**
+       * cookies
+       * @supported weapp
+       * @weapp 非官方文档标注属性
+       */
+      cookies?: string[]
+      /** 网络请求过程中一些调试信息 */
+      profile?: TaroGeneral.IAnyObject
     }
   }
 
@@ -59,10 +79,9 @@ declare module '../../index' {
       totalBytesWritten: number
     }
 
-    type DownloadTaskPromise = Promise<DownloadTask> & {
+    type DownloadTaskPromise = Promise<downloadFile.FileSuccessCallbackResult> & DownloadTask & {
       headersReceive: DownloadTask['onHeadersReceived'],
-      progress: DownloadTask['onProgressUpdate'],
-      abort: DownloadTask['abort']
+      progress: DownloadTask['onProgressUpdate']
     }
   }
 

package/types/api/network/upload.d.ts

@@ -35,6 +35,18 @@ declare module '../../index' {
       statusCode: number
       /** 调用结果 */
       errMsg: string
+      /**
+       * 开发者服务器返回的 HTTP Response Header
+       * @supported weapp
+       * @weapp 非官方文档标注属性
+       */
+      header?: TaroGeneral.IAnyObject
+      /**
+       * cookies
+       * @supported weapp
+       * @weapp 非官方文档标注属性
+       */
+      cookies?: string[]
     }
   }
 
@@ -68,10 +80,9 @@ declare module '../../index' {
       totalBytesSent: number
     }
 
-    type UploadTaskPromise = Promise<UploadTask> & {
+    type UploadTaskPromise = Promise<uploadFile.SuccessCallbackResult> & UploadTask & {
       headersReceive: UploadTask['onHeadersReceived'],
-      progress: UploadTask['onProgressUpdate'],
-      abort: UploadTask['abort']
+      progress: UploadTask['onProgressUpdate']
     }
   }
 

package/types/compile.d.ts

@@ -388,6 +388,8 @@ interface ILogger {
 }
 
 export interface IProjectBaseConfig {
+  isWatch?: boolean
+  port?: number
   projectName?: string
   date?: string
   designWidth?: number
@@ -410,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/taro.component.d.ts

@@ -4,35 +4,6 @@ import Vue from 'vue'
 import Taro, { Config } from './index'
 
 declare module './index' {
-  // Components
-  interface ComponentLifecycle<P, S, SS = any> extends NewLifecycle<P, S, SS> {
-    componentWillMount?(): void
-    componentDidMount?(): void
-    componentWillReceiveProps?(nextProps: Readonly<P>, nextContext: any): void
-    shouldComponentUpdate?(nextProps: Readonly<P>, nextState: Readonly<S>, nextContext: any): boolean
-    componentWillUpdate?(nextProps: Readonly<P>, nextState: Readonly<S>, nextContext: any): void
-    componentWillUnmount?(): void
-    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
-  }
-  interface ComponentOptions {
-    addGlobalClass?: boolean
-    styleIsolation?: 'isolated' | 'apply-shared' | 'shared'
-  }
-  interface ComponentClass<P = {}, S = any> extends StaticLifecycle<P, S> {
-    new (...args: any[]): Component<P, {}>
-    propTypes?: any // TODO: Use prop-types type definition.
-    defaultProps?: Partial<P>
-    displayName?: string
-  }
   // ref: packages/taro-runtime/src/current.ts
   interface RouterInfo<TParams extends Partial<Record<string, string>> = Partial<Record<string, string>>> {
     /** 路由参数 */
@@ -49,23 +20,6 @@ declare module './index' {
     scene: number | undefined
     exitState?: any
   }
-  interface Component<P = {}, S = {}, SS = any> extends ComponentLifecycle<P, S, SS> {
-    $scope?: any
-  }
-  type PropsWithChildren<P> = P & { children?: React.ReactNode }
-  interface FunctionComponent<P = {}> {
-    (props: PropsWithChildren<P>, context?: any): React.ReactElement | null
-    propTypes?: any // TODO: Use prop-types type definition.
-    defaultProps?: Partial<P>
-    config?: Config
-    options?: ComponentOptions
-    externalClasses?: string[]
-  }
-  type FC<P = {}> = FunctionComponent<P>
-  interface StatelessFunctionComponent {
-    (): JSX.Element
-  }
-  type SFC = StatelessFunctionComponent
 
   interface Show {
     componentDidShow?(): void
@@ -74,10 +28,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 {
@@ -87,18 +41,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<

package/types/taro.config.d.ts

@@ -271,6 +271,19 @@ declare module './index' {
      * @since 微信客户端 6.7.2 及以上版本支持
      */
     requiredBackgroundModes?: ('audio' | 'location')[]
+    /** 申明需要使用的地理位置相关接口，类型为数组。目前支持以下项目：
+     * 自 2022 年 7 月 14 日后发布的小程序，使用以下8个地理位置相关接口时，需要声明该字段，否则将无法正常使用。2022 年 7 月 14 日前发布的小程序不受影响。
+     * - getFuzzyLocation: 获取模糊地理位置
+     * - getLocation: 获取精确地理位置
+     * - onLocationChange: 监听试试地理位置变化事件
+     * - startLocationUpdate: 接收位置消息（前台）
+     * - startLocationUpdateBackground: 接收位置消息（前后台）
+     * - chooseLocation: 打开地图选择位置
+     * - choosePoi: 打开 POI 列表选择位置
+     * - chooseAddress: 获取用户地址信息
+     *  @see https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#requiredPrivateInfos
+     */
+    requiredPrivateInfos?: ('getFuzzyLocation' | 'getLocation' | 'onLocationChange' | 'startLocationUpdate' | 'startLocationUpdateBackground' | 'chooseLocation' | 'choosePoi' | 'chooseAddress')[] 
     /** 使用到的插件
      * @since 1.9.6
      */

package/types/taro.extend.d.ts

@@ -1,6 +1,6 @@
 import React from 'react'
 
-import Taro, { Component } from './index'
+import Taro from './index'
 
 declare module './index' {
   type MessageType = 'info' | 'success' | 'error' | 'warning'
@@ -11,7 +11,7 @@ declare module './index' {
     duration?: number
   }
 
-  interface RequestParams<T> extends request.Option<T, any> {
+  interface RequestParams<T=any> extends request.Option<T, any> {
     [propName: string]: any
   }
 
@@ -49,36 +49,41 @@ declare module './index' {
       new (): TaroGeneral.Events
     }
 
-    // eventCenter
+    /** 事件中心
+     * @supported global
+     */
     eventCenter: TaroGeneral.Events
 
     ENV_TYPE: TARO_ENV_TYPE
 
+    /** 获取环境变量
+     * @supported global
+     */
     getEnv(): TaroGeneral.ENV_TYPE
 
-    render(component: Component | JSX.Element, element: Element | null): any
-
-    internal_safe_set(...arg: any[]): any
-    internal_safe_get(...arg: any[]): any
-
-    atMessage(options: AtMessageOptions): void
-
+    /** 尺寸转换
+     * @supported global
+     */
     pxTransform(size: number, designWidth?: number): string
+
+    /** 尺寸转换初始化
+     * @supported global
+     */
     initPxTransform(config: { designWidth: number; deviceRatio: TaroGeneral.TDeviceRatio }): void
 
-    /**
-     * 小程序引用插件 JS 接口
+    /** 小程序引用插件 JS 接口
+     * @supported weapp, alipay, h5, rn, jd, qq, swan, tt, quickapp
      */
     requirePlugin(pluginName: string): any
 
-    setIsUsingDiff (flag: boolean)
-
-    Current: Current
-
+    /** 获取当前页面实例
+     * @supported global
+     */
     getCurrentInstance(): Current
+    Current: Current
 
-    /**
-     * @desc Vue3 插件，用于设置 `getApp()` 中的全局变量
+    /** Vue3 插件，用于设置 `getApp()` 中的全局变量
+     * @supported weapp, alipay, h5, rn, jd, qq, swan, tt, quickapp
      * @example
      * ```js
      * // 使用插件
@@ -92,9 +97,8 @@ declare module './index' {
      */
     setGlobalDataPlugin: SetGlobalDataPlugin
 
-    /**
+    /** 获取自定义 TabBar 对应的 React 或 Vue 组件实例
      * @supported weapp
-     * @desc 获取自定义 TabBar 对应的 React 或 Vue 组件实例
      * @param page 小程序页面对象，可以通过 Taro.getCurrentInstance().page 获取
      */
     getTabBar<T>(page: Current['page']): T | undefined

package/types/taro.hooks.d.ts

@@ -4,57 +4,67 @@ 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>
@@ -63,55 +73,63 @@ declare module './index' {
 
     /**
      * 小程序初始化完成时的回调。
+     * @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/types/taro.lifecycle.d.ts

@@ -1,15 +1,15 @@
 import Taro from './index'
 
 type TaroGetDerivedStateFromProps<P, S> =
-/**
- * Returns an update to a component's state based on its new props and old state.
- *
- * Note: its presence prevents any of the deprecated lifecycle methods from being invoked
- */
-(nextProps: Readonly<P>, prevState: S) => Partial<S> | null;
+  /**
+   * Returns an update to a component's state based on its new props and old state.
+   *
+   * Note: its presence prevents any of the deprecated lifecycle methods from being invoked
+   */
+  (nextProps: Readonly<P>, prevState: S) => Partial<S> | null
 
 interface TaroStaticLifecycle<P, S> {
-  getDerivedStateFromProps?: TaroGetDerivedStateFromProps<P, S>;
+  getDerivedStateFromProps?: TaroGetDerivedStateFromProps<P, S>
 }
 
 interface TaroNewLifecycle<P, S, SS> {
@@ -21,13 +21,13 @@ interface TaroNewLifecycle<P, S, SS> {
    * Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
    * lifecycle events from running.
    */
-  getSnapshotBeforeUpdate?(prevProps: Readonly<P>, prevState: Readonly<S>): SS | null;
+  getSnapshotBeforeUpdate?(prevProps: Readonly<P>, prevState: Readonly<S>): SS | null
   /**
    * Called immediately after updating occurs. Not called for the initial render.
    *
    * The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.
    */
-  componentDidUpdate?(prevProps: Readonly<P>, prevState: Readonly<S>, snapshot?: SS): void;
+  componentDidUpdate?(prevProps: Readonly<P>, prevState: Readonly<S>, snapshot?: SS): void
 }
 
 declare module './index' {
@@ -165,11 +165,18 @@ declare module './index' {
     imageUrl?: string
   }
 
-  type GetDerivedStateFromProps<P, S> = TaroGetDerivedStateFromProps<P, S>
-
-  type StaticLifecycle<P, S> = TaroStaticLifecycle<P, S>
-
-  type NewLifecycle<P, S, SS> = TaroNewLifecycle<P, S, SS>
+  interface ComponentLifecycle<P, S, SS = any> extends TaroNewLifecycle<P, S, SS> {
+    componentWillMount?(): void
+    componentDidMount?(): void
+    componentWillReceiveProps?(nextProps: Readonly<P>, nextContext: any): void
+    shouldComponentUpdate?(nextProps: Readonly<P>, nextState: Readonly<S>, nextContext: any): boolean
+    componentWillUpdate?(nextProps: Readonly<P>, nextState: Readonly<S>, nextContext: any): void
+    componentWillUnmount?(): void
+    componentDidCatch?(err: string): void
+    componentDidShow?(): void
+    componentDidHide?(): void
+    componentDidNotFound?(opt: PageNotFoundObject): void
+  }
 
   interface TaroStatic {
     PageNotFoundObject: PageNotFoundObject