@tarojs/taro 3.4.0-beta.0 → 3.4.0

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

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 /// <reference types="vue" />
 
-import Taro, { ComponentOptions, Config, RouterInfo } from './index'
+import Taro, { Config } from './index'
 
 declare module './index' {
   // Components
@@ -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 {
@@ -80,14 +80,16 @@ declare module './index' {
   type SFC = StatelessFunctionComponent
 
   interface Show {
-    componentDidShow?(options?: unknown): void
-    componentDidHide?(options?: unknown): void
-    onShow?(options?: unknown): void
-    onHide?(options?: unknown): void
+    componentDidShow?(): void
+    componentDidHide?(): void
+    onShow?(): void
+    onHide?(): void
   }
 
   interface AppInstance extends Show {
     mount(component: React.ComponentClass | Vue.ComponentOptions<Vue>, id: string, cb: () => void): void
+    componentDidShow?(options?: Record<string, unknown>): void
+    onShow?(options?: Record<string, unknown>): void
     unmount(id: string, cb: () => void): void
   }
 

package/types/taro.config.d.ts

@@ -235,7 +235,24 @@ declare module './index' {
     }
   }
 
+  interface RouterAnimate {
+    /**
+     * 动画切换时间，单位毫秒
+     * @default 300
+     */
+    duration?: number
+    /**
+     * 动画切换时间，单位毫秒
+     * @default 50
+     */
+    delay?: number
+  }
+
   interface AppConfig {
+    /**
+     * 小程序默认启动首页，未指定 entryPagePath 时，数组的第一项代表小程序的初始页面（首页）。
+     */
+    entryPagePath?: string
     /**
      * 接受一个数组，每一项都是字符串，来指定小程序由哪些页面组成，数组的第一项代表小程序的初始页面
      */
@@ -292,7 +309,7 @@ declare module './index' {
      * 声明分包预下载的规则。
      * preloadRule 中，key 是页面路径，value 是进入此页面的预下载配置
      * 注意: 分包预下载目前只支持通过配置方式使用，暂不支持通过调用API完成。
-     *      vConsole 里有preloadSubpackages开头的日志信息，可以用来验证预下载的情况。
+     *      vConsole 里有 preloadSubpackages 开头的日志信息，可以用来验证预下载的情况。
      * @since 2.3.0
      */
     preloadRule?: PreloadRule
@@ -318,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
@@ -331,6 +348,18 @@ declare module './index' {
      * 接受一个数组，每一项都是字符串，来指定编译为原生小程序组件的组件入口
      */
     components?: string[]
+    /**
+     * 渲染页面的容器 id
+     * @default "app"
+     * @since 3.3.18
+     */
+    appId?: string
+    /**
+     * 是否开启 h5 端路由动画功能，默认开启
+     * @supported h5
+     * @since 3.3.18
+     */
+    animation?: RouterAnimate | boolean
   }
 
   interface Config extends PageConfig, AppConfig {
@@ -354,6 +383,7 @@ declare module './index' {
     PreloadRule: PreloadRule
     Permission: Permission
     AppConfig: AppConfig
+    RouterAnimate: RouterAnimate
     Config: Config
   }
 }

package/types/taro.extend.d.ts

@@ -13,21 +13,6 @@ declare module './index' {
     [propName: string]: any
   }
 
-  type interceptor = (chain: Chain) => any
-
-  interface Chain {
-    index: number
-    requestParams: RequestParams
-    interceptors: interceptor[]
-    proceed(requestParams: RequestParams): any
-  }
-
-  interface interceptors {
-    logInterceptor(chain: Chain): Promise<any>
-
-    timeoutInterceptor(chain: Chain): Promise<any>
-  }
-
   interface Current {
     app: AppInstance | null
     router: RouterInfo | null
@@ -46,10 +31,27 @@ declare module './index' {
     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
+    }
+
     // eventCenter
     eventCenter: TaroGeneral.Events
 
+    ENV_TYPE: TARO_ENV_TYPE
+
     getEnv(): TaroGeneral.ENV_TYPE
 
     render(component: Component | JSX.Element, element: Element | null): any
@@ -60,9 +62,7 @@ declare module './index' {
     atMessage(options: AtMessageOptions): void
 
     pxTransform(size: number, designWidth?: number): string
-    initPxTransform(config: { designWidth: number; deviceRatio: object }): void
-
-    addInterceptor(interceptor: interceptor): any
+    initPxTransform(config: { designWidth: number; deviceRatio: TaroGeneral.TDeviceRatio }): void
 
     /**
      * 小程序引用插件 JS 接口

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 {
     /**
      * 转发事件来源

package/h5.js

@@ -1,4 +0,0 @@
-import Taro from '@tarojs/taro-h5'
-export * from '@tarojs/taro-h5'
-
-export default Taro