@module-federation/runtime 1.0.0-canary.1 → 1.0.0-canary.2

package/index.esm.js

@@ -1,6 +1,7 @@
 import { i as isStaticResourcesEqual, s as safeWrapper, g as getGlobalHostPlugins, _ as _extends, D as DEFAULT_REMOTE_TYPE, a as DEFAULT_SCOPE, b as globalLoading, c as getRemoteEntryExports, d as assert, e as safeToString$1, G as Global, f as getFMId, h as isObject, j as error, w as warn, k as isPlainObject, l as isRemoteInfoWithEntry, m as isPureRemoteEntry, n as getGlobalShare, o as getInfoWithoutType, p as getPreloaded, q as setPreloaded, r as getGlobalSnapshotInfoByModuleInfo, t as setGlobalSnapshotInfoByModuleInfo, u as getGlobalSnapshot, v as addUniqueItem, x as formatShareConfigs, y as isBrowserEnv$1, z as getGlobalShareScope, A as _object_without_properties_loose, B as getBuilderId, C as setGlobalFederationConstructor, E as getGlobalFederationInstance, F as getGlobalFederationConstructor, H as setGlobalFederationInstance } from './share.esm.js';
 export { I as registerGlobalPlugins } from './share.esm.js';
 
+// Function to get the URL of a resource
 function getResourceUrl(module, sourceUrl) {
     if ('getPublicPath' in module) {
         const publicPath = new Function(module.getPublicPath)();
@@ -8,19 +9,20 @@ function getResourceUrl(module, sourceUrl) {
     } else if ('publicPath' in module) {
         return `${module.publicPath}${sourceUrl}`;
     } else {
-        console.warn('Cannot get resource URL. If in debug mode, please ignore.', module, sourceUrl);
+        console.warn('Unable to retrieve resource URL. If in debug mode, this warning can be disregarded.', module, sourceUrl);
         return '';
     }
 }
+// Function to match a remote with its name and expose
 // id: pkgName(@federation/app1) + expose(button) = @federation/app1/button
 // id: alias(app1) + expose(button) = app1/button
 // id: alias(app1/utils) + expose(loadash/sort) = app1/utils/loadash/sort
 function matchRemoteWithNameAndExpose(remotes, id) {
     for (const remote of remotes){
         // match pkgName
-        const matchNameSuccess = id.startsWith(remote.name);
+        const isNameMatched = id.startsWith(remote.name);
         let expose = id.replace(remote.name, '');
-        if (matchNameSuccess) {
+        if (isNameMatched) {
             if (expose.startsWith('/')) {
                 const pkgNameOrAlias = remote.name;
                 expose = `.${expose}`;
@@ -38,9 +40,9 @@ function matchRemoteWithNameAndExpose(remotes, id) {
             }
         }
         // match alias
-        const matchAliasSuccess = remote.alias && id.startsWith(remote.alias);
+        const isAliasMatched = remote.alias && id.startsWith(remote.alias);
         let exposeWithAlias = remote.alias && id.replace(remote.alias, '');
-        if (remote.alias && matchAliasSuccess) {
+        if (remote.alias && isAliasMatched) {
             if (exposeWithAlias && exposeWithAlias.startsWith('/')) {
                 const pkgNameOrAlias = remote.alias;
                 exposeWithAlias = `.${exposeWithAlias}`;
@@ -60,14 +62,15 @@ function matchRemoteWithNameAndExpose(remotes, id) {
     }
     return;
 }
+// Function to match a remote with its name or alias
 function matchRemote(remotes, nameOrAlias) {
     for (const remote of remotes){
-        const matchNameSuccess = nameOrAlias === remote.name;
-        if (matchNameSuccess) {
+        const isNameMatched = nameOrAlias === remote.name;
+        if (isNameMatched) {
             return remote;
         }
-        const matchAliasSuccess = remote.alias && nameOrAlias === remote.alias;
-        if (matchAliasSuccess) {
+        const isAliasMatched = remote.alias && nameOrAlias === remote.alias;
+        if (isAliasMatched) {
             return remote;
         }
     }
@@ -75,7 +78,7 @@ function matchRemote(remotes, nameOrAlias) {
 }
 
 function createScript(url, cb, attrs, createScriptHook) {
-    // get the existing script element by src
+    // Retrieve the existing script element by its src attribute
     let script = null;
     let needAttach = true;
     const scripts = document.getElementsByTagName('script');
@@ -112,7 +115,7 @@ function createScript(url, cb, attrs, createScriptHook) {
     }
     const onScriptComplete = (prev, // eslint-disable-next-line @typescript-eslint/no-explicit-any
     event)=>{
-        // avoid memory leaks in IE.
+        // Prevent memory leaks in IE.
         if (script) {
             script.onerror = null;
             script.onload = null;
@@ -145,7 +148,7 @@ function loadScript(url, info) {
 
 function registerPlugins(plugins, hookInstances) {
     const globalPlugins = getGlobalHostPlugins();
-    // Register global plugins
+    // Incorporate global plugins
     if (globalPlugins.length > 0) {
         globalPlugins.forEach((plugin)=>{
             if (plugins == null ? void 0 : plugins.find((item)=>item.name !== plugin.name)) {
@@ -416,7 +419,7 @@ var simpleJoinRemoteEntry = function simpleJoinRemoteEntry(rPath, rName) {
     }
     return "".concat(transformedPath, "/").concat(rName);
 };
-// 优先级：overrides > remotes
+// Priority: overrides > remotes
 // eslint-disable-next-line max-lines-per-function
 function generateSnapshotFromManifest(manifest) {
     var options = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
@@ -431,13 +434,13 @@ function generateSnapshotFromManifest(manifest) {
     };
     var overridesKeys = Object.keys(overrides);
     var remotesInfo = {};
-    // If remotes are not passed, only the remotes in the manifest will be read
+    // If remotes are not provided, only the remotes in the manifest will be read
     if (!Object.keys(remotes).length) {
         var _manifest_remotes;
         remotesInfo = ((_manifest_remotes = manifest.remotes) === null || _manifest_remotes === void 0 ? void 0 : _manifest_remotes.reduce(function(res, next) {
             var matchedVersion;
             var name = next.federationContainerName;
-            // overrides has hight priority
+            // overrides have higher priority
             if (overridesKeys.includes(name)) {
                 matchedVersion = overrides[name];
             } else {
@@ -453,7 +456,7 @@ function generateSnapshotFromManifest(manifest) {
             return res;
         }, {})) || {};
     }
-    // If remotes (deploy scenario) are specified, you need to traverse it again
+    // If remotes (deploy scenario) are specified, they need to be traversed again
     Object.keys(remotes).forEach(function(key) {
         return remotesInfo[key] = {
             // overrides will override dependencies
@@ -528,10 +531,10 @@ async function loadEntryScript({ name, globalName, entry, createScriptHook }) {
     }).then(()=>{
         const { remoteEntryKey, entryExports } = getRemoteEntryExports(name, globalName);
         assert(entryExports, `
-      Cannot use the ${name}'s '${entry}' URL with ${remoteEntryKey}'s globalName to get remoteEntry exports.
-      The following reasons may be causing the problem:\n
+      Unable to use the ${name}'s '${entry}' URL with ${remoteEntryKey}'s globalName to get remoteEntry exports.
+      Possible reasons could be:\n
       1. '${entry}' is not the correct URL, or the remoteEntry resource or name is incorrect.\n
-      2. Unable to use ${remoteEntryKey} to get remoteEntry exports in the window object.
+      2. ${remoteEntryKey} cannot be used to get remoteEntry exports in the window object.
     `);
         return entryExports;
     });
@@ -705,14 +708,14 @@ class AsyncHook extends SyncHook {
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-function checkReturnData(originData, returnData) {
-    if (!isObject(returnData)) {
+function checkReturnData(originalData, returnedData) {
+    if (!isObject(returnedData)) {
         return false;
     }
-    if (originData !== returnData) {
+    if (originalData !== returnedData) {
         // eslint-disable-next-line no-restricted-syntax
-        for(const key in originData){
-            if (!(key in returnData)) {
+        for(const key in originalData){
+            if (!(key in returnedData)) {
                 return false;
             }
         }
@@ -722,7 +725,7 @@ function checkReturnData(originData, returnData) {
 class SyncWaterfallHook extends SyncHook {
     emit(data) {
         if (!isObject(data)) {
-            error(`"${this.type}" hook response data must be an object.`);
+            error(`The data for the "${this.type}" hook should be an object.`);
         }
         for (const fn of this.listeners){
             try {
@@ -730,7 +733,7 @@ class SyncWaterfallHook extends SyncHook {
                 if (checkReturnData(data, tempData)) {
                     data = tempData;
                 } else {
-                    this.onerror(`The "${this.type}" type has a plugin return value error.`);
+                    this.onerror(`A plugin returned an unacceptable value for the "${this.type}" type.`);
                     break;
                 }
             } catch (e) {
@@ -750,7 +753,7 @@ class SyncWaterfallHook extends SyncHook {
 class AsyncWaterfallHook extends SyncHook {
     emit(data) {
         if (!isObject(data)) {
-            error(`"${this.type}" hook response data must be an object.`);
+            error(`The response data for the "${this.type}" hook must be an object.`);
         }
         const ls = Array.from(this.listeners);
         if (ls.length > 0) {
@@ -771,7 +774,7 @@ class AsyncWaterfallHook extends SyncHook {
                         }
                     }
                 } else {
-                    this.onerror(`The "${this.type}" type has a plugin return value error.`);
+                    this.onerror(`A plugin returned an incorrect value for the "${this.type}" type.`);
                 }
                 return data;
             };
@@ -788,10 +791,10 @@ class AsyncWaterfallHook extends SyncHook {
 
 class PluginSystem {
     usePlugin(plugin) {
-        assert(isPlainObject(plugin), 'Invalid plugin configuration.');
-        // The plugin name is required and must be unique
+        assert(isPlainObject(plugin), 'Plugin configuration is invalid.');
+        // The plugin's name is mandatory and must be unique
         const pluginName = plugin.name;
-        assert(pluginName, 'Plugin must provide a name.');
+        assert(pluginName, 'A name must be provided by the plugin.');
         if (!this.registerPlugins[pluginName]) {
             this.registerPlugins[pluginName] = plugin;
             Object.keys(this.lifecycle).forEach((key)=>{
@@ -803,9 +806,9 @@ class PluginSystem {
         }
     }
     removePlugin(pluginName) {
-        assert(pluginName, 'Must provide a name.');
+        assert(pluginName, 'A name is required.');
         const plugin = this.registerPlugins[pluginName];
-        assert(plugin, `plugin "${pluginName}" is not registered.`);
+        assert(plugin, `The plugin "${pluginName}" is not registered.`);
         Object.keys(plugin).forEach((key)=>{
             if (key !== 'name') {
                 this.lifecycle[key].remove(plugin[key]);
@@ -815,11 +818,11 @@ class PluginSystem {
     // eslint-disable-next-line @typescript-eslint/no-shadow
     inherit({ lifecycle, registerPlugins }) {
         Object.keys(lifecycle).forEach((hookName)=>{
-            assert(!this.lifecycle[hookName], `"${hookName}" hook has conflict and cannot be inherited.`);
+            assert(!this.lifecycle[hookName], `The hook "${hookName}" has a conflict and cannot be inherited.`);
             this.lifecycle[hookName] = lifecycle[hookName];
         });
         Object.keys(registerPlugins).forEach((pluginName)=>{
-            assert(!this.registerPlugins[pluginName], `"${pluginName}" plugin has conflict and cannot be inherited.`);
+            assert(!this.registerPlugins[pluginName], `The plugin "${pluginName}" has a conflict and cannot be inherited.`);
             this.usePlugin(registerPlugins[pluginName]);
         });
     }
@@ -838,13 +841,12 @@ function defaultPreloadArgs(preloadConfig) {
     }, preloadConfig);
 }
 function formatPreloadArgs(remotes, preloadArgs) {
-    // let preloadOps: PreloadOptions;
     return preloadArgs.map((args)=>{
         const remoteInfo = matchRemote(remotes, args.nameOrAlias);
-        assert(remoteInfo, `can't preload ${args.nameOrAlias}，it is no't include in ${!remoteInfo && safeToString$1({
+        assert(remoteInfo, `Unable to preload ${args.nameOrAlias} as it is not included in ${!remoteInfo && safeToString$1({
             remoteInfo,
             remotes
-        })} `);
+        })}`);
         return {
             remote: remoteInfo,
             preloadConfig: defaultPreloadArgs(args)
@@ -930,7 +932,7 @@ function preloadAssets(remoteInfo, host, assets) {
 
 function assignRemoteInfo(remoteInfo, remoteSnapshot) {
     if (!('remoteEntry' in remoteSnapshot) || !remoteSnapshot.remoteEntry) {
-        error(`The remoteEntry attribute of ${name} cannot be undefined.`);
+        error(`The attribute remoteEntry of ${name} must not be undefined.`);
     }
     const { remoteEntry } = remoteSnapshot;
     const entryUrl = getResourceUrl(remoteSnapshot, remoteEntry);
@@ -948,7 +950,7 @@ function snapshotPlugin() {
             if (!isRemoteInfoWithEntry(remote) || !isPureRemoteEntry(remote)) {
                 const { remoteSnapshot, globalSnapshot } = await origin.snapshotHandler.loadRemoteSnapshotInfo(remote);
                 assignRemoteInfo(remoteInfo, remoteSnapshot);
-                // preload assets
+                // preloading assets
                 const preloadOptions = {
                     remote,
                     preloadConfig: {
@@ -999,22 +1001,22 @@ function splitId(id) {
         };
     }
 }
-// Traverse all nodes through moduleInfo and traverse the entire snapshot
+// Traverse all nodes in moduleInfo and traverse the entire snapshot
 function traverseModuleInfo(globalSnapshot, remoteInfo, traverse, isRoot, memo = {}, remoteSnapshot, getModuleInfoHook) {
     const id = getFMId(remoteInfo);
     const { value: snapshotValue } = getInfoWithoutType(globalSnapshot, id, getModuleInfoHook);
-    const effectRemoteSnapshot = remoteSnapshot || snapshotValue;
-    if (effectRemoteSnapshot && !isManifestProvider(effectRemoteSnapshot)) {
-        traverse(effectRemoteSnapshot, remoteInfo, isRoot);
-        if (effectRemoteSnapshot.remotesInfo) {
-            const remoteKeys = Object.keys(effectRemoteSnapshot.remotesInfo);
+    const effectiveRemoteSnapshot = remoteSnapshot || snapshotValue;
+    if (effectiveRemoteSnapshot && !isManifestProvider(effectiveRemoteSnapshot)) {
+        traverse(effectiveRemoteSnapshot, remoteInfo, isRoot);
+        if (effectiveRemoteSnapshot.remotesInfo) {
+            const remoteKeys = Object.keys(effectiveRemoteSnapshot.remotesInfo);
             for (const key of remoteKeys){
                 if (memo[key]) {
                     continue;
                 }
                 memo[key] = true;
                 const subRemoteInfo = splitId(key);
-                const remoteValue = effectRemoteSnapshot.remotesInfo[key];
+                const remoteValue = effectiveRemoteSnapshot.remotesInfo[key];
                 traverseModuleInfo(globalSnapshot, {
                     name: subRemoteInfo.name,
                     version: remoteValue.matchedVersion
@@ -1083,7 +1085,7 @@ function generatePreloadAssets(origin, preloadOptions, remote, globalSnapshot, r
                 return assets;
             }, []);
         }
-        function handlerAssets(assets) {
+        function handleAssets(assets) {
             const assetsRes = assets.map((asset)=>getResourceUrl(moduleInfoSnapshot, asset));
             if (preloadConfig.filter) {
                 return assetsRes.filter(preloadConfig.filter);
@@ -1094,21 +1096,20 @@ function generatePreloadAssets(origin, preloadOptions, remote, globalSnapshot, r
             const assetsLength = moduleAssetsInfo.length;
             for(let index = 0; index < assetsLength; index++){
                 const assetsInfo = moduleAssetsInfo[index];
-                // for (const assetsInfo of moduleAssetsInfo) {
                 const exposeFullPath = `${remoteInfo.name}/${assetsInfo.moduleName}`;
                 const preloaded = getPreloaded(exposeFullPath);
                 if (preloaded) {
                     continue;
                 }
                 if (preloadConfig.resourceCategory === 'all') {
-                    cssAssets.push(...handlerAssets(assetsInfo.assets.css.async));
-                    cssAssets.push(...handlerAssets(assetsInfo.assets.css.sync));
-                    jsAssets.push(...handlerAssets(assetsInfo.assets.js.async));
-                    jsAssets.push(...handlerAssets(assetsInfo.assets.js.sync));
+                    cssAssets.push(...handleAssets(assetsInfo.assets.css.async));
+                    cssAssets.push(...handleAssets(assetsInfo.assets.css.sync));
+                    jsAssets.push(...handleAssets(assetsInfo.assets.js.async));
+                    jsAssets.push(...handleAssets(assetsInfo.assets.js.sync));
                 // eslint-disable-next-line no-constant-condition
                 } else if (preloadConfig.resourceCategory = 'sync') {
-                    cssAssets.push(...handlerAssets(assetsInfo.assets.css.sync));
-                    jsAssets.push(...handlerAssets(assetsInfo.assets.js.sync));
+                    cssAssets.push(...handleAssets(assetsInfo.assets.css.sync));
+                    jsAssets.push(...handleAssets(assetsInfo.assets.js.sync));
                 }
                 setPreloaded(exposeFullPath);
             }
@@ -1220,10 +1221,8 @@ class SnapshotHandler {
             options,
             moduleInfo
         });
-        // In the dynamic loadRemote scenario, incomplete remotesInfo delivery may occur. In this case, the remotesInfo in the host needs to be completed in the snapshot at runtime.
-        // Ensure the integrity of the snapshot, and at the same time help the chrome plug-in correctly identify all producer modules, ensuring that proxyable producer modules will not be missing
-        // In the dynamic loadRemote scenario, incomplete remotesInfo delivery may occur. In this case, the remotesInfo in the host needs to be completed in the snapshot at runtime.
-        // Ensure the integrity of the snapshot, and at the same time help the chrome plug-in correctly identify all producer modules, ensuring that proxyable producer modules will not be missing
+        // In dynamic loadRemote scenarios, incomplete remotesInfo delivery may occur. In such cases, the remotesInfo in the host needs to be completed in the snapshot at runtime.
+        // This ensures the snapshot's integrity and helps the chrome plugin correctly identify all producer modules, ensuring that proxyable producer modules will not be missing.
         if (hostSnapshot && 'remotesInfo' in hostSnapshot && !getInfoWithoutType(hostSnapshot.remotesInfo, moduleInfo.name, (target, key)=>{
             const res = this.HostInstance.loaderHook.lifecycle.getModuleInfo.emit({
                 target,
@@ -1250,7 +1249,7 @@ class SnapshotHandler {
             remoteSnapshot,
             globalSnapshot
         });
-        // global snapshot include manifest or module info include manifest
+        // global snapshot includes manifest or module info includes manifest
         if (globalRemoteSnapshot) {
             if (isManifestProvider(globalRemoteSnapshot)) {
                 const moduleSnapshot = await this.getManifestJson(globalRemoteSnapshot.remoteEntry, moduleInfo, {});
@@ -1375,7 +1374,7 @@ class SnapshotHandler {
             try {
                 const res = await fetch(manifestUrl);
                 manifestJson = await res.json();
-                assert(manifestJson.metaData && manifestJson.exposes && manifestJson.shared, `${manifestUrl} is not federation manifest`);
+                assert(manifestJson.metaData && manifestJson.exposes && manifestJson.shared, `${manifestUrl} is not a federation manifest`);
                 this.manifestCache.set(manifestUrl, manifestJson);
                 return manifestJson;
             } catch (err) {
@@ -1427,9 +1426,10 @@ class FederationHost {
     // overrideSharedOptions(shareScope: GlobalShareScope[string]): void {}
     async loadShare(pkgName, customShareInfo) {
         var _this_options_shared;
-        // 1. Verify whether the currently loaded share already exists, and report an error if it does not exist
-        // 2. Search globally to see if there is a matching share, and if so, use it directly
-        // 3. If not, get it from the current share and store the obtained share globally.
+        // This function performs the following steps:
+        // 1. Checks if the currently loaded share already exists, if not, it throws an error
+        // 2. Searches globally for a matching share, if found, it uses it directly
+        // 3. If not found, it retrieves it from the current share and stores the obtained share globally.
         const shareInfo = Object.assign({}, (_this_options_shared = this.options.shared) == null ? void 0 : _this_options_shared[pkgName], customShareInfo);
         const loadShareRes = await this.hooks.lifecycle.beforeLoadShare.emit({
             pkgName,
@@ -1438,8 +1438,9 @@ class FederationHost {
             origin: this
         });
         const { shareInfo: shareInfoRes } = loadShareRes;
-        assert(shareInfoRes, `cannot find ${pkgName} Share in the ${this.options.name}. Perhaps you have not injected the ${pkgName} Share parameters`);
-        // get from cache
+        // Assert that shareInfoRes exists, if not, throw an error
+        assert(shareInfoRes, `Cannot find ${pkgName} Share in the ${this.options.name}. Please ensure that the ${pkgName} Share parameters have been injected`);
+        // Retrieve from cache
         const globalShare = getGlobalShare(pkgName, shareInfoRes);
         if (globalShare && globalShare.lib) {
             addUniqueItem(globalShare.useIn, this.options.name);
@@ -1495,10 +1496,10 @@ class FederationHost {
             return loading;
         }
     }
-    // There will be a lib function only if the shared set by eager or runtime init is set or the shared is successfully loaded.
-    // 1. If the loaded shared already exists globally, then reuse
-    // 2. If lib exists in local shared, use it directly
-    // 3. If the local get returns something other than Promise, then use it directly
+    // The lib function will only be available if the shared set by eager or runtime init is set or the shared is successfully loaded.
+    // 1. If the loaded shared already exists globally, then it will be reused
+    // 2. If lib exists in local shared, it will be used directly
+    // 3. If the local get returns something other than Promise, then it will be used directly
     loadShareSync(pkgName) {
         var _this_options_shared;
         const shareInfo = (_this_options_shared = this.options.shared) == null ? void 0 : _this_options_shared[pkgName];
@@ -1523,10 +1524,10 @@ class FederationHost {
             const module = shareInfo.get();
             if (module instanceof Promise) {
                 throw new Error(`
-        The loadShareSync function failed to load ${pkgName}. Cannot find ${pkgName} in ${this.options.name}.
-        Failure reason: \n
-        1. Registered ${pkgName} share with the 'get' attribute, but did not use loadShare before.\n
-        2. Did not register ${pkgName} share with the 'lib' attribute.\n
+        The loadShareSync function was unable to load ${pkgName}. The ${pkgName} could not be found in ${this.options.name}.
+        Possible reasons for failure: \n
+        1. The ${pkgName} share was registered with the 'get' attribute, but loadShare was not used beforehand.\n
+        2. The ${pkgName} share was not registered with the 'lib' attribute.\n
       `);
             }
             shareInfo.lib = module;
@@ -1540,10 +1541,10 @@ class FederationHost {
             return shareInfo.lib;
         }
         throw new Error(`
-        The loadShareSync function failed to load ${pkgName}. Cannot find ${pkgName} in ${this.options.name}.
-        Failure reason: \n
-        1. Registered ${pkgName} share with the 'get' attribute, but did not use loadShare before.\n
-        2. Did not register ${pkgName} share with the 'lib' attribute.\n
+        The loadShareSync function was unable to load ${pkgName}. The ${pkgName} could not be found in ${this.options.name}.
+        Possible reasons for failure: \n
+        1. The ${pkgName} share was registered with the 'get' attribute, but loadShare was not used beforehand.\n
+        2. The ${pkgName} share was not registered with the 'lib' attribute.\n
       `);
     }
     async _getRemoteModuleAndOptions(id) {
@@ -1555,10 +1556,10 @@ class FederationHost {
         const { id: idRes } = loadRemoteArgs;
         const remoteSplitInfo = matchRemoteWithNameAndExpose(this.options.remotes, idRes);
         assert(remoteSplitInfo, `
-        Cannot find ${idRes} in ${this.options.name}. Possible cause of failure:\n
-        1. ${idRes} was not injected into ${this.options.name}'s 'remotes' parameter.\n
-        2. Cannot find ${idRes} in ${this.options.name}'s 'remotes' with attribute 'name' or 'alias'.
-        3. The 'beforeLoadRemote' hook was provided but did not return the correct 'remoteInfo' when loading ${idRes}.
+        Unable to locate ${idRes} in ${this.options.name}. Potential reasons for failure include:\n
+        1. ${idRes} was not included in the 'remotes' parameter of ${this.options.name}.\n
+        2. ${idRes} could not be found in the 'remotes' of ${this.options.name} with either 'name' or 'alias' attributes.
+        3. The 'beforeLoadRemote' hook was provided but did not return the correct 'remoteInfo' when attempting to load ${idRes}.
       `);
         const { remote: rawRemote } = remoteSplitInfo;
         const remoteInfo = getRemoteInfo(rawRemote);
@@ -1570,7 +1571,7 @@ class FederationHost {
             remoteInfo
         }));
         const { remote, expose } = matchInfo;
-        assert(remote && expose, `The 'beforeLoadRemote' hook was provided but did not return the correct 'remote' and 'expose' when loading ${idRes}.`);
+        assert(remote && expose, `The 'beforeLoadRemote' hook was executed, but it failed to return the correct 'remote' and 'expose' values while loading ${idRes}.`);
         let module = this.moduleCache.get(remote.name);
         const moduleOptions = {
             hostInfo: {
@@ -1599,10 +1600,10 @@ class FederationHost {
             const { loadFactory = true } = options || {
                 loadFactory: true
             };
-            // 1. Verify whether the parameters of the obtained module are legal. There are two module request methods: pkgName + expose and alias + expose.
-            // 2. Request the snapshot information of the current host and store the obtained snapshot information globally. The obtained module information is partly offline and partly online. The online module information will obtain the modules used online.
-            // 3. Get the detailed information of the current module from global (remoteEntry address, expose resource address)
-            // 4. After obtaining remoteEntry, call the init of the module, and then obtain the exported content of the module through get
+            // 1. Validate the parameters of the retrieved module. There are two module request methods: pkgName + expose and alias + expose.
+            // 2. Request the snapshot information of the current host and globally store the obtained snapshot information. The retrieved module information is partially offline and partially online. The online module information will retrieve the modules used online.
+            // 3. Retrieve the detailed information of the current module from global (remoteEntry address, expose resource address)
+            // 4. After retrieving remoteEntry, call the init of the module, and then retrieve the exported content of the module through get
             // id: pkgName(@federation/app1) + expose(button) = @federation/app1/button
             // id: alias(app1) + expose(button) = app1/button
             // id: alias(app1/utils) + expose(loadash/sort) = app1/utils/loadash/sort
@@ -1656,23 +1657,23 @@ class FederationHost {
         }));
     }
     /**
-   * The sharing init sequence function (only runs once per share scope).
-   * Has one argument, the name of the share scope.
-   * Creates a share scope if not existing
+   * This function initializes the sharing sequence (executed only once per share scope).
+   * It accepts one argument, the name of the share scope.
+   * If the share scope does not exist, it creates one.
    */ // eslint-disable-next-line @typescript-eslint/member-ordering
     initializeSharing(shareScopeName = DEFAULT_SCOPE) {
         const shareScopeLoading = Global.__FEDERATION__.__SHARE_SCOPE_LOADING__;
         const shareScope = Global.__FEDERATION__.__SHARE__;
         const hostName = this.options.name;
-        // only runs once
+        // Executes only once
         if (shareScopeLoading[shareScopeName]) {
             return shareScopeLoading[shareScopeName];
         }
-        // creates a new share scope if needed
+        // Creates a new share scope if necessary
         if (!shareScope[shareScopeName]) {
             shareScope[shareScopeName] = {};
         }
-        // runs all init snippets from all modules reachable
+        // Executes all initialization snippets from all accessible modules
         const scope = shareScope[shareScopeName];
         const register = (name, shared)=>{
             const { version, eager } = shared;
@@ -1720,8 +1721,8 @@ class FederationHost {
         const remotes = userRemotes.reduce((res, remote)=>{
             if (!res.find((item)=>item.name === remote.name)) {
                 if (remote.alias) {
-                    // 校验 alias 是否等于 remote.name 和 remote.alias 的前缀，如果是则报错
-                    // 因为引用支持多级路径的引用时无法保证名称是否唯一，所以不支持 alias 为 remote.name 的前缀
+                    // 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)));
@@ -1738,7 +1739,7 @@ class FederationHost {
                     remote.shareScope = DEFAULT_SCOPE;
                 }
                 if (!remote.type) {
-                    // FIXME: The build plugin need to support this field
+                    // FIXME: The build plugin needs to support this field
                     remote.type = DEFAULT_REMOTE_TYPE;
                 }
                 res.push(remote);
@@ -1843,7 +1844,7 @@ class FederationHost {
             generatePreloadAssets: new AsyncHook('generatePreloadAssets'),
             afterPreloadRemote: new AsyncHook()
         });
-        this.version = '0.0.1';
+        this.version = '1.0.0-canary.1';
         this.moduleCache = new Map();
         this.loaderHook = new PluginSystem({
             // FIXME: may not be suitable
@@ -1851,8 +1852,8 @@ class FederationHost {
             createScript: new SyncHook()
         });
         this.loadingShare = {};
-        // TODO: check options detail type
-        // set options default value
+        // TODO: Validate the details of the options
+        // Initialize options with default values
         const defaultOptions = {
             id: getBuilderId(),
             name: userOptions.name,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/runtime",
-  "version": "1.0.0-canary.1",
+  "version": "1.0.0-canary.2",
   "author": "zhouxiao <codingzx@gmail.com>",
   "type": "commonjs",
   "main": "./index.cjs.js",
@@ -29,7 +29,7 @@
         "./helpers.cjs.d.ts"
       ],
       "type": [
-        "./types.cjs.d.ts"
+        "./type.cjs.d.ts"
       ]
     }
   },