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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@micro-zoe/micro-app",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.6",
   "description": "A lightweight, efficient and powerful micro front-end framework",
   "private": false,
   "main": "lib/index.min.js",
@@ -44,6 +44,8 @@
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
+    "test:unit": "jest src/__tests__/unit",
+    "test:unit:coverage": "npm run test:unit -- --coverage",
     "prepublishOnly": "yarn build"
   },
   "repository": {

package/typings/global.d.ts

@@ -9,15 +9,31 @@ declare module '@micro-app/types' {
 
   type appName = string
 
+  type SourceAddress = string
+
+  type AttrsType = Map<string, string>
+
+  type fiberTasks = Array<() => Promise<void>> | null
+
+  interface SandBoxStartParams {
+    umdMode: boolean
+    baseroute: string
+    useMemoryRouter: boolean
+    defaultPage: string
+    disablePatchRequest: boolean
+  }
+
+  interface SandBoxStopParams {
+    umdMode: boolean
+    keepRouteState: boolean
+    clearEventSource: boolean
+  }
+
   interface SandBoxInterface {
     proxyWindow: WindowProxy
     microAppWindow: Window // Proxy target
-    start (
-      baseRoute: string,
-      useMemoryRouter: boolean,
-      defaultPage: string,
-    ): void
-    stop (keepRouteState: boolean, clearEventSource: boolean): void
+    start (startParams: SandBoxStartParams): void
+    stop (stopParams: SandBoxStopParams): void
     // record umd snapshot before the first execution of umdHookMount
     recordUmdSnapshot (): void
     // rebuild umd snapshot before remount umd app
@@ -40,48 +56,71 @@ declare module '@micro-app/types' {
     // injectReactHRMProperty (): void
   }
 
-  type sourceLinkInfo = {
-    code: string // code
-    placeholder?: Comment | null // placeholder comment
-    isGlobal: boolean // is global asset
+  type LinkSourceInfo = {
+    code: string, // source code
+    appSpace: Record<string, {
+      attrs: Map<string, string>, // active element.attributes
+      placeholder?: Comment | null, // placeholder comment
+      parsedCode?: string, // parsed code
+      prefix?: string, // micro-app[name=appName]
+    }>
   }
 
-  type sourceScriptInfo = {
-    code: string // code
-    isExternal: boolean // external script
-    isDynamic: boolean // dynamic create script
-    async: boolean // async script
-    defer: boolean // defer script
-    module: boolean // module type script
-    isGlobal?: boolean // share js to global
-    code2Function?: Function // code to Function
+  type ScriptSourceInfo = {
+    code: string, // source code
+    isExternal: boolean, // external script
+    appSpace: Record<string, {
+      async: boolean, // async script
+      defer: boolean, // defer script
+      module: boolean, // module type script
+      inline: boolean, // run js with inline script
+      pure: boolean, // pure script
+      attrs: Map<string, string>, // element attributes
+      parsedCode?: string, // bind code
+      parsedFunction?: Function | null, // code to function
+      wrapInSandBox?: boolean // use sandbox
+    }>
   }
 
-  interface sourceType {
-    html?: HTMLElement
-    links: Map<string, sourceLinkInfo>
-    scripts: Map<string, sourceScriptInfo>
+  type sourceType = {
+    html: HTMLElement | null, // html address
+    links: Set<string>, // style/link address list
+    scripts: Set<string>, // script address list
+  }
+
+  interface MountParam {
+    container: HTMLElement | ShadowRoot
+    inline: boolean
+    useMemoryRouter: boolean
+    baseroute: string
+    keepRouteState: boolean
+    defaultPage: string
+    hiddenRouter: boolean
+    disablePatchRequest: boolean
+    fiber: boolean
+    esmodule: boolean
   }
 
   // app instance
   interface AppInterface {
-    isPrefetch: boolean // whether prefetch app, default is false
-    prefetchResolve: (() => void) | null // prefetch callback
+    source: sourceType // source list
+    sandBox: SandBoxInterface | null // sandbox
     name: string // app name
     url: string // app url
-    ssrUrl: string // html path in ssr mode
-    container: HTMLElement | ShadowRoot | null // container maybe null, micro-app, shadowRoot, DIV(keep-alive)
-    inline: boolean //  whether js runs in inline script mode, default is false
     scopecss: boolean // whether use css scoped, default is true
     useSandbox: boolean // whether use js sandbox, default is true
-    useMemoryRouter: boolean // whether use memoryRouter, default is true
-    baseroute: string // route prefix, default is ''
+    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
-    hiddenRouter: boolean // hide router info of child from browser url
-    source: sourceType // sources of css, js, html
-    sandBox: SandBoxInterface | null // sandbox
     umdMode: boolean // is umd mode
-    defaultPage: string // default page when mount
+    fiber: boolean // fiber mode
+    useMemoryRouter: boolean // use virtual router
+    // defaultPage: string // default page when mount
+    // baseroute: string // route prefix, default is ''
+    // hiddenRouter: boolean // hide router info of child from browser url
 
     // Load resources
     loadSourceCode (): void
@@ -93,14 +132,7 @@ declare module '@micro-app/types' {
     onLoadError (e: Error): void
 
     // mount app
-    mount (
-      container?: HTMLElement | ShadowRoot,
-      inline?: boolean,
-      baseroute?: string,
-      keepRouteState?: boolean,
-      defaultPage?: string,
-      hiddenRouter?: boolean
-    ): void
+    mount (mountParams: MountParam): void
 
     // unmount app
     unmount (destroy: boolean, unmountcb?: CallableFunction): void
@@ -146,7 +178,8 @@ declare module '@micro-app/types' {
     // old config 👆
     'disable-scopecss'?: boolean
     'disable-sandbox'?: boolean
-    'disable-memory-router'?: boolean
+    inline?: boolean
+    esmodule?: boolean
   }
 
   // prefetch params
@@ -159,8 +192,13 @@ declare module '@micro-app/types' {
     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;
+
   type plugins = {
     // global plugin
     global?: Array<{
@@ -168,10 +206,16 @@ declare module '@micro-app/types' {
       scopeProperties?: Array<PropertyKey>
       // Properties that can be escape to rawWindow
       escapeProperties?: Array<PropertyKey>
+      // Exclude JS or CSS
+      excludeChecker?: AssetsChecker
+      // Ignore JS or CSS
+      ignoreChecker?: AssetsChecker
       // options for plugin as the third parameter of loader
-      options?: unknown
+      options?: Record<string, unknown>
       // handle function
-      loader?: (code: string, url: string, options: unknown, info: sourceScriptInfo) => string
+      loader?: (code: string, url: string) => string
+      // html processor
+      processHtml?: (code: string, url: string) => string
     }>
 
     // plugin for special app
@@ -181,10 +225,16 @@ declare module '@micro-app/types' {
         scopeProperties?: Array<PropertyKey>
         // Properties that can be escape to rawWindow
         escapeProperties?: Array<PropertyKey>
+        // Exclude JS or CSS
+        excludeChecker?: AssetsChecker
+        // Ignore JS or CSS
+        ignoreChecker?: AssetsChecker
         // options for plugin as the third parameter of loader
-        options?: unknown
+        options?: Record<string, unknown>
         // handle function
-        loader?: (code: string, url: string, options: unknown, info: sourceScriptInfo) => string
+        loader?: (code: string, url: string) => string
+        // html processor
+        processHtml?: (code: string, url: string) => string
       }>
     }
   }
@@ -198,9 +248,10 @@ declare module '@micro-app/types' {
 
   type OptionsType = {
     tagName?: string
-    'shadowDOM'?: boolean
-    'destroy'?: boolean
-    'inline'?: boolean
+    shadowDOM?: boolean
+    destroy?: boolean
+    destory?: boolean
+    inline?: boolean
     // old config 👇
     disableScopecss?: boolean
     disableSandbox?: boolean
@@ -208,30 +259,25 @@ declare module '@micro-app/types' {
     'disable-scopecss'?: boolean
     'disable-sandbox'?: boolean
     'disable-memory-router'?: boolean
+    'disable-patch-request'?: boolean
     'keep-router-state'?: boolean
     'hidden-router'?: boolean
-    'esmodule'?: boolean
-    'ssr'?: boolean
+    'keep-alive'?: boolean
+    esmodule?: boolean
+    ssr?: boolean
+    fiber?: boolean
     lifeCycles?: lifeCyclesType
     preFetchApps?: prefetchParamList
     plugins?: plugins
     fetch?: fetchType
     globalAssets?: globalAssetsType,
+    excludeAssetFilter?: (assetUrl: string) => boolean
   }
 
   // MicroApp config
   interface MicroAppConfigType {
     tagName: string
-    shadowDOM?: boolean
-    destroy?: boolean
-    inline?: boolean
-    disableScopecss?: boolean
-    disableSandbox?: boolean
-    disableMemoryRouter?: boolean
-    ssr?: boolean
-    lifeCycles?: lifeCyclesType
-    plugins?: plugins
-    fetch?: fetchType
+    options: OptionsType
     preFetch(apps: prefetchParamList): void
     router: Router // eslint-disable-line
     start(options?: OptionsType): void
@@ -297,10 +343,15 @@ declare module '@micro-app/types' {
     [appName: string]: (to: GuardLocation, from: GuardLocation) => void
   }
 
-  type GlobalNormalGuard = ((appName: string, to: GuardLocation, from: GuardLocation) => void)
+  type GlobalNormalGuard = ((to: GuardLocation, from: GuardLocation, appName: string) => void)
 
   type RouterGuard = AccurateGuard | GlobalNormalGuard
 
+  type SetDefaultPageOptions = {
+    name: string,
+    path: string,
+  }
+
   // Router API for developer
   interface Router {
     // current route of all apps
@@ -355,10 +406,9 @@ declare module '@micro-app/types' {
     afterEach(guard: RouterGuard): () => boolean
     /**
      * Add defaultPage to control the first rendered page
-     * @param appName app name
-     * @param path default page path
+     * @param options SetDefaultPageOptions
      */
-    setDefaultPage(appName: string, path: string): () => boolean
+    setDefaultPage(options: SetDefaultPageOptions): () => boolean
     /**
      * Clear data of defaultPage that set by setDefaultPage
      */
@@ -366,7 +416,7 @@ declare module '@micro-app/types' {
     /**
      * Get defaultPage that set by setDefaultPage
      */
-    getDefaultPage(key: PropertyKey): string | undefined
+    getDefaultPage(key: PropertyKey): string | void
     /**
      * Attach specified active app router info to browser url
      */