@module-federation/runtime 0.0.15 → 0.0.17

package/README.md

@@ -212,15 +212,15 @@ init({
   remotes: [
     {
       name: '@demo/sub1',
-      entry: 'http://localhost:2001/vmok-manifest.json',
+      entry: 'http://localhost:2001/mf-manifest.json',
     },
     {
       name: '@demo/sub2',
-      entry: 'http://localhost:2001/vmok-manifest.json',
+      entry: 'http://localhost:2001/mf-manifest.json',
     },
     {
       name: '@demo/sub3',
-      entry: 'http://localhost:2001/vmok-manifest.json',
+      entry: 'http://localhost:2001/mf-manifest.json',
     },
   ],
 });
@@ -258,6 +258,73 @@ preloadRemote([
 ]);
 ```
 
+### registerRemotes
+
+- Type: `registerRemotes(remotes: Remote[], options?: { force?: boolean }): void`
+- Used to register remotes after init .
+
+- Type
+
+```typescript
+function registerRemotes(remotes: Remote[], options?: { force?: boolean }) {}
+
+type Remote = (RemoteWithEntry | RemoteWithVersion) & RemoteInfoCommon;
+
+interface RemoteInfoCommon {
+  alias?: string;
+  shareScope?: string;
+  type?: RemoteEntryType;
+  entryGlobalName?: string;
+}
+
+interface RemoteWithEntry {
+    name: string;
+    entry: string;
+}
+
+interface RemoteWithVersion {
+    name: string;
+    version: string;
+}
+```
+
+- Details
+**info**: Please be careful when setting `force:true` !
+
+If set `force: true`, it will merge remote(include loaded remote), and remove loaded remote cache , as well as console.warn to tell this action may have risks.
+
+* Example
+
+```ts
+import { init, registerRemotes } from '@module-federation/runtime';
+
+init({
+  name: '@demo/register-new-remotes',
+  remotes: [
+    {
+      name: '@demo/sub1',
+      entry: 'http://localhost:2001/mf-manifest.json',
+    }
+  ],
+});
+
+// add new remote @demo/sub2
+registerRemotes([
+  {
+      name: '@demo/sub2',
+      entry: 'http://localhost:2002/mf-manifest.json',
+  }
+]);
+
+// override previous remote @demo/sub1
+registerRemotes([
+  {
+      name: '@demo/sub1',
+      entry: 'http://localhost:2003/mf-manifest.json',
+  }
+]);
+```
+
 ## hooks
 
 Lifecycle hooks for FederationHost interaction.

package/dist/index.cjs.js

@@ -160,9 +160,13 @@ async function loadEntryScript({ name, globalName, entry, createScriptHook }) {
         return e;
     });
 }
+function getRemoteEntryUniqueKey(remoteInfo) {
+    const { entry, name } = remoteInfo;
+    return sdk.composeKeyWithSeparator(name, entry);
+}
 async function getRemoteEntry({ remoteEntryExports, remoteInfo, createScriptHook }) {
     const { entry, name, type, entryGlobalName } = remoteInfo;
-    const uniqueKey = sdk.composeKeyWithSeparator(name, entry);
+    const uniqueKey = getRemoteEntryUniqueKey(remoteInfo);
     if (remoteEntryExports) {
         return remoteEntryExports;
     }
@@ -1478,30 +1482,9 @@ class FederationHost {
         });
         const userRemotes = userOptionsRes.remotes || [];
         const remotes = userRemotes.reduce((res, remote)=>{
-            if (!res.find((item)=>item.name === remote.name)) {
-                if (remote.alias) {
-                    // Validate if alias equals the prefix of remote.name and remote.alias, if so, throw an error
-                    // As multi-level path references cannot guarantee unique names, alias being a prefix of remote.name is not supported
-                    const findEqual = res.find((item)=>{
-                        var _item_alias;
-                        return remote.alias && (item.name.startsWith(remote.alias) || ((_item_alias = item.alias) == null ? void 0 : _item_alias.startsWith(remote.alias)));
-                    });
-                    share.assert(!findEqual, `The alias ${remote.alias} of remote ${remote.name} is not allowed to be the prefix of ${findEqual && findEqual.name} name or alias`);
-                }
-                // Set the remote entry to a complete path
-                if ('entry' in remote) {
-                    if (share.isBrowserEnv() && !remote.entry.startsWith('http')) {
-                        remote.entry = new URL(remote.entry, window.location.origin).href;
-                    }
-                }
-                if (!remote.shareScope) {
-                    remote.shareScope = share.DEFAULT_SCOPE;
-                }
-                if (!remote.type) {
-                    remote.type = share.DEFAULT_REMOTE_TYPE;
-                }
-                res.push(remote);
-            }
+            this.registerRemote(remote, res, {
+                force: false
+            });
             return res;
         }, globalOptionsRes.remotes);
         // register shared in shareScopeMap
@@ -1581,6 +1564,74 @@ class FederationHost {
             }
         });
     }
+    removeRemote(remote) {
+        const { name } = remote;
+        const remoteIndex = this.options.remotes.findIndex((item)=>item.name === name);
+        if (remoteIndex !== -1) {
+            this.options.remotes.splice(remoteIndex, 1);
+        }
+        const loadedModule = this.moduleCache.get(remote.name);
+        if (loadedModule) {
+            const key = loadedModule.remoteInfo.entryGlobalName;
+            if (globalThis[key]) {
+                delete globalThis[key];
+            }
+            const remoteEntryUniqueKey = getRemoteEntryUniqueKey(loadedModule.remoteInfo);
+            if (share.globalLoading[remoteEntryUniqueKey]) {
+                delete share.globalLoading[remoteEntryUniqueKey];
+            }
+            this.moduleCache.delete(remote.name);
+        }
+    }
+    registerRemote(remote, targetRemotes, options) {
+        const normalizeRemote = ()=>{
+            if (remote.alias) {
+                // Validate if alias equals the prefix of remote.name and remote.alias, if so, throw an error
+                // As multi-level path references cannot guarantee unique names, alias being a prefix of remote.name is not supported
+                const findEqual = targetRemotes.find((item)=>{
+                    var _item_alias;
+                    return remote.alias && (item.name.startsWith(remote.alias) || ((_item_alias = item.alias) == null ? void 0 : _item_alias.startsWith(remote.alias)));
+                });
+                share.assert(!findEqual, `The alias ${remote.alias} of remote ${remote.name} is not allowed to be the prefix of ${findEqual && findEqual.name} name or alias`);
+            }
+            // Set the remote entry to a complete path
+            if ('entry' in remote) {
+                if (share.isBrowserEnv() && !remote.entry.startsWith('http')) {
+                    remote.entry = new URL(remote.entry, window.location.origin).href;
+                }
+            }
+            if (!remote.shareScope) {
+                remote.shareScope = share.DEFAULT_SCOPE;
+            }
+            if (!remote.type) {
+                remote.type = share.DEFAULT_REMOTE_TYPE;
+            }
+        };
+        const registeredRemote = targetRemotes.find((item)=>item.name === remote.name);
+        if (!registeredRemote) {
+            normalizeRemote();
+            targetRemotes.push(remote);
+        } else {
+            const messages = [
+                `The remote "${remote.name}" is already registered.`,
+                (options == null ? void 0 : options.force) ? 'Hope you have known that OVERRIDE it may have some unexpected errors' : 'If you want to merge the remote, you can set "force: true".'
+            ];
+            if (options == null ? void 0 : options.force) {
+                // remove registered remote
+                this.removeRemote(registeredRemote);
+                normalizeRemote();
+                targetRemotes.push(remote);
+            }
+            share.warn(messages.join(' '));
+        }
+    }
+    registerRemotes(remotes, options) {
+        remotes.forEach((remote)=>{
+            this.registerRemote(remote, this.options.remotes, {
+                force: options == null ? void 0 : options.force
+            });
+        });
+    }
     constructor(userOptions){
         this.hooks = new PluginSystem({
             beforeInit: new SyncWaterfallHook('beforeInit'),
@@ -1605,7 +1656,7 @@ class FederationHost {
             // not used yet
             afterPreloadRemote: new AsyncHook()
         });
-        this.version = "0.0.15";
+        this.version = "0.0.17";
         this.moduleCache = new Map();
         this.loaderHook = new PluginSystem({
             // FIXME: may not be suitable , not open to the public yet
@@ -1680,6 +1731,11 @@ function preloadRemote(...args) {
     // eslint-disable-next-line prefer-spread
     return FederationInstance.preloadRemote.apply(FederationInstance, args);
 }
+function registerRemotes(...args) {
+    share.assert(FederationInstance, 'Please call init first');
+    // eslint-disable-next-line prefer-spread
+    return FederationInstance.registerRemotes.apply(FederationInstance, args);
+}
 // Inject for debug
 share.setGlobalFederationConstructor(FederationHost);
 
@@ -1698,3 +1754,4 @@ exports.loadRemote = loadRemote;
 exports.loadShare = loadShare;
 exports.loadShareSync = loadShareSync;
 exports.preloadRemote = preloadRemote;
+exports.registerRemotes = registerRemotes;

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-import { g as getGlobalHostPlugins, D as DEFAULT_REMOTE_TYPE, a as DEFAULT_SCOPE, b as globalLoading, c as getRemoteEntryExports, d as assert, s as safeToString, e as getFMId, i as isObject, f as error, w as warn, h as isPlainObject, j as isRemoteInfoWithEntry, k as isPureRemoteEntry, l as getRegisteredShare, m as getInfoWithoutType, n as getPreloaded, o as setPreloaded, p as getGlobalSnapshotInfoByModuleInfo, q as addGlobalSnapshot, r as setGlobalSnapshotInfoByModuleInfo, t as getGlobalSnapshot, G as Global, u as getGlobalShareScope, v as formatShareConfigs, x as isBrowserEnv, y as getBuilderId, z as addUniqueItem, A as setGlobalFederationConstructor, B as getGlobalFederationInstance, C as getGlobalFederationConstructor, E as setGlobalFederationInstance } from './share.esm.js';
+import { g as getGlobalHostPlugins, D as DEFAULT_REMOTE_TYPE, a as DEFAULT_SCOPE, b as globalLoading, c as getRemoteEntryExports, d as assert, s as safeToString, e as getFMId, i as isObject, f as error, w as warn, h as isPlainObject, j as isRemoteInfoWithEntry, k as isPureRemoteEntry, l as getRegisteredShare, m as getInfoWithoutType, n as getPreloaded, o as setPreloaded, p as getGlobalSnapshotInfoByModuleInfo, q as addGlobalSnapshot, r as setGlobalSnapshotInfoByModuleInfo, t as getGlobalSnapshot, G as Global, u as getGlobalShareScope, v as formatShareConfigs, x as getBuilderId, y as isBrowserEnv, z as addUniqueItem, A as setGlobalFederationConstructor, B as getGlobalFederationInstance, C as getGlobalFederationConstructor, E as setGlobalFederationInstance } from './share.esm.js';
 export { F as registerGlobalPlugins } from './share.esm.js';
 import { composeKeyWithSeparator, loadScriptNode, loadScript, createLink, getResourceUrl, isManifestProvider, generateSnapshotFromManifest } from '@module-federation/sdk';
 export { loadScript, loadScriptNode } from '@module-federation/sdk';
@@ -158,9 +158,13 @@ async function loadEntryScript({ name, globalName, entry, createScriptHook }) {
         return e;
     });
 }
+function getRemoteEntryUniqueKey(remoteInfo) {
+    const { entry, name } = remoteInfo;
+    return composeKeyWithSeparator(name, entry);
+}
 async function getRemoteEntry({ remoteEntryExports, remoteInfo, createScriptHook }) {
     const { entry, name, type, entryGlobalName } = remoteInfo;
-    const uniqueKey = composeKeyWithSeparator(name, entry);
+    const uniqueKey = getRemoteEntryUniqueKey(remoteInfo);
     if (remoteEntryExports) {
         return remoteEntryExports;
     }
@@ -1476,30 +1480,9 @@ class FederationHost {
         });
         const userRemotes = userOptionsRes.remotes || [];
         const remotes = userRemotes.reduce((res, remote)=>{
-            if (!res.find((item)=>item.name === remote.name)) {
-                if (remote.alias) {
-                    // Validate if alias equals the prefix of remote.name and remote.alias, if so, throw an error
-                    // As multi-level path references cannot guarantee unique names, alias being a prefix of remote.name is not supported
-                    const findEqual = res.find((item)=>{
-                        var _item_alias;
-                        return remote.alias && (item.name.startsWith(remote.alias) || ((_item_alias = item.alias) == null ? void 0 : _item_alias.startsWith(remote.alias)));
-                    });
-                    assert(!findEqual, `The alias ${remote.alias} of remote ${remote.name} is not allowed to be the prefix of ${findEqual && findEqual.name} name or alias`);
-                }
-                // Set the remote entry to a complete path
-                if ('entry' in remote) {
-                    if (isBrowserEnv() && !remote.entry.startsWith('http')) {
-                        remote.entry = new URL(remote.entry, window.location.origin).href;
-                    }
-                }
-                if (!remote.shareScope) {
-                    remote.shareScope = DEFAULT_SCOPE;
-                }
-                if (!remote.type) {
-                    remote.type = DEFAULT_REMOTE_TYPE;
-                }
-                res.push(remote);
-            }
+            this.registerRemote(remote, res, {
+                force: false
+            });
             return res;
         }, globalOptionsRes.remotes);
         // register shared in shareScopeMap
@@ -1579,6 +1562,74 @@ class FederationHost {
             }
         });
     }
+    removeRemote(remote) {
+        const { name } = remote;
+        const remoteIndex = this.options.remotes.findIndex((item)=>item.name === name);
+        if (remoteIndex !== -1) {
+            this.options.remotes.splice(remoteIndex, 1);
+        }
+        const loadedModule = this.moduleCache.get(remote.name);
+        if (loadedModule) {
+            const key = loadedModule.remoteInfo.entryGlobalName;
+            if (globalThis[key]) {
+                delete globalThis[key];
+            }
+            const remoteEntryUniqueKey = getRemoteEntryUniqueKey(loadedModule.remoteInfo);
+            if (globalLoading[remoteEntryUniqueKey]) {
+                delete globalLoading[remoteEntryUniqueKey];
+            }
+            this.moduleCache.delete(remote.name);
+        }
+    }
+    registerRemote(remote, targetRemotes, options) {
+        const normalizeRemote = ()=>{
+            if (remote.alias) {
+                // Validate if alias equals the prefix of remote.name and remote.alias, if so, throw an error
+                // As multi-level path references cannot guarantee unique names, alias being a prefix of remote.name is not supported
+                const findEqual = targetRemotes.find((item)=>{
+                    var _item_alias;
+                    return remote.alias && (item.name.startsWith(remote.alias) || ((_item_alias = item.alias) == null ? void 0 : _item_alias.startsWith(remote.alias)));
+                });
+                assert(!findEqual, `The alias ${remote.alias} of remote ${remote.name} is not allowed to be the prefix of ${findEqual && findEqual.name} name or alias`);
+            }
+            // Set the remote entry to a complete path
+            if ('entry' in remote) {
+                if (isBrowserEnv() && !remote.entry.startsWith('http')) {
+                    remote.entry = new URL(remote.entry, window.location.origin).href;
+                }
+            }
+            if (!remote.shareScope) {
+                remote.shareScope = DEFAULT_SCOPE;
+            }
+            if (!remote.type) {
+                remote.type = DEFAULT_REMOTE_TYPE;
+            }
+        };
+        const registeredRemote = targetRemotes.find((item)=>item.name === remote.name);
+        if (!registeredRemote) {
+            normalizeRemote();
+            targetRemotes.push(remote);
+        } else {
+            const messages = [
+                `The remote "${remote.name}" is already registered.`,
+                (options == null ? void 0 : options.force) ? 'Hope you have known that OVERRIDE it may have some unexpected errors' : 'If you want to merge the remote, you can set "force: true".'
+            ];
+            if (options == null ? void 0 : options.force) {
+                // remove registered remote
+                this.removeRemote(registeredRemote);
+                normalizeRemote();
+                targetRemotes.push(remote);
+            }
+            warn(messages.join(' '));
+        }
+    }
+    registerRemotes(remotes, options) {
+        remotes.forEach((remote)=>{
+            this.registerRemote(remote, this.options.remotes, {
+                force: options == null ? void 0 : options.force
+            });
+        });
+    }
     constructor(userOptions){
         this.hooks = new PluginSystem({
             beforeInit: new SyncWaterfallHook('beforeInit'),
@@ -1603,7 +1654,7 @@ class FederationHost {
             // not used yet
             afterPreloadRemote: new AsyncHook()
         });
-        this.version = "0.0.15";
+        this.version = "0.0.17";
         this.moduleCache = new Map();
         this.loaderHook = new PluginSystem({
             // FIXME: may not be suitable , not open to the public yet
@@ -1678,7 +1729,12 @@ function preloadRemote(...args) {
     // eslint-disable-next-line prefer-spread
     return FederationInstance.preloadRemote.apply(FederationInstance, args);
 }
+function registerRemotes(...args) {
+    assert(FederationInstance, 'Please call init first');
+    // eslint-disable-next-line prefer-spread
+    return FederationInstance.registerRemotes.apply(FederationInstance, args);
+}
 // Inject for debug
 setGlobalFederationConstructor(FederationHost);
 
-export { FederationHost, init, loadRemote, loadShare, loadShareSync, preloadRemote };
+export { FederationHost, init, loadRemote, loadShare, loadShareSync, preloadRemote, registerRemotes };

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/runtime",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "author": "zhouxiao <codingzx@gmail.com>",
   "main": "./index.cjs.js",
   "module": "./index.esm.js",

package/dist/share.cjs.js

@@ -185,7 +185,7 @@ function getGlobalFederationConstructor() {
 function setGlobalFederationConstructor(FederationConstructor, isDebug = isDebugMode()) {
     if (isDebug) {
         globalThis.__FEDERATION__.__DEBUG_CONSTRUCTOR__ = FederationConstructor;
-        globalThis.__FEDERATION__.__DEBUG_CONSTRUCTOR_VERSION__ = "0.0.15";
+        globalThis.__FEDERATION__.__DEBUG_CONSTRUCTOR_VERSION__ = "0.0.17";
     }
 }
 // eslint-disable-next-line @typescript-eslint/ban-types

package/dist/share.esm.js

@@ -183,7 +183,7 @@ function getGlobalFederationConstructor() {
 function setGlobalFederationConstructor(FederationConstructor, isDebug = isDebugMode()) {
     if (isDebug) {
         globalThis.__FEDERATION__.__DEBUG_CONSTRUCTOR__ = FederationConstructor;
-        globalThis.__FEDERATION__.__DEBUG_CONSTRUCTOR_VERSION__ = "0.0.15";
+        globalThis.__FEDERATION__.__DEBUG_CONSTRUCTOR_VERSION__ = "0.0.17";
     }
 }
 // eslint-disable-next-line @typescript-eslint/ban-types
@@ -803,4 +803,4 @@ function getGlobalShareScope() {
     return Global.__FEDERATION__.__SHARE__;
 }
 
-export { setGlobalFederationConstructor as A, getGlobalFederationInstance as B, getGlobalFederationConstructor as C, DEFAULT_REMOTE_TYPE as D, setGlobalFederationInstance as E, registerGlobalPlugins as F, Global as G, nativeGlobal as H, resetFederationGlobalInfo as I, getTargetSnapshotInfoByModuleInfo as J, DEFAULT_SCOPE as a, globalLoading as b, getRemoteEntryExports as c, assert as d, getFMId as e, error as f, getGlobalHostPlugins as g, isPlainObject as h, isObject as i, isRemoteInfoWithEntry as j, isPureRemoteEntry as k, getRegisteredShare as l, getInfoWithoutType as m, getPreloaded as n, setPreloaded as o, getGlobalSnapshotInfoByModuleInfo as p, addGlobalSnapshot as q, setGlobalSnapshotInfoByModuleInfo as r, safeToString as s, getGlobalSnapshot as t, getGlobalShareScope as u, formatShareConfigs as v, warn as w, isBrowserEnv as x, getBuilderId as y, addUniqueItem as z };
+export { setGlobalFederationConstructor as A, getGlobalFederationInstance as B, getGlobalFederationConstructor as C, DEFAULT_REMOTE_TYPE as D, setGlobalFederationInstance as E, registerGlobalPlugins as F, Global as G, nativeGlobal as H, resetFederationGlobalInfo as I, getTargetSnapshotInfoByModuleInfo as J, DEFAULT_SCOPE as a, globalLoading as b, getRemoteEntryExports as c, assert as d, getFMId as e, error as f, getGlobalHostPlugins as g, isPlainObject as h, isObject as i, isRemoteInfoWithEntry as j, isPureRemoteEntry as k, getRegisteredShare as l, getInfoWithoutType as m, getPreloaded as n, setPreloaded as o, getGlobalSnapshotInfoByModuleInfo as p, addGlobalSnapshot as q, setGlobalSnapshotInfoByModuleInfo as r, safeToString as s, getGlobalSnapshot as t, getGlobalShareScope as u, formatShareConfigs as v, warn as w, getBuilderId as x, isBrowserEnv as y, addUniqueItem as z };

package/dist/src/core.d.ts

@@ -153,5 +153,10 @@ export declare class FederationHost {
     private formatOptions;
     private registerPlugins;
     private setShared;
+    private removeRemote;
+    private registerRemote;
+    registerRemotes(remotes: Remote[], options?: {
+        force?: boolean;
+    }): void;
 }
 export {};

package/dist/src/index.d.ts

@@ -10,3 +10,4 @@ export declare function loadRemote(...args: Parameters<FederationHost['loadRemot
 export declare function loadShare(...args: Parameters<FederationHost['loadShare']>): ReturnType<FederationHost['loadShare']>;
 export declare function loadShareSync(...args: Parameters<FederationHost['loadShareSync']>): ReturnType<FederationHost['loadShareSync']>;
 export declare function preloadRemote(...args: Parameters<FederationHost['preloadRemote']>): ReturnType<FederationHost['preloadRemote']>;
+export declare function registerRemotes(...args: Parameters<FederationHost['registerRemotes']>): ReturnType<FederationHost['registerRemotes']>;

package/dist/src/utils/load.d.ts

@@ -9,6 +9,7 @@ export declare function loadEntryScript({ name, globalName, entry, createScriptH
     entry: string;
     createScriptHook?: (url: string) => HTMLScriptElement | void;
 }): Promise<RemoteEntryExports>;
+export declare function getRemoteEntryUniqueKey(remoteInfo: RemoteInfo): string;
 export declare function getRemoteEntry({ remoteEntryExports, remoteInfo, createScriptHook, }: {
     remoteInfo: RemoteInfo;
     remoteEntryExports?: RemoteEntryExports | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/runtime",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "author": "zhouxiao <codingzx@gmail.com>",
   "main": "./dist/index.cjs",
   "module": "./dist/index.esm.js",
@@ -45,6 +45,6 @@
     }
   },
   "dependencies": {
-    "@module-federation/sdk": "0.0.15"
+    "@module-federation/sdk": "0.0.17"
   }
 }