@micro-zoe/micro-app 0.3.0 → 0.4.0

package/README.md

@@ -1,6 +1,6 @@
 <p align="center">
-  <a href="https://zeroing.jd.com/micro-app/">
-    <img src="https://cangdu.org/micro-app/_media/logo.png" alt="logo" width="200"/>
+  <a href="https://micro-zoe.github.io/micro-app/">
+    <img src="https://zeroing.jd.com/micro-app/media/logo.png" alt="logo" width="200"/>
   </a>
 </p>
 
@@ -25,7 +25,7 @@
   </a>
 </p>
 
-English｜[简体中文](https://github.com/micro-zoe/micro-app/blob/master/README.zh-cn.md)｜[Documentation](https://zeroing.jd.com/micro-app/)｜[Discussions](https://github.com/micro-zoe/micro-app/discussions)｜[Gitter](https://gitter.im/microzoe/micro-app)
+English｜[简体中文](./README.zh-cn.md)｜[Documentation](https://micro-zoe.github.io/micro-app/)｜[Discussions](https://github.com/micro-zoe/micro-app/discussions)｜[Gitter](https://gitter.im/microzoe/micro-app)
 
 # 📖Introduction
 micro-app is a micro front-end framework launched by JD Retail. It renders based on webcomponent-like and realizes the micro front-end from component thinking, it aiming to reduce the difficulty of getting started and improve work efficiency. 
@@ -80,18 +80,18 @@ export default routes
 <template>
   <div>
     <h1>micro application</h1>
-    <!-- name is the application name, globally unique, url is the html address -->
-    <micro-app name='app1' url='http://localhost:3000/' baseurl='/my-page'></micro-app>
+    <!-- 👇 name is the application name, globally unique, url is the html address -->
+    <micro-app name='app1' url='http://localhost:3000/' baseroute='/my-page'></micro-app>
   </div>
 </template>
 ```
 
-> Please refer to [Routing Chapter](https://zeroing.jd.com/micro-app/docs.html#/zh-cn/route) for the relationship between url and micro application routing
+> Please refer to [Routing Chapter](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/route) for the relationship between url and micro application routing
 
 ## micro application
 > The micro application takes the react framework as an example
 
-1、Add basename for route(If the base application is history route and the micro application is hash route, it is not necessary to set the baseurl, this step can be skipped)
+1、Add basename for route(If the base application is history route and the micro application is hash route, it is not necessary to set the baseroute, this step can be skipped)
 
 ```js
 // router.js
@@ -99,8 +99,8 @@ import { BrowserRouter, Switch, Route } from 'react-router-dom'
 
 export default function AppRoute () {
   return (
-    // 👇 the micro application can get the baseurl issued by the base application through window.__MICRO_APP_BASE_URL__
-    <BrowserRouter basename={window.__MICRO_APP_BASE_URL__ || '/'}>
+    // 👇 the micro application can get the baseroute issued by the base application through window.__MICRO_APP_BASE_ROUTE__
+    <BrowserRouter basename={window.__MICRO_APP_BASE_ROUTE__ || '/'}>
       <Switch>
         ...
       </Switch>
@@ -124,13 +124,11 @@ Then micro front-end can be rendered normally, and the react micro application i
 
 The above lists the usage of react and Vue framework. They can be combined freely. For example, the base application is react, the micro application is Vue, or the base application is Vue, the micro application is react, or both the base application and the micro application are react and Vue. The 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.
 
-More detailed configuration can be viewed [Documentation](https://zeroing.jd.com/micro-app/docs.html#/zh-cn/start).
+More detailed configuration can be viewed [Documentation](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/start).
 
 # 🤝 Contribution
 If you're interested in this project, you're welcome to mention pull request, and also welcome your "Star" ^_^
 
-If you are using it, please [tell us](https://github.com/micro-zoe/micro-app/issues/35)
-
 ### development
 1、Clone
 ```
@@ -192,12 +190,13 @@ For more commands, see [DEVELP](https://github.com/micro-zoe/micro-app/blob/mast
 <details>
   <summary>Does it support vite?</summary>
   
-  Yes, please see [adapt vite](https://zeroing.jd.com/micro-app/docs.html#/zh-cn/advanced?id=_2%e3%80%81%e9%80%82%e9%85%8dvite) for details.
+  Yes, please see [adapt vite](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/advanced?id=_2%e3%80%81%e9%80%82%e9%85%8dvite) for details.
 </details>
 
 # Contributors
+<a href="https://github.com/micro-zoe/micro-app/graphs/contributors"><img src="./.github/contributors.svg" /></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://opencollective.com/micro-app/contributors.svg?width=890&button=false" /></a> -->
 
 # License
 [MIT License](https://github.com/micro-zoe/micro-app/blob/master/LICENSE)

package/README.zh-cn.md

@@ -1,6 +1,6 @@
 <p align="center">
-  <a href="https://zeroing.jd.com/micro-app/">
-    <img src="https://cangdu.org/micro-app/_media/logo.png" alt="logo" width="180"/>
+  <a href="https://micro-zoe.github.io/micro-app/">
+    <img src="https://zeroing.jd.com/micro-app/media/logo.png" alt="logo" width="200"/>
   </a>
 </p>
 
@@ -25,18 +25,13 @@
   </a>
 </p>
 
-[English](https://github.com/micro-zoe/micro-app)｜简体中文｜[官网文档](https://zeroing.jd.com/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)｜[Gitter群聊](https://gitter.im/microzoe/micro-app)
 
 # 📖简介
 micro-app是京东零售推出的一款微前端框架，它基于类WebComponent进行渲染，从组件化的思维实现微前端，旨在降低上手难度、提升工作效率。它是目前接入微前端成本最低的框架，并且提供了JS沙箱、样式隔离、元素隔离、预加载、资源地址补全、插件系统、数据通信等一系列完善的功能。
 
 micro-app与技术栈无关，也不和业务绑定，可以用于任何前端框架。
 
-#### 概念图
-<p>
-  <img src="https://img10.360buyimg.com/imagetools/jfs/t1/168885/23/20790/54203/6084d445E0c9ec00e/d879637b4bb34253.png" alt="概念图" width='850'/>
-</p>
-
 # 🔧开始使用
 微前端分为基座应用和子应用，我们分别列出基座应用和子应用需要进行的修改，具体介绍micro-app的使用方式。
 
@@ -67,7 +62,7 @@ Vue.use(VueRouter)
 
 const routes = [
   {
-    // 👇 非严格匹配，/my-page/xxx 都将匹配到 MyPage 组件
+    // 👇 非严格匹配，/my-page/xxx 都将匹配到 MyPage 页面
     path: '/my-page/*', 
     name: 'my-page',
     component: MyPage,
@@ -77,24 +72,24 @@ const routes = [
 export default routes
 ```
 
-4、在`my-page`页面中使用组件
+4、在`MyPage`页面中嵌入微前端应用
 ```html
 <!-- my-page.vue -->
 <template>
   <div>
     <h1>子应用</h1>
-    <!-- name为应用名称，url为html地址 -->
-    <micro-app name='app1' url='http://localhost:3000/' baseurl='/my-page'></micro-app>
+    <!-- 👇 name为应用名称，url为html地址 -->
+    <micro-app name='app1' url='http://localhost:3000/' baseroute='/my-page'></micro-app>
   </div>
 </template>
 ```
 
-> url和子应用路由的关系请查看[路由一章](https://zeroing.jd.com/micro-app/docs.html#/zh-cn/route)
+> url和子应用路由的关系请查看[路由一章](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/route)
 
 ## 子应用
 > 子应用以react框架为例
 
-1、添加路由前缀(如果基座应用是history路由，子应用是hash路由，不需要设置路由前缀，这一步可以省略)
+1、设置基础路由(如果基座应用是history路由，子应用是hash路由，不需要设置基础路由，这一步可以省略)
 
 ```js
 // router.js
@@ -102,8 +97,8 @@ import { BrowserRouter, Switch, Route } from 'react-router-dom'
 
 export default function AppRoute () {
   return (
-    // 👇 添加路由前缀，子应用可以通过window.__MICRO_APP_BASE_URL__获取基座应用下发的baseurl
-    <BrowserRouter basename={window.__MICRO_APP_BASE_URL__ || '/'}>
+    // 👇 设置基础路由，子应用可以通过window.__MICRO_APP_BASE_ROUTE__获取基座应用下发的baseroute
+    <BrowserRouter basename={window.__MICRO_APP_BASE_ROUTE__ || '/'}>
       <Switch>
         ...
       </Switch>
@@ -127,13 +122,11 @@ devServer: {
 
 上面列出了react和vue框架的使用方式，它们是可以自由组合的，比如基座应用是react，子应用是vue，或者基座应用是vue，子应用是react，或者基座应用和子应用都是react、vue。 micro-app对前端框架没有限制，任何框架都可以作为基座应用嵌入任何类型框架的子应用。
 
-更多详细配置可以查看[官网文档](https://zeroing.jd.com/micro-app/docs.html#/zh-cn/start)
+更多详细配置可以查看[官网文档](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/start)
 
 # 🤝 参与共建
 如果您对这个项目感兴趣，欢迎提 pull request，也欢迎 "Star" 支持一下 ^_^
 
-如果您正在使用，请务必[告诉我们](https://github.com/micro-zoe/micro-app/issues/35)
-
 ### 本地运行
 1、克隆项目
 ```
@@ -153,7 +146,7 @@ yarn start # 访问 http://localhost:3000
 更多命令请查看[DEVELP](https://github.com/micro-zoe/micro-app/blob/master/DEVELOP.zh-cn.md)
 
 # FAQ
-[问题汇总](https://zeroing.jd.com/micro-app/docs.html#/zh-cn/questions)
+[问题汇总](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/questions)
 <details>
 
   <summary>micro-app的优势在哪里？</summary>
@@ -196,13 +189,13 @@ yarn start # 访问 http://localhost:3000
 <details>
   <summary>支持vite吗?</summary>
   
-  支持，详情请查看[适配vite](https://zeroing.jd.com/micro-app/docs.html#/zh-cn/advanced?id=_2%e3%80%81%e9%80%82%e9%85%8dvite)
+  支持，详情请查看[适配vite](https://micro-zoe.github.io/micro-app/docs.html#/zh-cn/advanced?id=_2%e3%80%81%e9%80%82%e9%85%8dvite)
 </details>
 
 # 贡献者们
-
+<a href="https://github.com/micro-zoe/micro-app/graphs/contributors"><img src="./.github/contributors.svg" /></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://opencollective.com/micro-app/contributors.svg?width=890&button=false" /></a> -->
 
 # License
 [MIT License](https://github.com/micro-zoe/micro-app/blob/master/LICENSE)

package/lib/index.d.ts

@@ -6,7 +6,7 @@
 declare module '@micro-zoe/micro-app' {
     export { default as preFetch } from '@micro-zoe/micro-app/prefetch';
     export { default } from '@micro-zoe/micro-app/micro_app';
-    export { removeDomScope, pureCreateElement, version } from '@micro-zoe/micro-app/libs/utils';
+    export { removeDomScope, pureCreateElement, version, setCurrentAppName } from '@micro-zoe/micro-app/libs/utils';
 }
 
 declare module '@micro-zoe/micro-app/prefetch' {
@@ -59,24 +59,9 @@ declare module '@micro-zoe/micro-app/micro_app' {
 
 declare module '@micro-zoe/micro-app/libs/utils' {
     import type { Func } from '@micro-app/types';
-    type RequestIdleCallbackOptions = {
-            timeout: number;
-    };
-    type RequestIdleCallbackInfo = {
-            readonly didTimeout: boolean;
-            timeRemaining: () => number;
-    };
-    global {
-            interface Window {
-                    requestIdleCallback(callback: (info: RequestIdleCallbackInfo) => void, opts?: RequestIdleCallbackOptions): number;
-                    _babelPolyfill: boolean;
-                    proxyWindow: WindowProxy;
-                    __MICRO_APP_ENVIRONMENT__: boolean;
-            }
-    }
-    export const rawWindow: any;
-    export const rawDocument: any;
     export const version = "__VERSION__";
+    export const isBrowser: boolean;
+    export const globalThis: Window;
     /**
         * format error log
         * @param msg message
@@ -131,7 +116,12 @@ declare module '@micro-zoe/micro-app/libs/utils' {
     export function isSupportModuleScript(): boolean;
     export function createNonceStr(): string;
     export function unique(array: any[]): any[];
-    export const requestIdleCallback: (callback: (info: RequestIdleCallbackInfo) => void, opts?: RequestIdleCallbackOptions | undefined) => number;
+    export const requestIdleCallback: (callback: (info: {
+            readonly didTimeout: boolean;
+            timeRemaining: () => number;
+    }) => void, opts?: {
+            timeout: number;
+    } | undefined) => number;
     export function setCurrentAppName(appName: string | null): void;
     export function getCurrentAppName(): string | null;
     export function removeDomScope(): void;
@@ -146,8 +136,7 @@ declare module '@micro-zoe/micro-app/libs/utils' {
         * @param origin Cloned element
         * @param target Accept cloned elements
         */
-    export function cloneNode<T extends Node, Q extends Node>(origin: T, target: Q): void;
-    export {};
+    export function cloneNode<T extends Element, Q extends Element>(origin: T, target: Q): void;
 }
 
 declare module '@micro-zoe/micro-app/interact' {