@nx/module-federation 21.3.10 → 21.3.12

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nx/module-federation",
   "description": "The Nx Plugin for Module Federation contains executors and utilities that support building applications using Module Federation.",
-  "version": "21.3.10",
+  "version": "21.3.12",
   "type": "commonjs",
   "repository": {
     "type": "git",
@@ -25,9 +25,9 @@
   "executors": "./executors.json",
   "dependencies": {
     "tslib": "^2.3.0",
-    "@nx/devkit": "21.3.10",
-    "@nx/js": "21.3.10",
-    "@nx/web": "21.3.10",
+    "@nx/devkit": "21.3.12",
+    "@nx/js": "21.3.12",
+    "@nx/web": "21.3.12",
     "picocolors": "^1.1.0",
     "webpack": "^5.88.0",
     "@rspack/core": "^1.3.8",

package/src/executors/utils/start-remote-iterators.js

@@ -20,8 +20,8 @@ async function startRemoteIterators(options, context, startRemoteFn, pathToManif
     options.staticRemotesPort ??= remotes.staticRemotePort;
     // Set NX_MF_DEV_REMOTES for the Nx Runtime Library Control Plugin
     process.env.NX_MF_DEV_REMOTES = JSON.stringify([
-        ...(remotes.devRemotes.map((r) => typeof r === 'string' ? r : r.remoteName) ?? []).map((r) => r.replace(/-/g, '_')),
-        project.name.replace(/-/g, '_'),
+        ...(remotes.devRemotes.map((r) => typeof r === 'string' ? r : r.remoteName) ?? []).map((r) => (0, utils_1.normalizeProjectName)(r)),
+        (0, utils_1.normalizeProjectName)(project.name),
     ]);
     const staticRemotesConfig = isServer
         ? (0, utils_1.parseStaticSsrRemotesConfig)([...remotes.staticRemotes, ...remotes.dynamicRemotes], context)

package/src/plugins/nx-module-federation-plugin/angular/nx-module-federation-plugin.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NxModuleFederationPlugin = void 0;
 const utils_1 = require("../../../with-module-federation/angular/utils");
+const utils_2 = require("../../../utils");
 class NxModuleFederationPlugin {
     constructor(_options, configOverride) {
         this._options = _options;
@@ -43,7 +44,7 @@ class NxModuleFederationPlugin {
             runtimePlugins.push(require.resolve('@module-federation/node/runtimePlugin'));
         }
         new (require('@module-federation/enhanced/rspack').ModuleFederationPlugin)({
-            name: this._options.config.name.replace(/-/g, '_'),
+            name: (0, utils_2.normalizeProjectName)(this._options.config.name),
             filename: 'remoteEntry.js',
             exposes: this._options.config.exposes,
             remotes: mappedRemotes,

package/src/plugins/nx-module-federation-plugin/rspack/nx-module-federation-plugin.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NxModuleFederationPlugin = void 0;
 const utils_1 = require("../../../with-module-federation/rspack/utils");
+const utils_2 = require("../../../utils");
 class NxModuleFederationPlugin {
     constructor(_options, configOverride) {
         this._options = _options;
@@ -40,7 +41,7 @@ class NxModuleFederationPlugin {
             runtimePlugins.push(require.resolve('@module-federation/node/runtimePlugin'));
         }
         new (require('@module-federation/enhanced/rspack').ModuleFederationPlugin)({
-            name: this._options.config.name.replace(/-/g, '_'),
+            name: (0, utils_2.normalizeProjectName)(this._options.config.name),
             filename: 'remoteEntry.js',
             exposes: this._options.config.exposes,
             remotes: mappedRemotes,

package/src/utils/index.d.ts

@@ -3,6 +3,7 @@ export * from './dependencies';
 export * from './package-json';
 export * from './remotes';
 export * from './models';
+export * from './normalize-project-name';
 export * from './get-remotes-for-host';
 export * from './parse-static-remotes-config';
 export * from './start-remote-proxies';

package/src/utils/index.js

@@ -6,6 +6,7 @@ tslib_1.__exportStar(require("./dependencies"), exports);
 tslib_1.__exportStar(require("./package-json"), exports);
 tslib_1.__exportStar(require("./remotes"), exports);
 tslib_1.__exportStar(require("./models"), exports);
+tslib_1.__exportStar(require("./normalize-project-name"), exports);
 tslib_1.__exportStar(require("./get-remotes-for-host"), exports);
 tslib_1.__exportStar(require("./parse-static-remotes-config"), exports);
 tslib_1.__exportStar(require("./start-remote-proxies"), exports);

package/src/utils/normalize-project-name.d.ts

@@ -0,0 +1 @@
+export declare function normalizeProjectName(name: string): string;

package/src/utils/normalize-project-name.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeProjectName = normalizeProjectName;
+// normalize to allow only JavaScript var valid names
+function normalizeProjectName(name) {
+    // Replace invalid starting characters with '_'
+    const normalized = name.replace(/^[^a-zA-Z_$]/, '_');
+    // Replace invalid subsequent characters with '_'
+    return normalized.replace(/[^a-zA-Z0-9_$]/g, '_');
+}

package/src/utils/public-api.d.ts

@@ -1,6 +1,7 @@
 import { AdditionalSharedConfig, ModuleFederationConfig, ModuleFederationLibrary, NxModuleFederationConfigOverride, Remotes, SharedFunction, SharedLibraryConfig, SharedWorkspaceLibraryConfig, WorkspaceLibrary, WorkspaceLibrarySecondaryEntryPoint } from './models';
 import { applyAdditionalShared, applySharedFunction, getNpmPackageSharedConfig, sharePackages, shareWorkspaceLibraries } from './share';
+import { normalizeProjectName } from './normalize-project-name';
 import { mapRemotes, mapRemotesForSSR } from './remotes';
 import { getDependentPackagesForProject } from './dependencies';
 import { readRootPackageJson } from './package-json';
-export { ModuleFederationConfig, NxModuleFederationConfigOverride, SharedLibraryConfig, SharedWorkspaceLibraryConfig, AdditionalSharedConfig, WorkspaceLibrary, SharedFunction, WorkspaceLibrarySecondaryEntryPoint, Remotes, ModuleFederationLibrary, applySharedFunction, applyAdditionalShared, getNpmPackageSharedConfig, shareWorkspaceLibraries, sharePackages, mapRemotes, mapRemotesForSSR, getDependentPackagesForProject, readRootPackageJson, };
+export { ModuleFederationConfig, NxModuleFederationConfigOverride, SharedLibraryConfig, SharedWorkspaceLibraryConfig, AdditionalSharedConfig, WorkspaceLibrary, SharedFunction, WorkspaceLibrarySecondaryEntryPoint, Remotes, ModuleFederationLibrary, applySharedFunction, applyAdditionalShared, getNpmPackageSharedConfig, shareWorkspaceLibraries, sharePackages, mapRemotes, mapRemotesForSSR, normalizeProjectName, getDependentPackagesForProject, readRootPackageJson, };

package/src/utils/public-api.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readRootPackageJson = exports.getDependentPackagesForProject = exports.mapRemotesForSSR = exports.mapRemotes = exports.sharePackages = exports.shareWorkspaceLibraries = exports.getNpmPackageSharedConfig = exports.applyAdditionalShared = exports.applySharedFunction = void 0;
+exports.readRootPackageJson = exports.getDependentPackagesForProject = exports.normalizeProjectName = exports.mapRemotesForSSR = exports.mapRemotes = exports.sharePackages = exports.shareWorkspaceLibraries = exports.getNpmPackageSharedConfig = exports.applyAdditionalShared = exports.applySharedFunction = void 0;
 const share_1 = require("./share");
 Object.defineProperty(exports, "applyAdditionalShared", { enumerable: true, get: function () { return share_1.applyAdditionalShared; } });
 Object.defineProperty(exports, "applySharedFunction", { enumerable: true, get: function () { return share_1.applySharedFunction; } });
 Object.defineProperty(exports, "getNpmPackageSharedConfig", { enumerable: true, get: function () { return share_1.getNpmPackageSharedConfig; } });
 Object.defineProperty(exports, "sharePackages", { enumerable: true, get: function () { return share_1.sharePackages; } });
 Object.defineProperty(exports, "shareWorkspaceLibraries", { enumerable: true, get: function () { return share_1.shareWorkspaceLibraries; } });
+const normalize_project_name_1 = require("./normalize-project-name");
+Object.defineProperty(exports, "normalizeProjectName", { enumerable: true, get: function () { return normalize_project_name_1.normalizeProjectName; } });
 const remotes_1 = require("./remotes");
 Object.defineProperty(exports, "mapRemotes", { enumerable: true, get: function () { return remotes_1.mapRemotes; } });
 Object.defineProperty(exports, "mapRemotesForSSR", { enumerable: true, get: function () { return remotes_1.mapRemotesForSSR; } });

package/src/utils/remotes.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapRemotes = mapRemotes;
 exports.mapRemotesForSSR = mapRemotesForSSR;
 const url_helpers_1 = require("./url-helpers");
+const normalize_project_name_1 = require("./normalize-project-name");
 /**
  * Map remote names to a format that can be understood and used by Module
  * Federation.
@@ -15,12 +16,11 @@ function mapRemotes(remotes, remoteEntryExt, determineRemoteUrl, isRemoteGlobal
     const mappedRemotes = {};
     for (const nxRemoteProjectName of remotes) {
         if (Array.isArray(nxRemoteProjectName)) {
-            const mfRemoteName = normalizeRemoteName(nxRemoteProjectName[0]);
+            const mfRemoteName = nxRemoteProjectName[0];
             mappedRemotes[mfRemoteName] = handleArrayRemote(nxRemoteProjectName, remoteEntryExt, isRemoteGlobal);
         }
         else if (typeof nxRemoteProjectName === 'string') {
-            const mfRemoteName = normalizeRemoteName(nxRemoteProjectName);
-            mappedRemotes[mfRemoteName] = handleStringRemote(nxRemoteProjectName, determineRemoteUrl, isRemoteGlobal);
+            mappedRemotes[nxRemoteProjectName] = handleStringRemote(nxRemoteProjectName, determineRemoteUrl, isRemoteGlobal);
         }
     }
     return mappedRemotes;
@@ -28,7 +28,7 @@ function mapRemotes(remotes, remoteEntryExt, determineRemoteUrl, isRemoteGlobal
 // Helper function to deal with remotes that are arrays
 function handleArrayRemote(remote, remoteEntryExt, isRemoteGlobal) {
     const [nxRemoteProjectName, remoteLocation] = remote;
-    const mfRemoteName = normalizeRemoteName(nxRemoteProjectName);
+    const mfRemoteName = (0, normalize_project_name_1.normalizeProjectName)(nxRemoteProjectName);
     const finalRemoteUrl = (0, url_helpers_1.processRemoteLocation)(remoteLocation, remoteEntryExt);
     // Promise-based remotes should not use the global prefix format
     if (remoteLocation.startsWith('promise new Promise')) {
@@ -39,7 +39,7 @@ function handleArrayRemote(remote, remoteEntryExt, isRemoteGlobal) {
 // Helper function to deal with remotes that are strings
 function handleStringRemote(nxRemoteProjectName, determineRemoteUrl, isRemoteGlobal) {
     const globalPrefix = isRemoteGlobal
-        ? `${normalizeRemoteName(nxRemoteProjectName)}@`
+        ? `${(0, normalize_project_name_1.normalizeProjectName)(nxRemoteProjectName)}@`
         : '';
     return `${globalPrefix}${determineRemoteUrl(nxRemoteProjectName)}`;
 }
@@ -56,7 +56,7 @@ function mapRemotesForSSR(remotes, remoteEntryExt, determineRemoteUrl) {
     for (const remote of remotes) {
         if (Array.isArray(remote)) {
             let [nxRemoteProjectName, remoteLocation] = remote;
-            const mfRemoteName = normalizeRemoteName(nxRemoteProjectName);
+            const mfRemoteName = (0, normalize_project_name_1.normalizeProjectName)(nxRemoteProjectName);
             const finalRemoteUrl = (0, url_helpers_1.processRemoteLocation)(remoteLocation, remoteEntryExt);
             // Promise-based remotes should not use the global prefix format
             if (remoteLocation.startsWith('promise new Promise')) {
@@ -67,12 +67,9 @@ function mapRemotesForSSR(remotes, remoteEntryExt, determineRemoteUrl) {
             }
         }
         else if (typeof remote === 'string') {
-            const mfRemoteName = normalizeRemoteName(remote);
-            mappedRemotes[mfRemoteName] = `${mfRemoteName}@${determineRemoteUrl(remote)}`;
+            const mfRemoteName = (0, normalize_project_name_1.normalizeProjectName)(remote);
+            mappedRemotes[remote] = `${mfRemoteName}@${determineRemoteUrl(remote)}`;
         }
     }
     return mappedRemotes;
 }
-function normalizeRemoteName(remote) {
-    return remote.replace(/-/g, '_');
-}

package/src/with-module-federation/angular/with-module-federation-ssr.d.ts

@@ -1,2 +1,2 @@
-import type { ModuleFederationConfig, NxModuleFederationConfigOverride } from '../../utils';
+import { type ModuleFederationConfig, type NxModuleFederationConfigOverride } from '../../utils';
 export declare function withModuleFederationForSSR(options: ModuleFederationConfig, configOverride?: NxModuleFederationConfigOverride): Promise<(config: any) => any>;

package/src/with-module-federation/angular/with-module-federation-ssr.js

@@ -1,13 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withModuleFederationForSSR = withModuleFederationForSSR;
-const utils_1 = require("./utils");
+const utils_1 = require("../../utils");
+const utils_2 = require("./utils");
 async function withModuleFederationForSSR(options, configOverride) {
     if (global.NX_GRAPH_CREATION) {
         return (config) => config;
     }
     const isDevServer = process.env['WEBPACK_SERVE'];
-    const { sharedLibraries, sharedDependencies, mappedRemotes } = await (0, utils_1.getModuleFederationConfig)(options, {
+    const { sharedLibraries, sharedDependencies, mappedRemotes } = await (0, utils_2.getModuleFederationConfig)(options, {
         isServer: true,
     });
     return (config) => {
@@ -34,7 +35,7 @@ async function withModuleFederationForSSR(options, configOverride) {
             plugins: [
                 ...(config.plugins ?? []),
                 new (require('@module-federation/enhanced').ModuleFederationPlugin)({
-                    name: options.name.replace(/-/g, '_'),
+                    name: (0, utils_1.normalizeProjectName)(options.name),
                     filename: 'remoteEntry.js',
                     exposes: options.exposes,
                     remotes: mappedRemotes,

package/src/with-module-federation/angular/with-module-federation.d.ts

@@ -1,2 +1,2 @@
-import type { ModuleFederationConfig, NxModuleFederationConfigOverride } from '../../utils';
+import { type ModuleFederationConfig, type NxModuleFederationConfigOverride } from '../../utils';
 export declare function withModuleFederation(options: ModuleFederationConfig, configOverride?: NxModuleFederationConfigOverride): Promise<(config: any) => any>;

package/src/with-module-federation/angular/with-module-federation.js

@@ -1,14 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withModuleFederation = withModuleFederation;
-const utils_1 = require("./utils");
+const utils_1 = require("../../utils");
+const utils_2 = require("./utils");
 const webpack_1 = require("@module-federation/enhanced/webpack");
 async function withModuleFederation(options, configOverride) {
     if (global.NX_GRAPH_CREATION) {
         return (config) => config;
     }
     const isDevServer = process.env['WEBPACK_SERVE'];
-    const { sharedLibraries, sharedDependencies, mappedRemotes } = await (0, utils_1.getModuleFederationConfig)(options);
+    const { sharedLibraries, sharedDependencies, mappedRemotes } = await (0, utils_2.getModuleFederationConfig)(options);
     return (config) => {
         const updatedConfig = {
             ...(config ?? {}),
@@ -37,7 +38,7 @@ async function withModuleFederation(options, configOverride) {
             plugins: [
                 ...(config.plugins ?? []),
                 new webpack_1.ModuleFederationPlugin({
-                    name: options.name.replace(/-/g, '_'),
+                    name: (0, utils_1.normalizeProjectName)(options.name),
                     filename: 'remoteEntry.mjs',
                     exposes: options.exposes,
                     remotes: mappedRemotes,

package/src/with-module-federation/rspack/with-module-federation-ssr.js

@@ -2,13 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withModuleFederationForSSR = withModuleFederationForSSR;
 const core_1 = require("@rspack/core");
-const utils_1 = require("./utils");
+const utils_1 = require("../../utils");
+const utils_2 = require("./utils");
 async function withModuleFederationForSSR(options, configOverride) {
     if (global.NX_GRAPH_CREATION) {
         return (config) => config;
     }
     const isDevServer = process.env['WEBPACK_SERVE'];
-    const { sharedLibraries, sharedDependencies, mappedRemotes } = (0, utils_1.getModuleFederationConfig)(options, {
+    const { sharedLibraries, sharedDependencies, mappedRemotes } = (0, utils_2.getModuleFederationConfig)(options, {
         isServer: true,
     });
     return (config, { context }) => {
@@ -26,7 +27,7 @@ async function withModuleFederationForSSR(options, configOverride) {
         config.plugins.push(
         // eslint-disable-next-line @typescript-eslint/no-var-requires
         new (require('@module-federation/enhanced/rspack').ModuleFederationPlugin)({
-            name: options.name.replace(/-/g, '_'),
+            name: (0, utils_1.normalizeProjectName)(options.name),
             filename: 'remoteEntry.js',
             exposes: options.exposes,
             remotes: mappedRemotes,

package/src/with-module-federation/rspack/with-module-federation.js

@@ -3,7 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.withModuleFederation = withModuleFederation;
 const rspack_1 = require("@module-federation/enhanced/rspack");
 const core_1 = require("@rspack/core");
-const utils_1 = require("./utils");
+const utils_1 = require("../../utils");
+const utils_2 = require("./utils");
 const isVarOrWindow = (libType) => libType === 'var' || libType === 'window';
 /**
  * @param {ModuleFederationConfig} options
@@ -16,7 +17,7 @@ async function withModuleFederation(options, configOverride) {
         };
     }
     const isDevServer = process.env['WEBPACK_SERVE'];
-    const { sharedDependencies, sharedLibraries, mappedRemotes } = (0, utils_1.getModuleFederationConfig)(options);
+    const { sharedDependencies, sharedLibraries, mappedRemotes } = (0, utils_2.getModuleFederationConfig)(options);
     const isGlobal = isVarOrWindow(options.library?.type);
     return function makeConfig(config, { context }) {
         config.output.uniqueName = options.name;
@@ -36,7 +37,7 @@ async function withModuleFederation(options, configOverride) {
             config.optimization.runtimeChunk = 'single';
         }
         config.plugins.push(new rspack_1.ModuleFederationPlugin({
-            name: options.name.replace(/-/g, '_'),
+            name: (0, utils_1.normalizeProjectName)(options.name),
             filename: 'remoteEntry.js',
             exposes: options.exposes,
             remotes: mappedRemotes,

package/src/with-module-federation/webpack/with-module-federation-ssr.js

@@ -1,13 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withModuleFederationForSSR = withModuleFederationForSSR;
-const utils_1 = require("./utils");
+const utils_1 = require("../../utils");
+const utils_2 = require("./utils");
 async function withModuleFederationForSSR(options, configOverride) {
     if (global.NX_GRAPH_CREATION) {
         return (config) => config;
     }
     const isDevServer = process.env['WEBPACK_SERVE'];
-    const { sharedLibraries, sharedDependencies, mappedRemotes } = await (0, utils_1.getModuleFederationConfig)(options, {
+    const { sharedLibraries, sharedDependencies, mappedRemotes } = await (0, utils_2.getModuleFederationConfig)(options, {
         isServer: true,
     });
     return (config) => {
@@ -20,7 +21,7 @@ async function withModuleFederationForSSR(options, configOverride) {
                 : false,
         };
         config.plugins.push(new (require('@module-federation/enhanced').ModuleFederationPlugin)({
-            name: options.name.replace(/-/g, '_'),
+            name: (0, utils_1.normalizeProjectName)(options.name),
             filename: 'remoteEntry.js',
             exposes: options.exposes,
             remotes: mappedRemotes,

package/src/with-module-federation/webpack/with-module-federation.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withModuleFederation = withModuleFederation;
-const utils_1 = require("./utils");
+const utils_1 = require("../../utils");
+const utils_2 = require("./utils");
 const webpack_1 = require("@module-federation/enhanced/webpack");
 /**
  * @param {ModuleFederationConfig} options
@@ -11,7 +12,7 @@ async function withModuleFederation(options, configOverride) {
         return (config) => config;
     }
     const isDevServer = process.env['WEBPACK_SERVE'];
-    const { sharedDependencies, sharedLibraries, mappedRemotes } = await (0, utils_1.getModuleFederationConfig)(options);
+    const { sharedDependencies, sharedLibraries, mappedRemotes } = await (0, utils_2.getModuleFederationConfig)(options);
     return (config, ctx) => {
         config.output.uniqueName = options.name;
         config.output.publicPath = 'auto';
@@ -28,7 +29,7 @@ async function withModuleFederation(options, configOverride) {
             config.optimization.runtimeChunk = 'single';
         }
         config.plugins.push(new webpack_1.ModuleFederationPlugin({
-            name: options.name.replace(/-/g, '_'),
+            name: (0, utils_1.normalizeProjectName)(options.name),
             filename: 'remoteEntry.js',
             exposes: options.exposes,
             remotes: mappedRemotes,