@micro-zoe/micro-app 1.0.0-rc.2 → 1.0.0-rc.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@micro-zoe/micro-app",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0-rc.21",
   "description": "A lightweight, efficient and powerful micro front-end framework",
   "private": false,
   "main": "lib/index.min.js",
@@ -52,7 +52,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/micro-zoe/micro-app.git"
+    "url": "https://github.com/jd-opensource/micro-app.git"
   },
   "publishConfig": {
     "access": "public"
@@ -72,7 +72,7 @@
   "author": "cangdu",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/micro-zoe/micro-app/issues"
+    "url": "https://github.com/jd-opensource/micro-app/issues"
   },
   "husky": {
     "hooks": {
@@ -96,6 +96,7 @@
     "@rollup/plugin-babel": "~5.2.2",
     "@rollup/plugin-node-resolve": "~11.0.1",
     "@rollup/plugin-replace": "~2.4.1",
+    "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "~8.1.0",
     "@types/jest": "~26.0.24",
     "@types/node": "~14.14.19",
@@ -125,7 +126,6 @@
     "node-fetch": "~2.6.1",
     "npm-run-all": "~4.1.5",
     "pretty-bytes": "~5.5.0",
-    "react": "~17.0.2",
     "rollup": "~2.35.1",
     "rollup-plugin-terser": "~7.0.2",
     "ts-jest": "~26.5.6",

package/typings/global.d.ts

@@ -65,28 +65,28 @@ declare module '@micro-app/types' {
     destroy?: boolean,
   }
 
-  interface SandBoxAdapter {
+  interface BaseSandboxType {
+    // Properties that can only get and set in microAppWindow, will not escape to rawWindow
+    scopeProperties: PropertyKey[]
+    // Properties that can be escape to rawWindow
+    escapeProperties: PropertyKey[]
+    // Properties newly added to microAppWindow
+    injectedKeys: Set<PropertyKey>
+    // Properties escape to rawWindow, cleared when unmount
+    escapeKeys: Set<PropertyKey>
+    // Sandbox ready state
+    sandboxReady: Promise<void>
     // Variables that can only assigned to rawWindow
-    escapeSetterKeyList: PropertyKey[]
-
+    rawWindowScopeKeyList: PropertyKey[]
     // Variables that can escape to rawWindow
     staticEscapeProperties: PropertyKey[]
-
     // Variables that scoped in child app
     staticScopeProperties: PropertyKey[]
+    // clear mount, unmount when stop in default mode
+    clearHijackUmdHooks: () => void
   }
 
-  interface WithSandBoxInterface {
-    // adapter for sandbox
-    adapter: SandBoxAdapter
-    // Scoped global Properties(Properties that can only get and set in microAppWindow, will not escape to rawWindow)
-    scopeProperties: PropertyKey[]
-    // Properties that can be escape to rawWindow
-    escapeProperties: PropertyKey[]
-    // Properties escape to rawWindow, cleared when unmount
-    escapeKeys: Set<PropertyKey>
-    // Properties newly added to microAppWindow
-    injectedKeys: Set<PropertyKey>
+  interface WithSandBoxInterface extends BaseSandboxType {
     // proxy(microWindow)
     proxyWindow: WindowProxy
     // child window
@@ -106,8 +106,9 @@ declare module '@micro-app/types' {
     setPreRenderState (state: boolean): void
     markUmdMode(state: boolean): void
     patchStaticElement (container: Element | ShadowRoot): void
-    actionBeforeExecScripts (container: Element | ShadowRoot): void
+    actionsBeforeExecScripts (container: Element | ShadowRoot, handleUmdHooks: Func): void
     deleteIframeElement? (): void
+    setStaticAppState (state: string): void
   }
 
   type LinkSourceInfo = {
@@ -153,6 +154,15 @@ declare module '@micro-app/types' {
     // hiddenRouter: boolean
   }
 
+  interface OnLoadParam {
+    html: HTMLElement,
+    // below params is only for prerender app
+    defaultPage?: string // default page of virtual router
+    routerMode?: string // virtual router mode
+    baseroute?: string // route prefix, default is ''
+    disablePatchRequest?: boolean // prevent rewrite request method of child app
+  }
+
   interface UnmountParam {
     destroy: boolean, // completely destroy, delete cache resources
     clearData: boolean // clear data of dateCenter
@@ -161,7 +171,7 @@ declare module '@micro-app/types' {
   }
 
   // app instance
-  interface AppInterface extends Pick<ParentNode, 'querySelector' | 'querySelectorAll'> {
+  interface AppInterface extends Pick<Element, 'querySelector' | 'querySelectorAll'> {
     source: sourceType // source list
     // TODO: 去掉any
     sandBox: WithSandBoxInterface | null | any // sandbox
@@ -178,6 +188,7 @@ declare module '@micro-app/types' {
     routerMode: string // virtual router mode
     isPrefetch: boolean // whether prefetch app, default is false
     isPrerender: boolean
+    isReloading?: boolean
     prefetchLevel?: number
     // defaultPage: string // default page when mount
     // baseroute: string // route prefix, default is ''
@@ -187,7 +198,7 @@ declare module '@micro-app/types' {
     loadSourceCode (): void
 
     // resource is loaded
-    onLoad (html: HTMLElement, defaultPage?: string, disablePatchRequest?: boolean): void
+    onLoad (onLoadParam: OnLoadParam): void
 
     // Error loading HTML
     onLoadError (e: Error): void
@@ -210,6 +221,8 @@ declare module '@micro-app/types' {
     // get keep-alive state
     getKeepAliveState(): string | null
 
+    parseHtmlString(htmlString: string): HTMLElement
+
     // is app unmounted
     isUnmounted (): boolean
 
@@ -238,9 +251,9 @@ declare module '@micro-app/types' {
     inline?: boolean
     iframe?: boolean
     level?: number
+    // prerender only 👇
     'default-page'?: string
     'disable-patch-request'?: boolean
-    // prerender only 👇
     'router-mode'?: string
     baseroute?: string
     // prerender only 👆
@@ -251,14 +264,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, appName: string): void
+    beforemount?(e: CustomEvent, appName: string): void
+    mounted?(e: CustomEvent, appName: string): void
+    unmount?(e: CustomEvent, appName: string): void
+    error?(e: CustomEvent, appName: string): void
+    beforeshow?(e: CustomEvent, appName: string): void
+    aftershow?(e: CustomEvent, appName: string): void
+    afterhidden?(e: CustomEvent, appName: string): void
   }
 
   type AssetsChecker = (url: string) => boolean;
@@ -299,6 +312,7 @@ declare module '@micro-app/types' {
         loader?: (code: string, url: string) => string
         // html processor
         processHtml?: (code: string, url: string) => string
+        aHrefResolver?: (hrefValue: string, appName: string, appUrl: string) => string
       }>
     }
   }
@@ -329,15 +343,16 @@ declare module '@micro-app/types' {
     'disable-memory-router'?: boolean
     'disable-patch-request'?: boolean
     'keep-router-state'?: boolean
-    'hidden-router'?: boolean
     'keep-alive'?: boolean
     'clear-data'?: boolean
     'router-mode'?: string
+    'router-event-delay'?: number | ((appName: string) => number),
     iframe?: boolean
     ssr?: boolean
     fiber?: boolean
     prefetchLevel?: number
     prefetchDelay?: number
+    iframeSrc?: string
   }
 
   interface OptionsType extends MicroAppConfig {
@@ -348,6 +363,9 @@ declare module '@micro-app/types' {
     fetch?: fetchType
     globalAssets?: globalAssetsType,
     excludeAssetFilter?: (assetUrl: string) => boolean
+    excludeRunScriptFilter?: (scriptUrl: string, error: Error, appName: string, appUrl: string) => boolean
+    /* image video audio 是否设置 crossOrigin = 'anonymous' */
+    includeCrossOrigin?: (assetUrl: string) => boolean
     getRootElementParentNode?: (node: Node, appName: AppName) => void
     customProxyDocumentProps?: Map<string | number | symbol, (value: unknown) => void>
   }
@@ -362,25 +380,25 @@ declare module '@micro-app/types' {
     start(options?: OptionsType): void
   }
 
-  interface MicroAppElementType {
+  interface MicroAppElementInterface {
     appName: AttrType // app name
     appUrl: AttrType // app url
-
     // Hooks for element append to documents
     connectedCallback (): void
-
     // Hooks for element delete from documents
     disconnectedCallback (): void
-
     // Hooks for element attributes change
     attributeChangedCallback (a: 'name' | 'url', o: string, n: string): void
-
-    /**
-     * Get configuration
-     * Global setting is lowest priority
-     * @param name Configuration item name
-     */
-    getDisposeResult <T extends keyof OptionsType> (name: T): boolean
+    // public mount action for micro_app_element & create_app
+    mount (app: AppInterface): void
+    // unmount app
+    unmount (destroy?: boolean, unmountcb?: CallableFunction): void
+    // Re render app from the command line
+    reload (destroy?: boolean): Promise<boolean>
+    // get delay time of router event
+    getRouterEventDelay (): number
+    // rewrite micro-app.setAttribute, process attr data
+    setAttribute (key: string, value: any): void
   }
 
   // special CallableFunction for interact
@@ -391,11 +409,17 @@ declare module '@micro-app/types' {
 
   interface MicroLocation extends Location, URL {
     fullPath: string
+    self: URL | Location
     [key: string]: any
   }
 
   type MicroHistory = ProxyHandler<History>
   type MicroState = any
+  interface MicroRouterInfoState {
+    fullPath: string | null,
+    state: MicroState,
+    mode: string,
+  }
   type HistoryProxyValue =
     Pick<
     History,
@@ -434,7 +458,7 @@ declare module '@micro-app/types' {
     replace?: boolean
   }
 
-  type navigationMethod = (to: RouterTarget) => void
+  type navigationMethod = (to: RouterTarget) => Promise<void>
 
   interface AccurateGuard {
     [appName: string]: (to: GuardLocation, from: GuardLocation) => void
@@ -546,12 +570,6 @@ declare module '@micro-app/types' {
   }
 }
 
-declare namespace JSX {
-  interface IntrinsicElements {
-    'micro-app': any
-  }
-}
-
 declare module '@micro-zoe/micro-app/polyfill/jsx-custom-event'
 
 declare const __DEV__: boolean