@micro-zoe/micro-app 1.0.0-alpha.6 → 1.0.0-alpha.9

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, 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,17 +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 {
+    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;
+            [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;
-            preFetch: typeof preFetch;
             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' {
@@ -51,18 +84,23 @@ declare module '@micro-zoe/micro-app/prefetch' {
         *  {
         *    name: string,
         *    url: string,
-        *    disableScopecss?: boolean,
-        *    disableSandbox?: boolean,
-        *    disableMemoryRouter?: boolean,
+        *    esmodule: boolean,
+        *    inline: boolean,
+        *    'disable-scopecss': boolean,
+        *    'disable-sandbox': boolean,
+        *    level: number,
+        *    'default-page': string,
+        *    'disable-patch-request': boolean,
         *  },
         *  ...
         * ])
         * Note:
-        *  1: preFetch is asynchronous and is performed only when the browser is idle
-        *  2: disableScopecss, disableSandbox, disableMemoryRouter must be same with micro-app element, if conflict, the one who executes first shall prevail
-        * @param apps micro apps
+        *  1: preFetch is async and is performed only when the browser is idle
+        *  2: options of prefetch preferably match the config of the micro-app element, although this is not required
+        * @param apps micro app options
+        * @param delay delay time
         */
-    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
@@ -91,14 +129,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
@@ -252,6 +293,13 @@ declare module '@micro-zoe/micro-app/libs/utils' {
         * @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' {
@@ -272,11 +320,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
@@ -309,7 +362,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
@@ -337,12 +397,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
                 */