@micro-zoe/micro-app 1.0.0-alpha.9 → 1.0.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@micro-zoe/micro-app",
-  "version": "1.0.0-alpha.9",
+  "version": "1.0.0-beta.1",
   "description": "A lightweight, efficient and powerful micro front-end framework",
   "private": false,
   "main": "lib/index.min.js",
@@ -24,7 +24,7 @@
     "install:child-react17": "cd dev/children/react17 && yarn",
     "install:child-vue2": "cd dev/children/vue2 && yarn",
     "install:child-vue3": "cd dev/children/vue3 && yarn",
-    "install:child-vite": "cd dev/children/vite && yarn",
+    "install:child-vite2": "cd dev/children/vite2 && yarn",
     "install:child-angular11": "cd dev/children/angular11 && yarn",
     "main-react16": "cd dev/main-react16 && yarn start",
     "main-vue2": "cd dev/main-vue2 && yarn start",
@@ -33,7 +33,7 @@
     "start-child:react17": "cd dev/children/react17 && yarn start",
     "start-child:vue2": "cd dev/children/vue2 && yarn start",
     "start-child:vue3": "cd dev/children/vue3 && yarn start",
-    "start-child:vite": "cd dev/children/vite && yarn start",
+    "start-child:vite2": "cd dev/children/vite2 && yarn start",
     "start-child:angular11": "cd dev/children/angular11 && yarn start",
     "docs": "docsify serve docs --port 2000",
     "lint": "eslint --cache '**/*.{js,ts}'",

package/typings/global.d.ts

@@ -24,10 +24,33 @@ declare module '@micro-app/types' {
 
   type fiberTasks = Array<() => Promise<void>> | null
 
+  type MicroEventListener = EventListenerOrEventListenerObject & Record<string, any>
+
+  type timeInfo = {
+    handler: TimerHandler,
+    timeout?: number,
+    args: any[],
+  }
+
+  interface releaseEffectParams {
+    umdMode: boolean,
+    isPrerender: boolean,
+    keepAlive: boolean,
+    destroy: boolean,
+  }
+
   interface EffectController {
-    recordEffect(): void
-    rebuildEffect(): void
-    releaseEffect(): void
+    reset(): void
+    record(): void
+    rebuild(): void
+    release(options: releaseEffectParams): void
+  }
+
+  interface CommonIframeEffect {
+    reset(): void
+    record(): void
+    rebuild(): void
+    release(umdMode?: boolean, preRender?: boolean): void
   }
 
   interface SandBoxStartParams {
@@ -41,23 +64,37 @@ declare module '@micro-app/types' {
   interface SandBoxStopParams {
     umdMode: boolean
     keepRouteState: boolean
-    clearEventSource: boolean
+    destroy: boolean
     clearData: boolean
   }
 
-  interface SandBoxInterface {
+  interface releaseGlobalEffectParams {
+    clearData?: boolean,
+    isPrerender?: boolean,
+    keepAlive?: boolean,
+    destroy?: boolean,
+  }
+
+  interface WithSandBoxInterface {
     proxyWindow: WindowProxy
     microAppWindow: Window // Proxy target
     start (startParams: SandBoxStartParams): void
     stop (stopParams: SandBoxStopParams): void
-    releaseGlobalEffect (clearData?: boolean): void
+    recordAndReleaseEffect (options: releaseGlobalEffectParams, preventRecord?: boolean): void
+    // reset effect snapshot data
+    resetEffectSnapshot(): void
     // record umd snapshot before the first execution of umdHookMount
     recordEffectSnapshot (): void
     // rebuild umd snapshot before remount umd app
     rebuildEffectSnapshot (): void
+    releaseGlobalEffect (options: releaseGlobalEffectParams): void
     setRouteInfoForKeepAliveApp (): void
     removeRouteInfoForKeepAliveApp (): void
     setPreRenderState (state: boolean): void
+    markUmdMode(state: boolean): void
+    patchStaticElement (container: Element | ShadowRoot): void
+    actionBeforeExecScripts (container: Element | ShadowRoot): void
+    deleteIframeElement? (): void
   }
 
   interface SandBoxAdapter {
@@ -71,7 +108,7 @@ declare module '@micro-app/types' {
     staticScopeProperties: PropertyKey[]
 
     // adapter for react
-    // injectReactHRMProperty (): void
+    // injectReactHMRProperty (): void
   }
 
   type LinkSourceInfo = {
@@ -96,7 +133,7 @@ declare module '@micro-app/types' {
       attrs: Map<string, string>, // element attributes
       parsedCode?: string, // bind code
       parsedFunction?: Function | null, // code to function
-      wrapInSandBox?: boolean // use sandbox
+      sandboxType?: 'with' | 'iframe' | 'disable' // sandbox type (with, iframe, disable)
     }>
   }
 
@@ -114,7 +151,6 @@ declare module '@micro-app/types' {
     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
   }
 
@@ -126,15 +162,16 @@ declare module '@micro-app/types' {
   }
 
   // app instance
-  interface AppInterface {
+  interface AppInterface extends Pick<ParentNode, 'querySelector' | 'querySelectorAll'> {
     source: sourceType // source list
-    sandBox: SandBoxInterface | null // sandbox
+    // TODO: 去掉any
+    sandBox: WithSandBoxInterface | null | any // sandbox
     name: string // app name
     url: string // app url
     scopecss: boolean // whether use css scoped, default is true
     useSandbox: boolean // whether use js sandbox, default is true
     inline: boolean //  whether js runs in inline script mode, default is false
-    esmodule: boolean // support esmodule in script
+    iframe: boolean // use iframe sandbox
     ssrUrl: string // html path in ssr mode
     container: HTMLElement | ShadowRoot | null // container maybe null, micro-app, shadowRoot, div(keep-alive)
     umdMode: boolean // is umd mode
@@ -204,7 +241,7 @@ declare module '@micro-app/types' {
     'disable-scopecss'?: boolean
     'disable-sandbox'?: boolean
     inline?: boolean
-    esmodule?: boolean
+    iframe?: boolean
     level?: number
     'default-page'?: string
     'disable-patch-request'?: boolean
@@ -296,7 +333,7 @@ declare module '@micro-app/types' {
     'hidden-router'?: boolean
     'keep-alive'?: boolean
     'clear-data'?: boolean
-    esmodule?: boolean
+    iframe?: boolean
     ssr?: boolean
     fiber?: boolean
     prefetchLevel?: number
@@ -311,6 +348,7 @@ declare module '@micro-app/types' {
     fetch?: fetchType
     globalAssets?: globalAssetsType,
     excludeAssetFilter?: (assetUrl: string) => boolean
+    getRootElementParentNode?: (node: Node, appName: AppName) => void
   }
 
   // MicroApp config
@@ -325,13 +363,10 @@ declare module '@micro-app/types' {
   // special CallableFunction for interact
   type CallableFunctionForInteract = CallableFunction & { __APP_NAME__?: string, __AUTO_TRIGGER__?: boolean }
 
-  interface ShadowLocation {
-    [k: string]: string
-  }
+  type PopStateListener = (this: Window, e: PopStateEvent) => void
+  type MicroPopStateEvent = PopStateEvent & { onlyForBrowser?: boolean }
 
   interface MicroLocation extends Location, URL {
-    // shadowLocation is the current location information (href, pathname, search, hash)
-    shadowLocation: ShadowLocation
     fullPath: string
     [key: string]: any
   }