@tarojs/taro 3.7.0-alpha.2 → 3.7.0-alpha.20

package/types/compile/viteCompilerContext.d.ts

@@ -0,0 +1,128 @@
+import type { AppConfig, PageConfig } from "../index"
+import type { IMiniFilesConfig, IH5Config, IMiniAppConfig } from "./config"
+import type { IProjectConfig } from './config/project'
+import type { PluginContext } from "rollup"
+import { IComponentConfig } from "./hooks"
+
+import type { RecursiveTemplate, UnRecursiveTemplate } from '@tarojs/shared/dist/template'
+
+export interface ViteNativeCompMeta {
+  name: string
+  scriptPath: string
+  configPath: string
+  config: PageConfig
+  isNative: true
+  templatePath: string
+  cssPath?: string
+}
+
+export interface ViteFileType {
+  config: string
+  script: string
+  templ: string
+  style: string
+  xs?: string
+}
+
+export interface ViteAppMeta {
+  name: string
+  scriptPath: string
+  configPath: string
+  config: AppConfig
+  isNative: false
+}
+
+export interface VitePageMeta {
+  name: string
+  scriptPath: string
+  configPath: string
+  config: PageConfig
+  isNative: boolean
+  templatePath?: string
+  cssPath?: string
+}
+
+
+export interface ViteH5BuildConfig extends CommonBuildConfig, IH5Config<'vite'> {
+  entryFileName?: string
+  runtimePath?: string | string[]
+}
+
+export interface CommonBuildConfig extends IProjectConfig<'vite'> {
+  entry: {
+    app: string | string[]
+  }
+  mode: 'production' | 'development' | 'none'
+  buildAdapter: string // weapp | swan | alipay | tt | qq | jd | h5
+  platformType: string // mini | web
+  /** special mode */
+  isBuildNativeComp?: boolean
+  /** hooks */
+  onCompilerMake: (compilation) => Promise<any>
+  onParseCreateElement: (nodeName, componentConfig) => Promise<any>
+}
+
+
+export interface ViteMiniBuildConfig extends CommonBuildConfig, IMiniAppConfig<'vite'> {
+  isBuildPlugin: boolean
+  isSupportRecursive: boolean
+  isSupportXS: boolean
+  nodeModulesPath: string
+  fileType: ViteFileType
+  globalObject: string
+  template: RecursiveTemplate | UnRecursiveTemplate
+  runtimePath?: string | string[]
+  taroComponentsPath?: string
+  blended?: boolean
+  hot?: boolean
+  injectOptions?: {
+    include?: Record<string, string | string[]>
+    exclude?: string[]
+  }
+  /** hooks */
+  modifyComponentConfig: (componentConfig: IComponentConfig, config: Partial<ViteMiniBuildConfig>) => Promise<any>
+}
+
+export interface ViteCompilerContext<T> {
+  cwd: string
+  sourceDir: string
+  taroConfig: T
+  rawTaroConfig: T
+  frameworkExts: string[]
+  app: ViteAppMeta
+  pages: VitePageMeta[]
+  loaderMeta: any
+  logger
+  filesConfig: IMiniFilesConfig
+  configFileList: string[]
+  compilePage: (pageName: string) => VitePageMeta
+  watchConfigFile: (rollupCtx: PluginContext) => void
+  getAppScriptPath: () => string
+  getApp: () => ViteAppMeta
+  getPages: () => VitePageMeta[]
+  isApp: (id: string) => boolean
+  isPage: (id: string) => boolean
+  isNativePageORComponent: (templatePath: string) => boolean
+  getPageById: (id: string) => VitePageMeta| undefined
+  getConfigFilePath: (filePath: string) => string
+  getTargetFilePath: (filePath: string, targetExtName: string) => string
+}
+
+export interface ViteH5CompilerContext extends ViteCompilerContext<ViteH5BuildConfig> {
+  routerMeta: {
+    routerCreator: string
+    getRoutesConfig: (pageName?: string) => string
+  }
+}
+
+export interface ViteMiniCompilerContext extends ViteCompilerContext<ViteMiniBuildConfig> {
+  fileType: ViteFileType
+  commonChunks: string[]
+  nativeComponents : Map<string, ViteNativeCompMeta>
+  getCommonChunks: () => string[]
+  collectNativeComponents: (meta: ViteAppMeta | VitePageMeta | ViteNativeCompMeta) => void
+  getScriptPath: (filePath: string) => string
+  getTemplatePath: (filePath: string) => string
+  getStylePath: (filePath: string) => string
+  getConfigPath: (filePath: string) => string
+}

package/types/global.d.ts

@@ -2,11 +2,12 @@ declare namespace TaroGeneral {
   type IAnyObject = Record<string, any>
   type Optional<F> = F extends (arg: infer P) => infer R ? (arg?: P) => R : F
   type OptionalInterface<T> = { [K in keyof T]: Optional<T[K]> }
+  type TFunc = (...args: any[]) => any
   /** 事件监听函数 */
   type EventCallback = (
     /** 触发事件参数 */
     ...args: any
-    ) => void
+  ) => void
   /** 通用错误 */
   interface CallbackResult {
     /** 错误信息 */
@@ -35,7 +36,7 @@ declare namespace TaroGeneral {
     /** 阻止事件冒泡到父元素,阻止任何父事件处理程序被执行 */
     stopPropagation: () => void
   }
-  interface currentTarget extends Target {}
+  interface currentTarget extends Target { }
   interface Target {
     /** 事件源组件的id */
     id: string
@@ -378,33 +379,33 @@ declare namespace TaroGeneral {
      */
     13024
   }
-
+  type EventName = string | symbol
   // Events
   class Events {
     /**
      * 监听一个事件，接受参数
      */
-    on(eventName: string, listener: (...args: any[]) => void): this
+    on (eventName: EventName, listener: (...args: any[]) => void): this
 
     /**
      * 添加一个事件监听，并在事件触发完成之后移除Callbacks链
      */
-    once(eventName: string, listener: (...args: any[]) => void): this
+    once (eventName: EventName, listener: (...args: any[]) => void): this
 
     /**
      * 取消监听一个事件
      */
-    off(eventName: string, listener?: (...args: any[]) => void): this
+    off (eventName: EventName, listener?: (...args: any[]) => void): this
 
     /**
      * 取消监听的所有事件
      */
-    off(): this
+    off (): this
 
     /**
      * 触发一个事件，传参
      */
-    trigger(eventName: string, ...args: any[]): boolean
+    trigger (eventName: EventName, ...args: any[]): this
   }
 
   // ENV_TYPE

package/types/index.d.ts

@@ -87,6 +87,8 @@
  * │   │   └── index.d.ts                   路由 API
  * │   ├── share
  * │   │   └── index.d.ts                   转发 API
+ * │   ├── skyline
+ * │   │   └── index.d.ts                   微信 Skyline API
  * │   ├── storage
  * │   │   ├── background-fetch.d.ts        数据缓存 -> 后台获取 API
  * │   │   └── index.d.ts                   数据缓存 API
@@ -108,13 +110,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 +125,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" />
@@ -132,6 +132,8 @@
 /// <reference types="@tarojs/plugin-platform-swan/types/shims-swan" />
 /// <reference types="@tarojs/plugin-platform-tt/types/shims-tt" />
 /// <reference types="@tarojs/plugin-platform-weapp/types/shims-weapp" />
+/// <reference types="@tarojs/taro-h5/types/overlay" />
+/// <reference types="@tarojs/taro-rn/types/overlay" />
 
 export = Taro
 export as namespace Taro

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 👍👍👍
  *
  */
@@ -41,6 +41,7 @@
 /// <reference path="api/payment/index.d.ts" />
 /// <reference path="api/storage/index.d.ts" />
 /// <reference path="api/storage/background-fetch.d.ts" />
+/// <reference path="api/storage/cache-manager.d.ts" />
 /// <reference path="api/data-analysis/index.d.ts" />
 /// <reference path="api/canvas/index.d.ts" />
 /// <reference path="api/media/map.d.ts" />
@@ -71,9 +72,12 @@
 /// <reference path="api/open-api/subscribe-message.d.ts" />
 /// <reference path="api/open-api/redpackage.d.ts" />
 /// <reference path="api/open-api/favorites.d.ts" />
+/// <reference path="api/open-api/my-miniprogram.d.ts" />
 /// <reference path="api/open-api/license-plate.d.ts" />
 /// <reference path="api/open-api/channels.d.ts" />
+/// <reference path="api/open-api/device-voip.d.ts" />
 /// <reference path="api/open-api/group.d.ts" />
+/// <reference path="api/open-api/privacy.d.ts" />
 /// <reference path="api/open-api/customer-service.d.ts" />
 /// <reference path="api/device/bluetooth.d.ts" />
 /// <reference path="api/device/bluetooth-ble.d.ts" />
@@ -88,6 +92,7 @@
 /// <reference path="api/device/clipboard.d.ts" />
 /// <reference path="api/device/network.d.ts" />
 /// <reference path="api/device/screen.d.ts" />
+/// <reference path="api/device/sms.d.ts" />
 /// <reference path="api/device/keyboard.d.ts" />
 /// <reference path="api/device/phone.d.ts" />
 /// <reference path="api/device/accelerometer.d.ts" />
@@ -99,10 +104,12 @@
 /// <reference path="api/device/vibrate.d.ts" />
 /// <reference path="api/ai/visionkit.d.ts" />
 /// <reference path="api/ai/face.d.ts" />
+/// <reference path="api/ai/inference.d.ts" />
 /// <reference path="api/worker/index.d.ts" />
 /// <reference path="api/wxml/index.d.ts" />
 /// <reference path="api/ext/index.d.ts" />
 /// <reference path="api/ad/index.d.ts" />
+/// <reference path="api/skyline/index.d.ts" />
 
 /// <reference path="api/cloud/index.d.ts" />
 /// <reference path="api/open-api/facial.d.ts" />
@@ -110,3 +117,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
@@ -51,6 +51,7 @@ declare module './index' {
     onReachBottom?(): void
     onResize?(opt: PageResizeObject): void
     onShareAppMessage?(opt: ShareAppMessageObject): ShareAppMessageReturn
+    onShareTimeline?(): ShareTimelineReturnObject
     onTabItemTap?(opt: TabItemTapObject): void
     onTitleClick?(): void
     onUnload(): void
@@ -89,7 +90,7 @@ declare module './index' {
     /** 创建一个 SelectorQuery 对象，选择器选取范围为这个组件实例内 */
     createSelectorQuery?(): SelectorQuery
     /** 创建一个 IntersectionObserver 对象，选择器选取范围为这个组件实例内 */
-    createIntersectionObserver?(): IntersectionObserver
+    createIntersectionObserver?(options?: createIntersectionObserver.Option): IntersectionObserver
     /** 创建一个 MediaQueryObserver 对象 */
     createMediaQueryObserver?(): MediaQueryObserver
     /** 使用选择器选择组件实例节点，返回匹配到的第一个组件实例对象（会被 wx://component-export 影响） */

package/types/taro.config.d.ts

@@ -154,6 +154,11 @@ declare module './index' {
      * @default: false
      */
     disableScroll?: boolean
+    /** 是否使用页面全局滚动，MPA下默认为全局滚动，SPA默认为局部滚动
+     * 只在H5生效
+     * @default: MPA:true  SPA:false
+     */
+    usingWindowScroll?: boolean
     /** 禁止页面右滑手势返回
      *
      * **注意** 自微信客户端 7.0.5 开始，页面配置中的 disableSwipeBack 属性将不再生效，
@@ -210,6 +215,22 @@ declare module './index' {
      * @default "webview"
      */
     renderer?: 'webview' | 'skyline'
+    /**
+     * 组件框架
+     * @default "exparser"
+     * @see https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/glass-easel/migration.html
+     */
+    componentFramework?: 'exparser' | 'glass-easel'
+    /**
+     * 指定特殊的样式隔离选项
+     *
+     * isolated 表示启用样式隔离，在自定义组件内外，使用 class 指定的样式将不会相互影响（一般情况下的默认值）
+     *
+     * apply-shared 表示页面 wxss 样式将影响到自定义组件，但自定义组件 wxss 中指定的样式不会影响页面
+     *
+     * shared 表示页面 wxss 样式将影响到自定义组件，自定义组件 wxss 中指定的样式也会影响页面和其他设置了 apply-shared 或 shared 的自定义组件。（这个选项在插件中不可用。）
+     */
+    styleIsolation?: 'isolated' | 'apply-shared' | 'shared'
     /**
      * 设置导航栏额外图标，目前支持设置属性 icon，值为图标 url（以 https/http 开头）或 base64 字符串，大小建议 30*30 px
      *
@@ -340,6 +361,59 @@ declare module './index' {
     delay?: number
   }
 
+  interface RenderOptions {
+    skyline: {
+      /** 开启默认Block布局
+       * @see https://developers.weixin.qq.com/miniprogram/dev/framework/runtime/skyline/wxss.html#%E5%BC%80%E5%90%AF%E9%BB%98%E8%AE%A4Block%E5%B8%83%E5%B1%80
+       * @supported weapp
+       */
+      defaultDisplayBlock?: boolean
+      /** 关闭 Skyline AB 实验
+       * @see https://developers.weixin.qq.com/miniprogram/dev/framework/runtime/skyline/migration/release.html#%E5%8F%91%E5%B8%83%E4%B8%8A%E7%BA%BF
+       * @supported weapp
+       */
+      disableABTest?: boolean
+      /** 基础库最低版本
+       * @supported weapp
+       */
+      sdkVersionBegin?: string
+      /** 基础库最高版本
+       * @supported weapp
+       */
+      sdkVersionEnd?: string
+      /** iOS 微信最低版本
+       * @supported weapp
+       */
+      iosVersionBegin?: string
+      /** iOS 微信最高版本
+       * @supported weapp
+       */
+      iosVersionEnd?: string
+      /** 安卓微信最低版本
+       * @supported weapp
+       */
+      androidVersionBegin?: string
+      /** 安卓微信最高版本
+       * @supported weapp
+       */
+      androidVersionEnd?: string
+      [key: string]: unknown
+    }
+  }
+
+  interface Behavior {
+    /**
+     * 使用小程序默认分享功能时（即不显式设置 Page.onShareAppMessage），当设置此字段后，会使客户端生成的用于分享的 scheme 带上当前用户打开的页面所携带的 query 参数。
+     * @supported alipay 基础库 2.7.10 及以上开始支持，同时需使用 IDE 2.7.0 及以上版本进行构建。
+     */
+    shareAppMessage?: 'appendQuery'
+    /**
+     * 小程序在解析全局参数、页面参数时默认会对键/值做 encodeURIComponent。当设置为 disable 后，则不再对键/值做encodeURIComponent
+     * @supported alipay 基础库 2.7.19 及以上开始支持，同时需使用 IDE 3.0.0 及以上版本进行构建。
+     */
+    decodeQuery?: 'disable'
+  }
+
   interface AppConfig {
     /** 小程序默认启动首页，未指定 entryPagePath 时，数组的第一项代表小程序的初始页面（首页）。 */
     entryPagePath?: string
@@ -360,7 +434,11 @@ declare module './index' {
      * @default false
      * @since 2.1.0
      */
-    functionalPages?: boolean
+    functionalPages?:
+      | boolean
+      | {
+          independent?: boolean
+        }
     /** 分包结构配置
      * @example
      * ```json
@@ -381,7 +459,7 @@ declare module './index' {
      * 使用 Worker 处理多线程任务时，设置 Worker 代码放置的目录
      * @since 1.9.90
      */
-    workers?: string
+    workers?: string | string[]
     /** 申明需要后台运行的能力，类型为数组。目前支持以下项目：
      * - audio: 后台音乐播放
      * - location: 后台定位
@@ -548,6 +626,48 @@ declare module './index' {
      * @default "webview"
      */
     renderer?: 'webview' | 'skyline'
+    /**
+     * 渲染后端选项
+     * @see https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#rendererOptions
+     */
+    rendererOptions?: RenderOptions
+    /**
+     * 指定小程序使用的组件框架
+     * @default "exparser"
+     * @see https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/glass-easel/migration.html
+     */
+    componentFramework?: 'exparser' | 'glass-easel'
+    /**
+     * 多端模式场景接入身份管理服务时开启小程序授权页相关配置
+     * @see https://dev.weixin.qq.com/docs/framework/getting_started/auth.html#%E6%96%B0%E6%89%8B%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B
+     */
+    miniApp?: {
+      /**
+       * 用于 wx.weixinMinProgramLogin 在小程序中插入「小程序授权 Page」
+       */
+      useAuthorizePage: boolean
+    }
+    /**
+     * 在 2023年9月15号之前，在 app.json 中配置 __usePrivacyCheck__: true 后，会启用隐私相关功能，如果不配置或者配置为 false 则不会启用。
+     * 在 2023年9月15号之后，不论 app.json 中是否有配置 __usePrivacyCheck__，隐私相关功能都会启用
+     * @supported weapp
+     */
+    __usePrivacyCheck__?: boolean
+    /**
+     * 正常情况下默认所有资源文件都被打包发布到所有平台，可以通过 static 字段配置特定每个目录/文件只能发布到特定的平台(多端场景)
+     * @see https://dev.weixin.qq.com/docs/framework/guideline/devtools/condition-compile.html#%E8%B5%84%E6%BA%90
+     */
+    static?: { pattern: string; platforms: string[] }[]
+    /**
+     * 	动态插件配置规则,声明小程序需要使用动态插件
+     * @supported alipay
+     */
+    useDynamicPlugins?: boolean
+    /**
+     * 用于改变小程序若干运行行为
+     * @supported alipay
+     */
+    behavior?: Behavior
   }
 
   interface Config extends PageConfig, AppConfig {

package/types/taro.extend.d.ts

@@ -1,112 +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 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
-
-    /** 小程序引用插件 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
-  }
-}