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

package/package.json

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

package/typings/global.d.ts

@@ -7,6 +7,8 @@ declare module '@micro-app/types' {
 
   type microAppWindowType = Window & any
 
+  type appName = string
+
   interface SandBoxInterface {
     proxyWindow: WindowProxy
     microAppWindow: Window // Proxy target
@@ -15,7 +17,7 @@ declare module '@micro-app/types' {
       useMemoryRouter: boolean,
       defaultPage: string,
     ): void
-    stop (keepRouteState: 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
@@ -24,6 +26,20 @@ declare module '@micro-app/types' {
     removeRouteInfoForKeepAliveApp (): void
   }
 
+  interface SandBoxAdapter {
+    // Variables that can only assigned to rawWindow
+    escapeSetterKeyList: PropertyKey[]
+
+    // Variables that can escape to rawWindow
+    staticEscapeProperties: PropertyKey[]
+
+    // Variables that scoped in child app
+    staticScopeProperties: PropertyKey[]
+
+    // adapter for react
+    // injectReactHRMProperty (): void
+  }
+
   type sourceLinkInfo = {
     code: string // code
     placeholder?: Comment | null // placeholder comment
@@ -61,6 +77,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
@@ -82,6 +99,7 @@ declare module '@micro-app/types' {
       baseroute?: string,
       keepRouteState?: boolean,
       defaultPage?: string,
+      hiddenRouter?: boolean
     ): void
 
     // unmount app
@@ -122,10 +140,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
@@ -177,13 +198,20 @@ 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
+    'keep-router-state'?: boolean
+    'hidden-router'?: boolean
+    'esmodule'?: boolean
+    'ssr'?: boolean
     lifeCycles?: lifeCyclesType
     preFetchApps?: prefetchParamList
     plugins?: plugins
@@ -325,10 +353,38 @@ declare module '@micro-app/types' {
      * @param guard global hook for
      */
     afterEach(guard: RouterGuard): () => boolean
-
+    /**
+     * Add defaultPage to control the first rendered page
+     * @param appName app name
+     * @param path default page path
+     */
     setDefaultPage(appName: string, path: string): () => 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