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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@micro-zoe/micro-app",
-  "version": "0.8.4",
+  "version": "1.0.0-alpha.0",
   "description": "A lightweight, efficient and powerful micro front-end framework",
   "private": false,
   "main": "lib/index.min.js",
@@ -44,7 +44,7 @@
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
-    "prepublishOnly": "yarn lint && yarn test && yarn build"
+    "prepublishOnly": "yarn build"
   },
   "repository": {
     "type": "git",

package/typings/global.d.ts

@@ -1,6 +1,8 @@
 declare module '@micro-app/types' {
   type AttrType = string | null
 
+  type NormalKey = string | number
+
   type Func = (...rest: any[]) => void
 
   type microAppWindowType = Window & any
@@ -8,12 +10,18 @@ declare module '@micro-app/types' {
   interface SandBoxInterface {
     proxyWindow: WindowProxy
     microAppWindow: Window // Proxy target
-    start (baseRoute: string): void
-    stop (): void
+    start (
+      baseRoute: string,
+      useMemoryRouter: boolean,
+      defaultPage: string,
+    ): void
+    stop (keepRouteState: boolean): void
     // record umd snapshot before the first execution of umdHookMount
     recordUmdSnapshot (): void
     // rebuild umd snapshot before remount umd app
     rebuildUmdSnapshot (): void
+    setRouteInfoForKeepAliveApp (): void
+    removeRouteInfoForKeepAliveApp (): void
   }
 
   type sourceLinkInfo = {
@@ -50,10 +58,13 @@ declare module '@micro-app/types' {
     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 ''
+    keepRouteState: boolean // keep route state when unmount, default is false
     source: sourceType // sources of css, js, html
     sandBox: SandBoxInterface | null // sandbox
     umdMode: boolean // is umd mode
+    defaultPage: string // default page when mount
 
     // Load resources
     loadSourceCode (): void
@@ -69,6 +80,8 @@ declare module '@micro-app/types' {
       container?: HTMLElement | ShadowRoot,
       inline?: boolean,
       baseroute?: string,
+      keepRouteState?: boolean,
+      defaultPage?: string,
     ): void
 
     // unmount app
@@ -111,6 +124,7 @@ declare module '@micro-app/types' {
     url: string,
     disableScopecss?: boolean
     disableSandbox?: boolean
+    disableMemoryRouter?: boolean
     shadowDOM?: boolean
   }
 
@@ -136,7 +150,7 @@ declare module '@micro-app/types' {
       // options for plugin as the third parameter of loader
       options?: unknown
       // handle function
-      loader?: (code: string, url: string, options: unknown) => string
+      loader?: (code: string, url: string, options: unknown, info: sourceScriptInfo) => string
     }>
 
     // plugin for special app
@@ -149,7 +163,7 @@ declare module '@micro-app/types' {
         // options for plugin as the third parameter of loader
         options?: unknown
         // handle function
-        loader?: (code: string, url: string, options: unknown) => string
+        loader?: (code: string, url: string, options: unknown, info: sourceScriptInfo) => string
       }>
     }
   }
@@ -168,6 +182,7 @@ declare module '@micro-app/types' {
     inline?: boolean
     disableScopecss?: boolean
     disableSandbox?: boolean
+    disableMemoryRouter?: boolean
     ssr?: boolean
     lifeCycles?: lifeCyclesType
     preFetchApps?: prefetchParamList
@@ -184,16 +199,143 @@ declare module '@micro-app/types' {
     inline?: boolean
     disableScopecss?: boolean
     disableSandbox?: boolean
+    disableMemoryRouter?: boolean
     ssr?: boolean
     lifeCycles?: lifeCyclesType
     plugins?: plugins
     fetch?: fetchType
     preFetch(apps: prefetchParamList): void
+    router: Router // eslint-disable-line
     start(options?: OptionsType): void
   }
 
   // special CallableFunction for interact
   type CallableFunctionForInteract = CallableFunction & { __APP_NAME__?: string, __AUTO_TRIGGER__?: boolean }
+
+  interface ShadowLocation {
+    [k: string]: string
+  }
+
+  interface MicroLocation extends Location, URL {
+    // shadowLocation is the current location information (href, pathname, search, hash)
+    shadowLocation: ShadowLocation
+    fullPath: string
+    [key: string]: any
+  }
+
+  type MicroHistory = ProxyHandler<History>
+  type MicroState = any
+  type HistoryProxyValue =
+    Pick<
+    History,
+    'length' |
+    'scrollRestoration' |
+    'state' |
+    'back' |
+    'forward' |
+    'go' |
+    'pushState' |
+    'replaceState'
+    > | CallableFunction
+  interface MicroRouter {
+    microLocation: MicroLocation
+    microHistory: MicroHistory
+  }
+  type LocationQueryValue = string | null
+  type LocationQueryObject = Record<
+  string,
+  LocationQueryValue | LocationQueryValue[]
+  >
+
+  type LocationQuery = {
+    hashQuery?: LocationQueryObject,
+    searchQuery?: LocationQueryObject
+  }
+
+  type GuardLocation = Record<keyof MicroLocation, any>
+
+  type CurrentRoute = Map<string, GuardLocation>
+
+  interface RouterTarget {
+    name: string
+    path: string
+    state?: unknown
+    replace?: boolean
+  }
+
+  type navigationMethod = (to: RouterTarget) => void
+
+  interface AccurateGuard {
+    [appName: string]: (to: GuardLocation, from: GuardLocation) => void
+  }
+
+  type GlobalNormalGuard = ((appName: string, to: GuardLocation, from: GuardLocation) => void)
+
+  type RouterGuard = AccurateGuard | GlobalNormalGuard
+
+  // Router API for developer
+  interface Router {
+    // current route of all apps
+    readonly current: CurrentRoute
+    /**
+     * encodeURI of microApp path
+     * @param path url path
+     */
+    encode(path: string): string
+    /**
+     * decodeURI of microApp path
+     * @param path url path
+     */
+    decode(path: string): ReturnType<Router['encode']>
+    /**
+     * Navigate to a new URL by pushing an entry in the history
+     * stack.
+     * @param to - Route location to navigate to
+     */
+    push: navigationMethod
+    /**
+     * Navigate to a new URL by replacing the current entry in
+     * the history stack.
+     *
+     * @param to - Route location to navigate to
+     */
+    replace: navigationMethod
+    /**
+     * Move forward or backward through the history. calling `history.go()`.
+     *
+     * @param delta - The position in the history to which you want to move,
+     * relative to the current page
+     */
+    go: Func
+    /**
+     * Go back in history if possible by calling `history.back()`.
+     */
+    back: Func
+    /**
+     * Go forward in history if possible by calling `history.forward()`.
+     */
+    forward: Func
+    /**
+     * Add a navigation guard that executes before any navigation
+     * @param guard global hook for
+     */
+    beforeEach(guard: RouterGuard): () => boolean
+    /**
+     * Add a navigation guard that executes after any navigation
+     * @param guard global hook for
+     */
+    afterEach(guard: RouterGuard): () => boolean
+
+    setDefaultPage(appName: string, path: string): () => boolean
+    removeDefaultPage(appName: string): boolean
+    getDefaultPage(key: PropertyKey): string | undefined
+  }
+
+  // result of add/remove microApp path on browser url
+  type HandleMicroPathResult = {
+    fullPath: string,
+    isAttach2Hash: boolean,
+  }
 }
 
 declare namespace JSX {