@micro-zoe/micro-app 1.0.0-alpha.6 → 1.0.0-alpha.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@micro-zoe/micro-app",
-  "version": "1.0.0-alpha.6",
+  "version": "1.0.0-alpha.9",
   "description": "A lightweight, efficient and powerful micro front-end framework",
   "private": false,
   "main": "lib/index.min.js",

package/typings/global.d.ts

@@ -7,14 +7,29 @@ declare module '@micro-app/types' {
 
   type microAppWindowType = Window & any
 
-  type appName = string
+  type AppName = string
 
   type SourceAddress = string
 
   type AttrsType = Map<string, string>
 
+  type RequestIdleCallbackOptions = {
+    timeout: number
+  }
+
+  type RequestIdleCallbackInfo = {
+    readonly didTimeout: boolean
+    timeRemaining: () => number
+  }
+
   type fiberTasks = Array<() => Promise<void>> | null
 
+  interface EffectController {
+    recordEffect(): void
+    rebuildEffect(): void
+    releaseEffect(): void
+  }
+
   interface SandBoxStartParams {
     umdMode: boolean
     baseroute: string
@@ -27,6 +42,7 @@ declare module '@micro-app/types' {
     umdMode: boolean
     keepRouteState: boolean
     clearEventSource: boolean
+    clearData: boolean
   }
 
   interface SandBoxInterface {
@@ -34,12 +50,14 @@ declare module '@micro-app/types' {
     microAppWindow: Window // Proxy target
     start (startParams: SandBoxStartParams): void
     stop (stopParams: SandBoxStopParams): void
+    releaseGlobalEffect (clearData?: boolean): void
     // record umd snapshot before the first execution of umdHookMount
-    recordUmdSnapshot (): void
+    recordEffectSnapshot (): void
     // rebuild umd snapshot before remount umd app
-    rebuildUmdSnapshot (): void
+    rebuildEffectSnapshot (): void
     setRouteInfoForKeepAliveApp (): void
     removeRouteInfoForKeepAliveApp (): void
+    setPreRenderState (state: boolean): void
   }
 
   interface SandBoxAdapter {
@@ -89,16 +107,22 @@ declare module '@micro-app/types' {
   }
 
   interface MountParam {
-    container: HTMLElement | ShadowRoot
-    inline: boolean
-    useMemoryRouter: boolean
-    baseroute: string
-    keepRouteState: boolean
-    defaultPage: string
-    hiddenRouter: boolean
-    disablePatchRequest: boolean
-    fiber: boolean
-    esmodule: boolean
+    container: HTMLElement | ShadowRoot // app container
+    inline: boolean // run js in inline mode
+    useMemoryRouter: boolean // use virtual router
+    defaultPage: string // default page of virtual router
+    baseroute: string // route prefix, default is ''
+    disablePatchRequest: boolean // prevent rewrite request method of child app
+    fiber: boolean // run js in fiber mode
+    esmodule: boolean // support type='module' script
+    // hiddenRouter: boolean
+  }
+
+  interface UnmountParam {
+    destroy: boolean, // completely destroy, delete cache resources
+    clearData: boolean // clear data of dateCenter
+    keepRouteState: boolean // keep route state when unmount, default is false
+    unmountcb?: CallableFunction // callback of unmount
   }
 
   // app instance
@@ -112,12 +136,13 @@ declare module '@micro-app/types' {
     inline: boolean //  whether js runs in inline script mode, default is false
     esmodule: boolean // support esmodule in script
     ssrUrl: string // html path in ssr mode
-    isPrefetch: boolean // whether prefetch app, default is false
     container: HTMLElement | ShadowRoot | null // container maybe null, micro-app, shadowRoot, div(keep-alive)
-    keepRouteState: boolean // keep route state when unmount, default is false
     umdMode: boolean // is umd mode
     fiber: boolean // fiber mode
     useMemoryRouter: boolean // use virtual router
+    isPrefetch: boolean // whether prefetch app, default is false
+    isPrerender: boolean
+    prefetchLevel?: number
     // defaultPage: string // default page when mount
     // baseroute: string // route prefix, default is ''
     // hiddenRouter: boolean // hide router info of child from browser url
@@ -126,7 +151,7 @@ declare module '@micro-app/types' {
     loadSourceCode (): void
 
     // resource is loaded
-    onLoad (html: HTMLElement): void
+    onLoad (html: HTMLElement, defaultPage?: string, disablePatchRequest?: boolean): void
 
     // Error loading HTML
     onLoadError (e: Error): void
@@ -135,7 +160,7 @@ declare module '@micro-app/types' {
     mount (mountParams: MountParam): void
 
     // unmount app
-    unmount (destroy: boolean, unmountcb?: CallableFunction): void
+    unmount (unmountParam: UnmountParam): void
 
     // app rendering error
     onerror (e: Error): void
@@ -149,7 +174,7 @@ declare module '@micro-app/types' {
     actionsForCompletelyDestroy (): void
 
     // hidden app when disconnectedCallback with keep-alive
-    hiddenKeepAliveApp (): void
+    hiddenKeepAliveApp (callback?: CallableFunction): void
 
     // show app when connectedCallback with keep-alive
     showKeepAliveApp (container: HTMLElement | ShadowRoot): void
@@ -169,7 +194,7 @@ declare module '@micro-app/types' {
     attributeChangedCallback (a: 'name' | 'url', o: string, n: string): void
   }
 
-  type prefetchParam = {
+  interface prefetchParam {
     name: string,
     url: string,
     // old config 👇
@@ -180,6 +205,9 @@ declare module '@micro-app/types' {
     'disable-sandbox'?: boolean
     inline?: boolean
     esmodule?: boolean
+    level?: number
+    'default-page'?: string
+    'disable-patch-request'?: boolean
   }
 
   // prefetch params
@@ -187,14 +215,14 @@ declare module '@micro-app/types' {
 
   // lifeCycles
   interface lifeCyclesType {
-    created?(e?: CustomEvent): void
-    beforemount?(e?: CustomEvent): void
-    mounted?(e?: CustomEvent): void
-    unmount?(e?: CustomEvent): void
-    error?(e?: CustomEvent): void
-    beforeshow?(e?: CustomEvent): void
-    aftershow?(e?: CustomEvent): void
-    afterhidden?(e?: CustomEvent): void
+    created(e: CustomEvent): void
+    beforemount(e: CustomEvent): void
+    mounted(e: CustomEvent): void
+    unmount(e: CustomEvent): void
+    error(e: CustomEvent): void
+    beforeshow(e: CustomEvent): void
+    aftershow(e: CustomEvent): void
+    afterhidden(e: CustomEvent): void
   }
 
   type AssetsChecker = (url: string) => boolean;
@@ -239,6 +267,11 @@ declare module '@micro-app/types' {
     }
   }
 
+  type GetActiveAppsParam = {
+    excludeHiddenApp?: boolean,
+    excludePreRender?: boolean,
+  }
+
   type fetchType = (url: string, options: Record<string, unknown>, appName: string | null) => Promise<string>
 
   type globalAssetsType = {
@@ -246,8 +279,7 @@ declare module '@micro-app/types' {
     css?: string[],
   }
 
-  type OptionsType = {
-    tagName?: string
+  interface MicroAppConfig {
     shadowDOM?: boolean
     destroy?: boolean
     destory?: boolean
@@ -263,9 +295,16 @@ declare module '@micro-app/types' {
     'keep-router-state'?: boolean
     'hidden-router'?: boolean
     'keep-alive'?: boolean
+    'clear-data'?: boolean
     esmodule?: boolean
     ssr?: boolean
     fiber?: boolean
+    prefetchLevel?: number
+    prefetchDelay?: number
+  }
+
+  interface OptionsType extends MicroAppConfig {
+    tagName?: string
     lifeCycles?: lifeCyclesType
     preFetchApps?: prefetchParamList
     plugins?: plugins
@@ -275,7 +314,7 @@ declare module '@micro-app/types' {
   }
 
   // MicroApp config
-  interface MicroAppConfigType {
+  interface MicroAppBaseType {
     tagName: string
     options: OptionsType
     preFetch(apps: prefetchParamList): void
@@ -352,6 +391,11 @@ declare module '@micro-app/types' {
     path: string,
   }
 
+  type AttachAllToURLParam = {
+    includeHiddenApp?: boolean,
+    includePreRender?: boolean,
+  }
+
   // Router API for developer
   interface Router {
     // current route of all apps
@@ -424,7 +468,7 @@ declare module '@micro-app/types' {
     /**
      * Attach all active app router info to browser url
      */
-    attachAllToURL(): void
+    attachAllToURL(options: AttachAllToURLParam): void
     /**
      * Record base app router, let child app control base app navigation
      * It is global data