@micro-zoe/micro-app 1.0.0-alpha.5 → 1.0.0-alpha.8

package/README.md

@@ -35,10 +35,6 @@ It is the lowest cost framework for accessing micro front-end, and provides a se
 micro-app has no restrictions on the front-end framework, and any framework can be used as a base application to embed any type of micro application of the framework.
 
 # How to use
-The micro front end is divided into a base application (also called main application) and a micro application.
-
-Here is a common example: the base application uses the Vue framework, uses history routing, the micro application uses the react framework, and uses hash routing. We list the modifications that need to be made by the base application and the micro application, and introduce the use of micro-app in detail.
-
 ## base application
 **1、Install**
 ```bash

package/README.zh-cn.md

@@ -28,7 +28,7 @@
 [English](https://github.com/micro-zoe/micro-app)｜简体中文｜[官网文档](https://micro-zoe.github.io/micro-app/)｜[讨论组](https://github.com/micro-zoe/micro-app/discussions)｜[聊天室](https://gitter.im/microzoe/micro-app)
 
 # 📖简介
-micro-app是京东零售推出的一款微前端框架，它基于类WebComponent进行渲染，从组件化的思维实现微前端，旨在降低上手难度、提升工作效率。它是目前接入微前端成本最低的框架，并且提供了JS沙箱、样式隔离、元素隔离、预加载、资源地址补全、插件系统、数据通信等一系列完善的功能。
+micro-app是京东零售推出的一款微前端框架，它基于类WebComponent进行渲染，从组件化的思维实现微前端，旨在降低上手难度、提升工作效率。它是目前接入微前端成本最低的框架，并且提供了JS沙箱、样式隔离、元素隔离、预加载、虚拟路由系统、插件系统、数据通信等一系列完善的功能。
 
 micro-app与技术栈无关，对前端框架没有限制，任何框架都可以作为基座应用嵌入任何类型的子应用。
 

package/lib/index.d.ts

@@ -4,26 +4,28 @@
 //   ../../@micro-app/types
 
 declare module '@micro-zoe/micro-app' {
-    export { default, MicroApp, getActiveApps, getAllApps, unmountApp, unmountAllApps, } from '@micro-zoe/micro-app/micro_app';
+    export { default, MicroApp, getActiveApps, getAllApps, unmountApp, unmountAllApps, reload, renderApp, } from '@micro-zoe/micro-app/micro_app';
     export { default as preFetch, } from '@micro-zoe/micro-app/prefetch';
     export { removeDomScope, pureCreateElement, version, } from '@micro-zoe/micro-app/libs/utils';
     export { EventCenterForMicroApp, } from '@micro-zoe/micro-app/interact';
 }
 
 declare module '@micro-zoe/micro-app/micro_app' {
-    import type { OptionsType, MicroAppConfigType, lifeCyclesType, plugins, fetchType, Router, appName } from '@micro-app/types';
+    import type { OptionsType, MicroAppBaseType, Router, AppName, Func, lifeCyclesType, MicroAppConfig, GetActiveAppsParam } from '@micro-app/types';
     import preFetch from '@micro-zoe/micro-app/prefetch';
     import { EventCenterForBaseApp } from '@micro-zoe/micro-app/interact';
     /**
         * if app not prefetch & not unmount, then app is active
         * @param excludeHiddenApp exclude hidden keep-alive app, default is false
+        * @param excludePreRender exclude pre render app
         * @returns active apps
         */
-    export function getActiveApps(excludeHiddenApp?: boolean): appName[];
+    export function getActiveApps({ excludeHiddenApp, excludePreRender, }?: GetActiveAppsParam): AppName[];
     export function getAllApps(): string[];
     type unmountAppOptions = {
             destroy?: boolean;
             clearAliveState?: boolean;
+            clearData?: boolean;
     };
     /**
         * unmount app by appName
@@ -31,30 +33,48 @@ declare module '@micro-zoe/micro-app/micro_app' {
         * @param options unmountAppOptions
         * @returns Promise<void>
         */
-    export function unmountApp(appName: string, options?: unmountAppOptions): Promise<void>;
-    export function unmountAllApps(options?: unmountAppOptions): Promise<void>;
-    export class MicroApp extends EventCenterForBaseApp implements MicroAppConfigType {
-            tagName: string;
-            shadowDOM?: boolean;
-            destroy?: boolean;
-            inline?: boolean;
-            '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;
+    export function unmountApp(appName: string, options?: unmountAppOptions): Promise<boolean>;
+    export function unmountAllApps(options?: unmountAppOptions): Promise<boolean>;
+    /**
+        * Re render app from the command line
+        * microApp.reload(destroy)
+        * @param appName app.name
+        * @param destroy unmount app with destroy mode
+        * @returns Promise<boolean>
+        */
+    export function reload(appName: string, destroy?: boolean): Promise<boolean>;
+    interface RenderAppOptions extends MicroAppConfig {
+            name: string;
+            url: string;
+            container: string | Element;
+            baseroute?: string;
+            'default-page'?: string;
+            data?: Record<PropertyKey, unknown>;
+            onDataChange?: Func;
             lifeCycles?: lifeCyclesType;
-            plugins?: plugins;
-            fetch?: fetchType;
-            preFetch: typeof preFetch;
+            [key: string]: unknown;
+    }
+    /**
+        * Manually render app
+        * @param options RenderAppOptions
+        * @returns Promise<boolean>
+        */
+    export function renderApp(options: RenderAppOptions): Promise<boolean>;
+    export class MicroApp extends EventCenterForBaseApp implements MicroAppBaseType {
+            tagName: string;
+            options: OptionsType;
             router: Router;
+            preFetch: typeof preFetch;
+            unmountApp: typeof unmountApp;
+            unmountAllApps: typeof unmountAllApps;
+            getActiveApps: typeof getActiveApps;
+            getAllApps: typeof getAllApps;
+            reload: typeof reload;
+            renderApp: typeof renderApp;
             start(options?: OptionsType): void;
     }
-    const _default: MicroApp;
-    export default _default;
+    const microApp: MicroApp;
+    export default microApp;
 }
 
 declare module '@micro-zoe/micro-app/prefetch' {
@@ -75,7 +95,7 @@ declare module '@micro-zoe/micro-app/prefetch' {
         *  2: disableScopecss, disableSandbox, disableMemoryRouter must be same with micro-app element, if conflict, the one who executes first shall prevail
         * @param apps micro apps
         */
-    export default function preFetch(apps: prefetchParamList): void;
+    export default function preFetch(apps: prefetchParamList, delay?: number): void;
     /**
         * load global assets into cache
         * @param assets global assets of js, css
@@ -84,7 +104,7 @@ declare module '@micro-zoe/micro-app/prefetch' {
 }
 
 declare module '@micro-zoe/micro-app/libs/utils' {
-    import type { Func, LocationQueryObject, MicroLocation } from '@micro-app/types';
+    import type { Func, LocationQueryObject, MicroLocation, AttrsType, fiberTasks } from '@micro-app/types';
     export const version = "__MICRO_APP_VERSION__";
     export const isBrowser: boolean;
     export const globalThis: any;
@@ -104,14 +124,17 @@ declare module '@micro-zoe/micro-app/libs/utils' {
     export function isNull(target: unknown): target is null;
     export function isString(target: unknown): target is string;
     export function isBoolean(target: unknown): target is boolean;
+    export function isNumber(target: unknown): target is Number;
     export function isFunction(target: unknown): target is Function;
-    export function isPlainObject(target: unknown): target is Record<PropertyKey, unknown>;
+    export function isPlainObject<T = Record<PropertyKey, unknown>>(target: unknown): target is T;
     export function isObject(target: unknown): target is Object;
     export function isPromise(target: unknown): target is Promise<unknown>;
     export function isBoundFunction(target: unknown): boolean;
     export function isConstructor(target: unknown): boolean;
     export function isShadowRoot(target: unknown): target is ShadowRoot;
     export function isURL(target: unknown): target is URL;
+    export function isElement(target: unknown): target is Element;
+    export function isNode(target: unknown): target is Node;
     export function isProxyDocument(target: unknown): target is Document;
     /**
         * format error log
@@ -187,6 +210,11 @@ declare module '@micro-zoe/micro-app/libs/utils' {
     export function createNonceSrc(): string;
     export function unique(array: any[]): any[];
     export const requestIdleCallback: any;
+    /**
+        * Wrap requestIdleCallback with promise
+        * Exec callback when browser idle
+        */
+    export function promiseRequestIdle(callback: CallableFunction): Promise<void>;
     export function setCurrentAppName(appName: string | null): void;
     export function throttleDeferForSetAppName(appName: string): void;
     export function getCurrentAppName(): string | null;
@@ -242,6 +270,31 @@ declare module '@micro-zoe/micro-app/libs/utils' {
             get: (key: PropertyKey) => T | undefined;
             delete: (key: PropertyKey) => boolean;
     };
+    export function getAttributes(element: Element): AttrsType;
+    /**
+        * if fiberTasks exist, wrap callback with promiseRequestIdle
+        * if not, execute callback
+        * @param fiberTasks fiber task list
+        * @param callback action callback
+        */
+    export function injectFiberTask(fiberTasks: fiberTasks, callback: CallableFunction): void;
+    /**
+        * serial exec fiber task of link, style, script
+        * @param tasks task array or null
+        */
+    export function serialExecFiberTasks(tasks: fiberTasks): Promise<void> | null;
+    /**
+        * inline script start with inline-xxx
+        * @param address source address
+        */
+    export function isInlineScript(address: string): boolean;
+    /**
+        * call function with try catch
+        * @param fn target function
+        * @param appName app.name
+        * @param args arguments
+        */
+    export function callFnWithTryCatch(fn: Func | null, appName: string, msgSuffix: string, ...args: unknown[]): void;
 }
 
 declare module '@micro-zoe/micro-app/interact' {
@@ -262,11 +315,16 @@ declare module '@micro-zoe/micro-app/interact' {
                 * dispatch global data
                 * @param data data
                 */
-            setGlobalData(data: Record<PropertyKey, unknown>): void;
+            setGlobalData(data: Record<PropertyKey, unknown>, nextStep?: CallableFunction, force?: boolean): void;
+            forceSetGlobalData(data: Record<PropertyKey, unknown>, nextStep?: CallableFunction): void;
             /**
                 * get global data
                 */
             getGlobalData(): Record<PropertyKey, unknown> | null;
+            /**
+                * clear global data
+                */
+            clearGlobalData(): void;
             /**
                 * clear all listener of global data
                 * if appName exists, only the specified functions is cleared
@@ -299,7 +357,14 @@ declare module '@micro-zoe/micro-app/interact' {
                 * @param appName app.name
                 * @param data data
                 */
-            setData(appName: string, data: Record<PropertyKey, unknown>): void;
+            setData(appName: string, data: Record<PropertyKey, unknown>, nextStep?: CallableFunction, force?: boolean): void;
+            forceSetData(appName: string, data: Record<PropertyKey, unknown>, nextStep?: CallableFunction): void;
+            /**
+                * clear data from base app
+                * @param appName app.name
+                * @param fromBaseApp whether clear data from child app, default is true
+                */
+            clearData(appName: string, fromBaseApp?: boolean): void;
             /**
                 * clear all listener for specified micro app
                 * @param appName app.name
@@ -327,12 +392,18 @@ declare module '@micro-zoe/micro-app/interact' {
             /**
                 * get data from base app
                 */
-            getData(): Record<PropertyKey, unknown> | null;
+            getData(fromBaseApp?: boolean): Record<PropertyKey, unknown> | null;
             /**
                 * dispatch data to base app
                 * @param data data
                 */
-            dispatch(data: Record<PropertyKey, unknown>): void;
+            dispatch(data: Record<PropertyKey, unknown>, nextStep?: CallableFunction, force?: boolean): void;
+            forceDispatch(data: Record<PropertyKey, unknown>, nextStep?: CallableFunction): void;
+            /**
+                * clear data from child app
+                * @param fromBaseApp whether clear data from base app, default is false
+                */
+            clearData(fromBaseApp?: boolean): void;
             /**
                 * clear all listeners
                 */