@micro-zoe/micro-app 0.6.0 → 0.7.1

package/README.zh-cn.md

@@ -25,7 +25,7 @@
   </a>
 </p>
 
-[English](https://github.com/micro-zoe/micro-app)｜简体中文｜[官网文档](https://micro-zoe.github.io/micro-app/)｜[讨论组](https://github.com/micro-zoe/micro-app/discussions)｜[Gitter群聊](https://gitter.im/microzoe/micro-app)
+[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沙箱、样式隔离、元素隔离、预加载、资源地址补全、插件系统、数据通信等一系列完善的功能。
@@ -44,7 +44,7 @@ micro-app与技术栈无关，对前端框架没有限制，任何框架都可
 yarn add @micro-zoe/micro-app
 ```
 
-**2、在入口处引入**
+**2、在入口文件引入**
 ```js
 // main.js
 import microApp from '@micro-zoe/micro-app'

package/lib/index.d.ts

@@ -4,31 +4,48 @@
 //   ../../@micro-app/types
 
 declare module '@micro-zoe/micro-app' {
-    export { default } from '@micro-zoe/micro-app/micro_app';
+    export { default, MicroApp, getActiveApps, getAllApps, unmountApp, unmountAllApps, } 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';
-    export { getActiveApps, getAllApps, } from '@micro-zoe/micro-app/create_app';
 }
 
 declare module '@micro-zoe/micro-app/micro_app' {
     import type { OptionsType, MicroAppConfigType, lifeCyclesType, plugins, fetchType } from '@micro-app/types';
     import preFetch from '@micro-zoe/micro-app/prefetch';
     import { EventCenterForBaseApp } from '@micro-zoe/micro-app/interact';
-    class MicroApp extends EventCenterForBaseApp implements MicroAppConfigType {
-        tagName: string;
-        shadowDOM?: boolean;
-        destroy?: boolean;
-        inline?: boolean;
-        disableScopecss?: boolean;
-        disableSandbox?: boolean;
-        macro?: boolean;
-        ssr?: boolean;
-        lifeCycles?: lifeCyclesType;
-        plugins?: plugins;
-        fetch?: fetchType;
-        preFetch: typeof preFetch;
-        start(options?: OptionsType): void;
+    /**
+        * if app not prefetch & not unmount, then app is active
+        * @param excludeHiddenApp exclude hidden keep-alive app
+        * @returns active apps
+        */
+    export function getActiveApps(excludeHiddenApp?: boolean): string[];
+    export function getAllApps(): string[];
+    export interface unmountAppParams {
+            destroy?: boolean;
+            clearAliveState?: boolean;
+    }
+    /**
+        * unmount app by appname
+        * @param appName
+        * @param options unmountAppParams
+        * @returns Promise<void>
+        */
+    export function unmountApp(appName: string, options?: unmountAppParams): Promise<void>;
+    export function unmountAllApps(options?: unmountAppParams): Promise<void>;
+    export class MicroApp extends EventCenterForBaseApp implements MicroAppConfigType {
+            tagName: string;
+            shadowDOM?: boolean;
+            destroy?: boolean;
+            inline?: boolean;
+            disableScopecss?: boolean;
+            disableSandbox?: boolean;
+            ssr?: boolean;
+            lifeCycles?: lifeCyclesType;
+            plugins?: plugins;
+            fetch?: fetchType;
+            preFetch: typeof preFetch;
+            start(options?: OptionsType): void;
     }
     const _default: MicroApp;
     export default _default;
@@ -43,13 +60,12 @@ declare module '@micro-zoe/micro-app/prefetch' {
         *    url: string,
         *    disableScopecss?: boolean,
         *    disableSandbox?: boolean,
-        *    macro?: boolean,
         *  },
         *  ...
         * ])
         * Note:
         *  1: preFetch is asynchronous and is performed only when the browser is idle
-        *  2: disableScopecss, disableSandbox, macro must be same with micro-app element, if conflict, the one who executes first shall prevail
+        *  2: disableScopecss, disableSandbox 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;
@@ -62,7 +78,7 @@ declare module '@micro-zoe/micro-app/prefetch' {
 
 declare module '@micro-zoe/micro-app/libs/utils' {
     import type { Func } from '@micro-app/types';
-    export const version = "__VERSION__";
+    export const version = "__MICRO_APP_VERSION__";
     export const isBrowser: boolean;
     export const globalThis: any;
     export function isUndefined(target: unknown): target is undefined;
@@ -75,6 +91,9 @@ declare module '@micro-zoe/micro-app/libs/utils' {
     export function isPromise(target: unknown): boolean;
     export function isBoundFunction(target: any): boolean;
     export function isShadowRoot(target: unknown): boolean;
+    export const rawDefineProperty: (o: any, p: string | number | symbol, attributes: PropertyDescriptor & ThisType<any>) => any;
+    export const rawDefineProperties: (o: any, properties: PropertyDescriptorMap & ThisType<any>) => any;
+    export const rawHasOwnProperty: (v: string | number | symbol) => boolean;
     /**
         * format error log
         * @param msg message
@@ -145,6 +164,7 @@ declare module '@micro-zoe/micro-app/libs/utils' {
     export function unique(array: any[]): any[];
     export const requestIdleCallback: any;
     export function setCurrentAppName(appName: string | null): void;
+    export function throttleDeferForSetAppName(appName: string): void;
     export function getCurrentAppName(): string | null;
     export function removeDomScope(): void;
     export function isSafari(): boolean;
@@ -275,70 +295,3 @@ declare module '@micro-zoe/micro-app/interact' {
     export {};
 }
 
-declare module '@micro-zoe/micro-app/create_app' {
-    import type { AppInterface, sourceType, SandBoxInterface } from '@micro-app/types';
-    export const appInstanceMap: Map<string, AppInterface>;
-    export interface CreateAppParam {
-            name: string;
-            url: string;
-            ssrUrl?: string;
-            scopecss: boolean;
-            useSandbox: boolean;
-            macro?: boolean;
-            inline?: boolean;
-            baseroute?: string;
-            container?: HTMLElement | ShadowRoot;
-    }
-    export default class CreateApp implements AppInterface {
-            umdMode: boolean;
-            isPrefetch: boolean;
-            name: string;
-            url: string;
-            ssrUrl: string;
-            container: HTMLElement | ShadowRoot | null;
-            inline: boolean;
-            scopecss: boolean;
-            useSandbox: boolean;
-            macro: boolean;
-            baseroute: string;
-            source: sourceType;
-            sandBox: SandBoxInterface | null;
-            constructor({ name, url, ssrUrl, container, inline, scopecss, useSandbox, macro, baseroute, }: CreateAppParam);
-            loadSourceCode(): void;
-            /**
-                * When resource is loaded, mount app if it is not prefetch or unmount
-                */
-            onLoad(html: HTMLElement): void;
-            /**
-                * Error loading HTML
-                * @param e Error
-                */
-            onLoadError(e: Error): void;
-            /**
-                * mount app
-                * @param container app container
-                * @param inline js runs in inline mode
-                * @param baseroute route prefix, default is ''
-                */
-            mount(container?: HTMLElement | ShadowRoot, inline?: boolean, baseroute?: string): void;
-            /**
-                * unmount app
-                * @param destroy completely destroy, delete cache resources
-                * @param unmountcb callback of unmount
-                */
-            unmount(destroy: boolean, unmountcb?: CallableFunction): void;
-            actionsForCompletelyDestory(): void;
-            hiddenKeepAliveApp(): void;
-            showKeepAliveApp(container: HTMLElement | ShadowRoot): void;
-            /**
-                * app rendering error
-                * @param e Error
-                */
-            onerror(e: Error): void;
-            getAppState(): string;
-            getKeepAliveState(): string | null;
-    }
-    export function getActiveApps(): string[];
-    export function getAllApps(): string[];
-}
-