@micro-zoe/micro-app 1.0.0-alpha.1 → 1.0.0-alpha.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@micro-zoe/micro-app",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.4",
   "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

@@ -7,15 +7,23 @@ declare module '@micro-app/types' {
 
   type microAppWindowType = Window & any
 
+  type appName = string
+
   interface SandBoxInterface {
     proxyWindow: WindowProxy
     microAppWindow: Window // Proxy target
     start (
+      umdMode: boolean,
       baseRoute: string,
       useMemoryRouter: boolean,
       defaultPage: string,
+      disablePatchRequest: boolean,
+    ): void
+    stop (
+      umdMode: boolean,
+      keepRouteState: boolean,
+      clearEventSource: boolean,
     ): void
-    stop (keepRouteState: boolean, clearEventSource: boolean): void
     // record umd snapshot before the first execution of umdHookMount
     recordUmdSnapshot (): void
     // rebuild umd snapshot before remount umd app
@@ -75,6 +83,7 @@ declare module '@micro-app/types' {
     useMemoryRouter: boolean // whether use memoryRouter, default is true
     baseroute: string // route prefix, default is ''
     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
@@ -96,6 +105,8 @@ declare module '@micro-app/types' {
       baseroute?: string,
       keepRouteState?: boolean,
       defaultPage?: string,
+      hiddenRouter?: boolean,
+      disablePatchRequest?: boolean,
     ): void
 
     // unmount app
@@ -136,10 +147,13 @@ declare module '@micro-app/types' {
   type prefetchParam = {
     name: string,
     url: string,
+    // old config 👇
     disableScopecss?: boolean
     disableSandbox?: boolean
-    disableMemoryRouter?: boolean
-    shadowDOM?: boolean
+    // old config 👆
+    'disable-scopecss'?: boolean
+    'disable-sandbox'?: boolean
+    'disable-memory-router'?: boolean
   }
 
   // prefetch params
@@ -154,6 +168,8 @@ declare module '@micro-app/types' {
     error?(e?: CustomEvent): void
   }
 
+  type AssetsChecker = (url: string) => boolean;
+
   type plugins = {
     // global plugin
     global?: Array<{
@@ -161,10 +177,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
       // handle function
       loader?: (code: string, url: string, options: unknown, info: sourceScriptInfo) => string
+      // html processor
+      processHtml?: (code: string, url: string, options: unknown) => string
     }>
 
     // plugin for special app
@@ -174,10 +196,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
         // handle function
         loader?: (code: string, url: string, options: unknown, info: sourceScriptInfo) => string
+        // html processor
+        processHtml?: (code: string, url: string, options: unknown) => string
       }>
     }
   }
@@ -191,13 +219,21 @@ declare module '@micro-app/types' {
 
   type OptionsType = {
     tagName?: string
-    shadowDOM?: boolean
-    destroy?: boolean
-    inline?: boolean
+    'shadowDOM'?: boolean
+    'destroy'?: boolean
+    'inline'?: boolean
+    // old config 👇
     disableScopecss?: boolean
     disableSandbox?: boolean
-    disableMemoryRouter?: boolean
-    ssr?: boolean
+    // old config 👆
+    '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
     lifeCycles?: lifeCyclesType
     preFetchApps?: prefetchParamList
     plugins?: plugins
@@ -287,6 +323,11 @@ declare module '@micro-app/types' {
 
   type RouterGuard = AccurateGuard | GlobalNormalGuard
 
+  type SetDefaultPageOptions = {
+    name: string,
+    path: string,
+  }
+
   // Router API for developer
   interface Router {
     // current route of all apps
@@ -339,10 +380,37 @@ declare module '@micro-app/types' {
      * @param guard global hook for
      */
     afterEach(guard: RouterGuard): () => boolean
-
-    setDefaultPage(appName: string, path: string): () => boolean
+    /**
+     * Add defaultPage to control the first rendered page
+     * @param options SetDefaultPageOptions
+     */
+    setDefaultPage(options: SetDefaultPageOptions): () => boolean
+    /**
+     * Clear data of defaultPage that set by setDefaultPage
+     */
     removeDefaultPage(appName: string): boolean
+    /**
+     * Get defaultPage that set by setDefaultPage
+     */
     getDefaultPage(key: PropertyKey): string | undefined
+    /**
+     * Attach specified active app router info to browser url
+     */
+    attachToURL(appName: string): void
+    /**
+     * Attach all active app router info to browser url
+     */
+    attachAllToURL(): void
+    /**
+     * Record base app router, let child app control base app navigation
+     * It is global data
+     * @param baseRouter router instance of base app
+     */
+    setBaseAppRouter(baseRouter: unknown): void
+    /**
+     * get baseRouter from cache
+     */
+    getBaseAppRouter(): unknown
   }
 
   // result of add/remove microApp path on browser url