@micro-zoe/micro-app 0.8.7 → 1.0.0-alpha.2

package/README.md

@@ -152,9 +152,9 @@ For more commands, see [DEVELOP](https://github.com/micro-zoe/micro-app/blob/mas
 </details>
 
 # Contributors
-<a href="https://github.com/micro-zoe/micro-app/graphs/contributors"><img src="https://micro-zoe.com/contributors.svg?height=55&people=13" /></a>
-<!-- opencollective is inaccurate  -->
-<!-- <a href="https://github.com/micro-zoe/micro-app/graphs/contributors"><img src="https://opencollective.com/micro-app/contributors.svg?width=890&button=false" /></a> -->
+<a href="https://github.com/micro-zoe/micro-app/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=micro-zoe/micro-app" />
+</a>
 
 # License
 [MIT License](https://github.com/micro-zoe/micro-app/blob/master/LICENSE)

package/README.zh-cn.md

@@ -33,11 +33,7 @@ micro-app是京东零售推出的一款微前端框架，它基于类WebComponen
 micro-app与技术栈无关，对前端框架没有限制，任何框架都可以作为基座应用嵌入任何类型的子应用。
 
 # 如何使用
-微前端分为基座应用（也可以叫做主应用）和子应用。
-
-这里以一种比较常见的情况举例：基座应用使用vue框架，采用history路由，子应用使用react框架，采用hash路由，我们分别列出基座应用和子应用需要进行的修改，具体介绍micro-app的使用方式。
-
-## 基座应用
+## 主应用
 
 **1、安装依赖**
 ```bash
@@ -54,11 +50,8 @@ microApp.start()
 
 **3、在页面中嵌入微前端应用**
 ```html
-<!-- my-page.vue -->
-<template>
-  <!-- 👇 name为应用名称，url为应用地址 -->
-  <micro-app name='my-app' url='http://localhost:3000/'></micro-app>
-</template>
+<!-- 👇 name为应用名称，url为应用地址 -->
+<micro-app name='my-app' url='http://localhost:3000/'></micro-app>
 ```
 
 ## 子应用
@@ -72,14 +65,14 @@ devServer: {
 },
 ```
 
-以上微前端基本渲染完成，效果如下：
+以上即完成微前端的嵌入，效果如下：
 
 <img src="https://img12.360buyimg.com/imagetools/jfs/t1/196940/34/1541/38365/610a14fcE46c21374/c321b9f8fa50a8fc.png" alt="result" width='900'/>
 
 更多详细配置可以查看[官网文档](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/start)
 
 # 🤝 参与共建
-如果您对这个项目感兴趣，欢迎提 pull request，也欢迎 "Star" 支持一下 ^_^
+如果您对这个项目感兴趣，欢迎参与贡献，也欢迎 "Star" 支持一下 ^_^
 
 ### 本地运行
 1、克隆项目
@@ -153,9 +146,10 @@ yarn start # 访问 http://localhost:3000
 </details>
 
 # 贡献者们
-<a href="https://github.com/micro-zoe/micro-app/graphs/contributors"><img src="https://micro-zoe.com/contributors.svg?height=55&people=13" /></a>
-<!-- opencollective is inaccurate  -->
-<!-- <a href="https://github.com/micro-zoe/micro-app/graphs/contributors"><img src="https://opencollective.com/micro-app/contributors.svg?width=890&button=false" /></a> -->
+<a href="https://github.com/micro-zoe/micro-app/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=micro-zoe/micro-app" />
+</a>
+
 
 # License
 [MIT License](https://github.com/micro-zoe/micro-app/blob/master/LICENSE)

package/lib/index.d.ts

@@ -11,7 +11,7 @@ declare module '@micro-zoe/micro-app' {
 }
 
 declare module '@micro-zoe/micro-app/micro_app' {
-    import type { OptionsType, MicroAppConfigType, lifeCyclesType, plugins, fetchType } from '@micro-app/types';
+    import type { OptionsType, MicroAppConfigType, lifeCyclesType, plugins, fetchType, Router, appName } from '@micro-app/types';
     import preFetch from '@micro-zoe/micro-app/prefetch';
     import { EventCenterForBaseApp } from '@micro-zoe/micro-app/interact';
     /**
@@ -19,20 +19,20 @@ declare module '@micro-zoe/micro-app/micro_app' {
         * @param excludeHiddenApp exclude hidden keep-alive app, default is false
         * @returns active apps
         */
-    export function getActiveApps(excludeHiddenApp?: boolean): string[];
+    export function getActiveApps(excludeHiddenApp?: boolean): appName[];
     export function getAllApps(): string[];
-    export interface unmountAppParams {
+    type unmountAppOptions = {
             destroy?: boolean;
             clearAliveState?: boolean;
-    }
+    };
     /**
         * unmount app by appName
         * @param appName
-        * @param options unmountAppParams
+        * @param options unmountAppOptions
         * @returns Promise<void>
         */
-    export function unmountApp(appName: string, options?: unmountAppParams): Promise<void>;
-    export function unmountAllApps(options?: unmountAppParams): 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;
@@ -40,11 +40,13 @@ declare module '@micro-zoe/micro-app/micro_app' {
             inline?: boolean;
             disableScopecss?: boolean;
             disableSandbox?: boolean;
+            disableMemoryRouter?: boolean;
             ssr?: boolean;
             lifeCycles?: lifeCyclesType;
             plugins?: plugins;
             fetch?: fetchType;
             preFetch: typeof preFetch;
+            router: Router;
             start(options?: OptionsType): void;
     }
     const _default: MicroApp;
@@ -60,12 +62,13 @@ declare module '@micro-zoe/micro-app/prefetch' {
         *    url: string,
         *    disableScopecss?: boolean,
         *    disableSandbox?: boolean,
+        *    disableMemoryRouter?: boolean,
         *  },
         *  ...
         * ])
         * Note:
         *  1: preFetch is asynchronous and is performed only when the browser is idle
-        *  2: disableScopecss, disableSandbox must be same with micro-app element, if conflict, the one who executes first shall prevail
+        *  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;
@@ -77,41 +80,56 @@ declare module '@micro-zoe/micro-app/prefetch' {
 }
 
 declare module '@micro-zoe/micro-app/libs/utils' {
-    import type { Func } from '@micro-app/types';
+    import type { Func, LocationQueryObject, MicroLocation } from '@micro-app/types';
     export const version = "__MICRO_APP_VERSION__";
     export const isBrowser: boolean;
     export const globalThis: any;
-    export function isUndefined(target: unknown): target is undefined;
-    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 isFunction(target: unknown): boolean;
+    export const noop: () => void;
+    export const noopFalse: () => boolean;
     export const isArray: (arg: any) => arg is any[];
-    export function isPlainObject(target: unknown): boolean;
-    export function isPromise(target: unknown): boolean;
-    export function isBoundFunction(target: any): boolean;
-    export function isShadowRoot(target: unknown): boolean;
+    export const assign: {
+            <T, U>(target: T, source: U): T & U;
+            <T_1, U_1, V>(target: T_1, source1: U_1, source2: V): T_1 & U_1 & V;
+            <T_2, U_2, V_1, W>(target: T_2, source1: U_2, source2: V_1, source3: W): T_2 & U_2 & V_1 & W;
+            (target: object, ...sources: any[]): any;
+    };
     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;
+    export function isUndefined(target: unknown): target is undefined;
+    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 isFunction(target: unknown): target is Function;
+    export function isPlainObject(target: unknown): target is Record<PropertyKey, unknown>;
+    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;
     /**
         * format error log
         * @param msg message
         * @param appName app name, default is null
         */
-    export function logError(msg: unknown, appName?: string | null, ...rest: any[]): void;
+    export function logError(msg: unknown, appName?: string | null, ...rest: unknown[]): void;
     /**
         * format warn log
         * @param msg message
         * @param appName app name, default is null
         */
-    export function logWarn(msg: unknown, appName?: string | null, ...rest: any[]): void;
+    export function logWarn(msg: unknown, appName?: string | null, ...rest: unknown[]): void;
     /**
         * async execution
         * @param fn callback
         * @param args params
         */
-    export function defer(fn: Func, ...args: any[]): void;
+    export function defer(fn: Func, ...args: unknown[]): void;
+    /**
+        * create URL as MicroLocation
+        */
+    export const createURL: (path: string | URL, base?: string | undefined) => MicroLocation;
     /**
         * Add address protocol
         * @param url address
@@ -132,6 +150,7 @@ declare module '@micro-zoe/micro-app/libs/utils' {
         * 3. event_center -> EventCenterForBaseApp -> all methods
         * 4. preFetch
         * 5. plugins
+        * 6. router api (push, replace)
         */
     export function formatAppName(name: string | null): string;
     /**
@@ -191,6 +210,33 @@ declare module '@micro-zoe/micro-app/libs/utils' {
         */
     export function trim(str: string): string;
     export function isFireFox(): boolean;
+    /**
+        * Transforms a queryString into object.
+        * @param search - search string to parse
+        * @returns a query object
+        */
+    export function parseQuery(search: string): LocationQueryObject;
+    /**
+        * Transforms an object to query string
+        * @param queryObject - query object to stringify
+        * @returns query string without the leading `?`
+        */
+    export function stringifyQuery(queryObject: LocationQueryObject): string;
+    /**
+        * Register or unregister callback/guard with Set
+        */
+    export function useSetRecord<T>(): {
+            add: (handler: T) => () => boolean;
+            list: () => Set<T>;
+    };
+    /**
+        * record data with Map
+        */
+    export function useMapRecord<T>(): {
+            add: (key: PropertyKey, value: T) => () => boolean;
+            get: (key: PropertyKey) => T | undefined;
+            delete: (key: PropertyKey) => boolean;
+    };
 }
 
 declare module '@micro-zoe/micro-app/interact' {