@tarojs/taro 3.3.20 → 3.4.0-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tarojs/taro",
-  "version": "3.3.20",
+  "version": "3.4.0-beta.3",
   "description": "Taro framework",
   "homepage": "https://github.com/nervjs/taro/tree/master/packages/taro#readme",
   "main": "index.js",
@@ -24,9 +24,9 @@
   "author": "O2Team",
   "license": "MIT",
   "dependencies": {
-    "@tarojs/api": "3.3.20",
-    "@tarojs/runtime": "3.3.20",
-    "@tarojs/taro-h5": "3.3.20"
+    "@tarojs/api": "3.4.0-beta.3",
+    "@tarojs/runtime": "3.4.0-beta.3",
+    "@tarojs/taro-h5": "3.4.0-beta.3"
   },
-  "gitHead": "f98ceefaa3e419db5a6c3bcd3bf123ce5a0a0124"
+  "gitHead": "2ef7e8c10c9e5784e98bb1ad3a803d5fd6a46c8b"
 }

package/types/compile.d.ts

@@ -53,12 +53,12 @@ export type IOption = Record<string, any>
 
 export interface ICopyOptions {
   patterns: {
-    from: string,
-    to: string,
-    ignore?: string[],
-    transform?: Function,
+    from: string
+    to: string
+    ignore?: string[]
+    transform?: Function
     watch?: boolean
-  }[],
+  }[]
   options: {
     ignore?: string[]
   }
@@ -68,11 +68,11 @@ export interface ISassOptions {
   /**
    * 引入的全局 sass 文件，如果要引入多个文件，支持数组形式传入
    */
-  resource?: string | string[],
+  resource?: string | string[]
   /**
    * 项目根目录的绝对地址(若为小程序云开发模板，则应该是client目录)
    */
-  projectDirectory?: string,
+  projectDirectory?: string
   /**
    * 全局 scss 变量，若 data 与 resource 中设置了同样的变量，则 data 的优先级高于 resource
    */
@@ -89,21 +89,21 @@ export namespace PostcssOption {
     generateScopedName: string | ((localName: string, absoluteFilePath: string) => string)
   }>
   export type url = TogglableOptions<{
-    limit: number,
+    limit: number
     basePath?: string | string[]
   }>
 }
 
 export interface IPostcssOption {
-  autoprefixer?: TogglableOptions,
-  pxtransform?: TogglableOptions,
-  cssModules?: PostcssOption.cssModules,
-  url?: PostcssOption.url,
+  autoprefixer?: TogglableOptions
+  pxtransform?: TogglableOptions
+  cssModules?: PostcssOption.cssModules
+  url?: PostcssOption.url
   [key: string]: any
 }
 
 export interface ICompileOption {
-  exclude?: string[],
+  exclude?: string[]
   include?: string[]
 }
 
@@ -113,85 +113,85 @@ interface Runtime {
 }
 
 export interface IMiniAppConfig {
-  appOutput?: boolean,
-  enableSourceMap?: boolean,
-  sourceMapType?: string,
-  debugReact?: boolean,
+  appOutput?: boolean
+  enableSourceMap?: boolean
+  sourceMapType?: string
+  debugReact?: boolean
   minifyXML?: {
     collapseWhitespace?: boolean
-  },
-
-  webpackChain?: (chain: any, webpack: any, PARSE_AST_TYPE: any) => void,
-  entry?: webpack.Entry,
-  output?: webpack.Output,
-  postcss?: IPostcssOption,
-  cssLoaderOption?: IOption,
-  sassLoaderOption?: IOption,
-  lessLoaderOption?: IOption,
-  stylusLoaderOption?: IOption,
-  mediaUrlLoaderOption?: IOption,
-  fontUrlLoaderOption?: IOption,
-  imageUrlLoaderOption?: IOption,
-  miniCssExtractPluginOption?: IOption,
-
-  customFilesTypes?: IMINI_APP_FILE_TYPE,
-  commonChunks?: string[] | ((commonChunks: string[]) => string[]),
-  addChunkPages?: ((pages: Map<string, string[]>, pagesNames?: string[]) => void),
+  }
+
+  webpackChain?: (chain: any, webpack: any, PARSE_AST_TYPE: any) => void
+  entry?: webpack.Entry
+  output?: webpack.Output
+  postcss?: IPostcssOption
+  cssLoaderOption?: IOption
+  sassLoaderOption?: IOption
+  lessLoaderOption?: IOption
+  stylusLoaderOption?: IOption
+  mediaUrlLoaderOption?: IOption
+  fontUrlLoaderOption?: IOption
+  imageUrlLoaderOption?: IOption
+  miniCssExtractPluginOption?: IOption
+
+  customFilesTypes?: IMINI_APP_FILE_TYPE
+  commonChunks?: string[] | ((commonChunks: string[]) => string[])
+  addChunkPages?: ((pages: Map<string, string[]>, pagesNames?: string[]) => void)
   optimizeMainPackage?: {
-    enable?: boolean,
+    enable?: boolean
     exclude?: any[]
-  },
+  }
 
   compile?: {
-    exclude?: any[],
+    exclude?: any[]
     include?: any[]
   }
   runtime?: Runtime
 }
 
 export type TogglableOptions<T = IOption> = {
-  enable?: boolean,
+  enable?: boolean
   config?: T
 }
 
 export interface IH5RouterConfig {
-  mode?: 'hash' | 'browser' | 'multi',
-  customRoutes?: IOption,
-  basename?: string,
-  lazyload?: boolean | ((pagename: string) => boolean),
+  mode?: 'hash' | 'browser' | 'multi'
+  customRoutes?: IOption
+  basename?: string
+  lazyload?: boolean | ((pagename: string) => boolean)
   renamePagename?: (pagename: string) => string
   forcePath?: string
 }
 
 export interface IH5Config {
-  publicPath?: string,
-  staticDirectory?: string,
-  chunkDirectory?: string,
+  publicPath?: string
+  staticDirectory?: string
+  chunkDirectory?: string
 
   webpack?: ((webpackConfig: webpack.Configuration, webpack) => webpack.Configuration) | webpack.Configuration
 
-  webpackChain?: (chain: any, webpack: any) => void,
-
-  entry?: webpack.Entry,
-  output?: webpack.Output,
-  router?: IH5RouterConfig,
-  devServer?: webpackDevServer.Configuration,
-  enableSourceMap?: boolean,
-  sourceMapType?: 'none' | 'eval' | 'cheap-eval-source-map' | 'cheap-module-eval-source-map' | 'eval-source-map' | 'cheap-source-map' | 'cheap-module-source-map' | 'inline-cheap-source-map' | 'inline-cheap-module-source-map' | 'source-map' | 'inline-source-map' | 'hidden-source-map' | 'nosources-source-map',
-  enableExtract?: boolean,
-  transformOnly?: boolean,
-
-  cssLoaderOption?: IOption,
-  styleLoaderOption?: IOption,
-  sassLoaderOption?: IOption,
-  lessLoaderOption?: IOption,
-  stylusLoaderOption?: IOption,
-  mediaUrlLoaderOption?: IOption,
-  fontUrlLoaderOption?: IOption,
-  imageUrlLoaderOption?: IOption,
-  miniCssExtractPluginOption?: IOption,
-  esnextModules?: string[],
-  useHtmlComponents?: boolean,
+  webpackChain?: (chain: any, webpack: any) => void
+
+  entry?: webpack.Entry
+  output?: webpack.Output
+  router?: IH5RouterConfig
+  devServer?: webpackDevServer.Configuration
+  enableSourceMap?: boolean
+  sourceMapType?: 'none' | 'eval' | 'cheap-eval-source-map' | 'cheap-module-eval-source-map' | 'eval-source-map' | 'cheap-source-map' | 'cheap-module-source-map' | 'inline-cheap-source-map' | 'inline-cheap-module-source-map' | 'source-map' | 'inline-source-map' | 'hidden-source-map' | 'nosources-source-map'
+  enableExtract?: boolean
+  transformOnly?: boolean
+
+  cssLoaderOption?: IOption
+  styleLoaderOption?: IOption
+  sassLoaderOption?: IOption
+  lessLoaderOption?: IOption
+  stylusLoaderOption?: IOption
+  mediaUrlLoaderOption?: IOption
+  fontUrlLoaderOption?: IOption
+  imageUrlLoaderOption?: IOption
+  miniCssExtractPluginOption?: IOption
+  esnextModules?: string[]
+  useHtmlComponents?: boolean
 
   postcss?: IPostcssOption
 }
@@ -213,11 +213,11 @@ export type SystemConfig = {
   /**
    * 打印日志等级，分为 off,error,warn,info,log,debug
    */
-  logLevel?: LogLevel,
+  logLevel?: LogLevel
   /**
    * 页面设计基准宽度，根据实际设备宽度来缩放元素大小
    */
-  designWidth?: number,
+  designWidth?: number
   /**
    * 全局数据对象，属性名不能以$或_开头，在页面中可通过 this 进行访问;如果全局数据属性与页面的数据属性重名，则页面初始化时，全局数据会覆盖页面中对应的属性值
    */
@@ -228,7 +228,7 @@ type RouterConfig = {
   /**
    * 首页名称
    */
-  entry: string,
+  entry: string
   /**
    * 页面配置列表，key 值为页面名称（对应页面目录名，例如 Hello 对应'Hello'目录），value 为页面详细配置 page
    */
@@ -238,14 +238,14 @@ type RouterPage = {
   /**
    * 页面对应的组件名，与 ux 文件名保持一致，例如'hello' 对应 'hello.ux'
    */
-  component: string,
+  component: string
   /**
    * 页面路径，例如“/user”,不填则默认为/<页面名称>。
    * path 必须唯一,不能和其他 page 的 path 相同。
    * 下面 page 的 path 因为缺失,会被设置为“/Index”：
    * "Index": {"component": "index"}
    */
-  path?: string,
+  path?: string
   /**
    * 声明页面可以处理某种请求
    */
@@ -260,31 +260,31 @@ interface IDefaultDisplayConfig {
   /**
    * 窗口背景颜色
    */
-  backgroundColor?: string,
+  backgroundColor?: string
   /**
    * 是否是全屏模式，默认不会同时作用于 titleBar，titleBar 需要继续通过 titleBar 控制
    */
-  fullScreen?: boolean,
+  fullScreen?: boolean
   /**
    * 是否显示 titleBar
    */
-  titleBar?: boolean,
+  titleBar?: boolean
   /**
    * 标题栏背景色
    */
-  titleBarBackgroundColor?: string,
+  titleBarBackgroundColor?: string
   /**
    * 标题栏文字颜色
    */
-  titleBarTextColor?: string,
+  titleBarTextColor?: string
   /**
    * 标题栏文字(也可通过页面跳转传递参数(titleBarText)设置)
    */
-  titleBarText?: string,
+  titleBarText?: string
   /**
    * 是否显示标题栏右上角菜单按钮，点击菜单按钮调用页面生命周期 onMenuPress 方法，如果该方法未实现则显示系统默认菜单
    */
-  menu?: boolean,
+  menu?: boolean
   /**
    * 软键盘弹出时为保证输入框可见，页面的调整方式。　adjustPan:上移页面; adjustResize:压缩页面显示区域，当页面全屏时，此设置不生效
    */
@@ -304,31 +304,31 @@ export interface ITaroManifestConfig {
   /**
    * 应用包名，确认与原生应用的包名不一致，推荐采用 com.company.module 的格式，如：com.example.demo
    */
-  package: string,
+  package: string
   /**
    * 应用名称，6 个汉字以内，与应用商店保存的名称一致，用于在桌面图标、弹窗等处显示应用名称
    */
-  name: string,
+  name: string
   /**
    * 应用图标，提供 192x192 大小的即可
    */
-  icon: string,
+  icon: string
   /**
    * 应用版本名称，如："1.0"
    */
-  versionName?: string,
+  versionName?: string
   /**
    * 应用版本号，从1自增，推荐每次重新上传包时versionCode+1
    */
-  versionCode: number,
+  versionCode: number
   /**
    * 支持的最小平台版本号，兼容性检查，避免上线后在低版本平台运行并导致不兼容；如果不填按照内测版本处理
    */
-  minPlatformVersion?: string,
+  minPlatformVersion?: string
   /**
    * 接口列表，绝大部分接口都需要在这里声明，否则不能调用，详见每个接口的文档说明
    */
-  features?: FeatureItem[],
+  features?: FeatureItem[]
   /**
    *
    */
@@ -339,11 +339,11 @@ export interface IManifestConfig extends ITaroManifestConfig {
   /**
    * 系统配置信息
    */
-  config: SystemConfig,
+  config: SystemConfig
   /**
    * 路由信息
    */
-  router: RouterConfig,
+  router: RouterConfig
   /**
    * UI 显示相关配置
    */
@@ -353,24 +353,24 @@ export interface IManifestConfig extends ITaroManifestConfig {
 export type PluginItem = string | [string, object]
 
 export interface IProjectBaseConfig {
-  projectName?: string,
-  date?: string,
-  designWidth?: number,
-  watcher?: any[],
-  deviceRatio?: TaroGeneral.TDeviceRatio,
-  sourceRoot?: string,
-  outputRoot?: string,
-  env?: IOption,
-  alias?: IOption,
-  defineConstants?: IOption,
-  copy?: ICopyOptions,
-  csso?: TogglableOptions,
-  terser?: TogglableOptions,
-  uglify?: TogglableOptions,
-  sass?: ISassOptions,
-  plugins?: PluginItem[],
+  projectName?: string
+  date?: string
+  designWidth?: number
+  watcher?: any[]
+  deviceRatio?: TaroGeneral.TDeviceRatio
+  sourceRoot?: string
+  outputRoot?: string
+  env?: IOption
+  alias?: IOption
+  defineConstants?: IOption
+  copy?: ICopyOptions
+  csso?: TogglableOptions
+  terser?: TogglableOptions
+  uglify?: TogglableOptions
+  sass?: ISassOptions
+  plugins?: PluginItem[]
   presets?: PluginItem[]
-  baseLevel?: number,
+  baseLevel?: number
   framework?: string
 }
 

package/types/index.d.ts

@@ -136,3 +136,7 @@ declare namespace Taro {
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface TaroStatic {}
 }
+declare global {
+  const defineAppConfig: (config: Taro.Config) => Taro.Config
+  const definePageConfig: (config: Taro.Config) => Taro.Config
+}

package/types/taro.component.d.ts

@@ -21,7 +21,7 @@ declare module './index' {
     onPageScroll?(obj: PageScrollObject): void
     onShareAppMessage?(obj: ShareAppMessageObject): ShareAppMessageReturn
     onTabItemTap?(obj: TabItemTapObject): void
-    onResize?(obj: any): void
+    onResize?(obj: PageResizeObject): void
   }
 
   interface ComponentOptions {

package/types/taro.config.d.ts

@@ -309,7 +309,7 @@ declare module './index' {
      * 声明分包预下载的规则。
      * preloadRule 中，key 是页面路径，value 是进入此页面的预下载配置
      * 注意: 分包预下载目前只支持通过配置方式使用，暂不支持通过调用API完成。
-     *      vConsole 里有preloadSubpackages开头的日志信息，可以用来验证预下载的情况。
+     *      vConsole 里有 preloadSubpackages 开头的日志信息，可以用来验证预下载的情况。
      * @since 2.3.0
      */
     preloadRule?: PreloadRule
@@ -335,12 +335,12 @@ declare module './index' {
      */
     style?: 'v2'
     /**
-     * 配置 darkmode 为 true，即表示当前小程序已适配 DarkMode
+     * 配置 darkMode 为 true，即表示当前小程序已适配 DarkMode
      * @since 2.11.0
      */
     darkmode?: boolean
     /**
-     * 指定 darkmode 变量配置文件 theme.json 路径
+     * 指定 darkMode 变量配置文件 theme.json 路径
      * @since 2.11.0
      */
     themeLocation?: string

package/types/taro.extend.d.ts

@@ -42,6 +42,10 @@ declare module './index' {
     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
@@ -87,5 +91,20 @@ declare module './index' {
     Current: Current
 
     getCurrentInstance(): Current
+
+    /**
+     * @desc Vue3 插件，用于设置 `getApp()` 中的全局变量
+     * @example
+     * ```js
+     * // 使用插件
+     * const App = createApp(...)
+     * App.use(setGlobalDataPlugin, {
+     *   xxx: 999
+     * })
+     * // 获取全局变量
+     * Taro.getApp().xxx
+     * ```
+     */
+    setGlobalDataPlugin: SetGlobalDataPlugin
   }
 }

package/types/taro.hooks.d.ts

@@ -5,32 +5,32 @@ declare module './index' {
     /**
      * 页面展示时的回调。
      */
-    useDidShow(callback: () => any): void
+    useDidShow(callback: () => void): void
 
     /**
      * 页面隐藏时的回调。
      */
-    useDidHide(callback: () => any): void
+    useDidHide(callback: () => void): void
 
     /**
      * 下拉刷新时的回调。
      */
-    usePullDownRefresh(callback: () => any): void
+    usePullDownRefresh(callback: () => void): void
 
     /**
      * 上拉触底时的回调。
      */
-    useReachBottom(callback: () => any): void
+    useReachBottom(callback: () => void): void
 
     /**
      * 页面滚动时的回调。
      */
-    usePageScroll(callback: (payload: PageScrollObject) => any): void
+    usePageScroll(callback: (payload: PageScrollObject) => void): void
 
     /**
      * 页面尺寸改变时的回调。
      */
-    useResize(callback: () => any): void
+    useResize(callback: (payload: PageResizeObject) => void): void
 
     /**
      * 页面转发时的回调。
@@ -40,12 +40,12 @@ declare module './index' {
     /**
      * 当前是 tab 页时，tab 被点击时的回调。
      */
-    useTabItemTap(callback: (payload: TabItemTapObject) => any): void
+    useTabItemTap(callback: (payload: TabItemTapObject) => void): void
 
     /**
      * 用户点击右上角菜单“收藏”按钮时的回调。
      */
-    useAddToFavorites(callback: (paload: AddToFavoritesObject) => AddToFavoritesReturnObject): void
+    useAddToFavorites(callback: (payload: AddToFavoritesObject) => AddToFavoritesReturnObject): void
 
     /**
      * 用户点击右上角菜单“分享到朋友圈”按钮时的回调。
@@ -56,7 +56,7 @@ declare module './index' {
      * 页面初次渲染完成的回调。
      * 此时页面已经准备妥当，可以和视图层进行交互。
      */
-    useReady(callback: () => any): void
+    useReady(callback: () => void): void
 
     /**
      * 获取当前路由参数。
@@ -67,18 +67,18 @@ declare module './index' {
      * 导航栏的标题被点击时的回调。
      * **仅支付宝小程序支持。**
      */
-    useTitleClick(callback: () => any): void
+    useTitleClick(callback: () => void): void
 
     /**
      * 导航栏的额外图标被点击时的回调。
      * **仅支付宝小程序支持。**
      */
-    useOptionMenuClick(callback: () => any): void
+    useOptionMenuClick(callback: () => void): void
 
     /**
      * 下拉中断时的回调。
      * **仅支付宝小程序支持。**
      */
-    usePullIntercept(callback: () => any): void
+    usePullIntercept(callback: () => void): void
   }
 }

package/types/taro.lifecycle.d.ts

@@ -55,6 +55,13 @@ declare module './index' {
     scrollTop: number
   }
 
+  interface PageResizeObject {
+    size: {
+      windowWidth: number
+      windowHeight: number
+    }
+  }
+
   interface ShareAppMessageObject {
     /**
      * 转发事件来源