@nx/module-federation 24.0.0-beta.2 → 24.0.0-beta.4

package/dist/src/utils/port-utils.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isPortInUse = isPortInUse;
-const net_1 = require("net");
-/**
- * Check if a port is in use by attempting to bind to it. Binding is local and
- * resolves immediately, so unlike a connection-based check it never stalls on
- * the OS TCP connect timeout when `localhost` resolves to an unreachable address
- * (e.g. IPv6 `::1`) -- the cause of the `nx serve` hang in #33909.
- */
-function isPortInUse(port, host = 'localhost') {
-    return new Promise((resolve) => {
-        const server = (0, net_1.createServer)();
-        server.once('error', (err) => {
-            resolve(err.code === 'EADDRINUSE');
-        });
-        server.once('listening', () => {
-            server.close(() => resolve(false));
-        });
-        server.listen(port, host);
-    });
-}

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

@@ -1,7 +0,0 @@
-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, normalizeProjectName, getDependentPackagesForProject, readRootPackageJson, };

package/dist/src/utils/public-api.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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; } });
-const dependencies_1 = require("./dependencies");
-Object.defineProperty(exports, "getDependentPackagesForProject", { enumerable: true, get: function () { return dependencies_1.getDependentPackagesForProject; } });
-const package_json_1 = require("./package-json");
-Object.defineProperty(exports, "readRootPackageJson", { enumerable: true, get: function () { return package_json_1.readRootPackageJson; } });

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

@@ -1,19 +0,0 @@
-import { Remotes } from './models';
-/**
- * Map remote names to a format that can be understood and used by Module
- * Federation.
- *
- * @param remotes - The remotes to map
- * @param remoteEntryExt - The file extension of the remoteEntry file
- * @param determineRemoteUrl - The function used to lookup the URL of the served remote
- */
-export declare function mapRemotes(remotes: Remotes, remoteEntryExt: 'js' | 'mjs', determineRemoteUrl: (remote: string) => string, isRemoteGlobal?: boolean): Record<string, string>;
-/**
- * Map remote names to a format that can be understood and used by Module
- * Federation.
- *
- * @param remotes - The remotes to map
- * @param remoteEntryExt - The file extension of the remoteEntry file
- * @param determineRemoteUrl - The function used to lookup the URL of the served remote
- */
-export declare function mapRemotesForSSR(remotes: Remotes, remoteEntryExt: 'js' | 'mjs', determineRemoteUrl: (remote: string) => string): Record<string, string>;

package/dist/src/utils/remotes.js

@@ -1,75 +0,0 @@
-"use strict";
-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.
- *
- * @param remotes - The remotes to map
- * @param remoteEntryExt - The file extension of the remoteEntry file
- * @param determineRemoteUrl - The function used to lookup the URL of the served remote
- */
-function mapRemotes(remotes, remoteEntryExt, determineRemoteUrl, isRemoteGlobal = false) {
-    const mappedRemotes = {};
-    for (const nxRemoteProjectName of remotes) {
-        if (Array.isArray(nxRemoteProjectName)) {
-            const mfRemoteName = nxRemoteProjectName[0];
-            mappedRemotes[mfRemoteName] = handleArrayRemote(nxRemoteProjectName, remoteEntryExt, isRemoteGlobal);
-        }
-        else if (typeof nxRemoteProjectName === 'string') {
-            mappedRemotes[nxRemoteProjectName] = handleStringRemote(nxRemoteProjectName, determineRemoteUrl, isRemoteGlobal);
-        }
-    }
-    return mappedRemotes;
-}
-// Helper function to deal with remotes that are arrays
-function handleArrayRemote(remote, remoteEntryExt, isRemoteGlobal) {
-    const [nxRemoteProjectName, remoteLocation] = remote;
-    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')) {
-        return finalRemoteUrl;
-    }
-    return isRemoteGlobal ? `${mfRemoteName}@${finalRemoteUrl}` : finalRemoteUrl;
-}
-// Helper function to deal with remotes that are strings
-function handleStringRemote(nxRemoteProjectName, determineRemoteUrl, isRemoteGlobal) {
-    const globalPrefix = isRemoteGlobal
-        ? `${(0, normalize_project_name_1.normalizeProjectName)(nxRemoteProjectName)}@`
-        : '';
-    return `${globalPrefix}${determineRemoteUrl(nxRemoteProjectName)}`;
-}
-/**
- * Map remote names to a format that can be understood and used by Module
- * Federation.
- *
- * @param remotes - The remotes to map
- * @param remoteEntryExt - The file extension of the remoteEntry file
- * @param determineRemoteUrl - The function used to lookup the URL of the served remote
- */
-function mapRemotesForSSR(remotes, remoteEntryExt, determineRemoteUrl) {
-    const mappedRemotes = {};
-    for (const remote of remotes) {
-        if (Array.isArray(remote)) {
-            let [nxRemoteProjectName, remoteLocation] = remote;
-            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')) {
-                mappedRemotes[mfRemoteName] = finalRemoteUrl;
-            }
-            else {
-                mappedRemotes[mfRemoteName] = `${mfRemoteName}@${finalRemoteUrl}`;
-            }
-        }
-        else if (typeof remote === 'string') {
-            const mfRemoteName = (0, normalize_project_name_1.normalizeProjectName)(remote);
-            mappedRemotes[remote] = `${mfRemoteName}@${determineRemoteUrl(remote)}`;
-        }
-    }
-    return mappedRemotes;
-}

package/dist/src/utils/rspack-version.d.ts

@@ -1,3 +0,0 @@
-import type { Compiler } from '@rspack/core';
-export declare function getRspackMajorVersion(compiler: Compiler): number;
-export declare function isRspackV2(compiler: Compiler): boolean;

package/dist/src/utils/rspack-version.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRspackMajorVersion = getRspackMajorVersion;
-exports.isRspackV2 = isRspackV2;
-// Read from compiler.rspack to avoid a value import of the (pure-ESM) v2 package.
-function getRspackMajorVersion(compiler) {
-    return parseInt(compiler.rspack.rspackVersion ?? '1', 10);
-}
-function isRspackV2(compiler) {
-    return getRspackMajorVersion(compiler) >= 2;
-}

package/dist/src/utils/secondary-entry-points.d.ts

@@ -1,12 +0,0 @@
-import type { WorkspaceLibrary } from './models';
-import { WorkspaceLibrarySecondaryEntryPoint } from './models';
-export declare function collectWorkspaceLibrarySecondaryEntryPoints(library: WorkspaceLibrary, tsconfigPathAliases: Record<string, string[]>): WorkspaceLibrarySecondaryEntryPoint[];
-export declare function getNonNodeModulesSubDirs(directory: string): string[];
-export declare function recursivelyCollectSecondaryEntryPointsFromDirectory(pkgName: string, pkgVersion: string, pkgRoot: string, mainEntryPointExports: any | undefined, directories: string[], collectedPackages: {
-    name: string;
-    version: string;
-}[]): void;
-export declare function collectPackageSecondaryEntryPoints(pkgName: string, pkgVersion: string, collectedPackages: {
-    name: string;
-    version: string;
-}[]): void;

package/dist/src/utils/secondary-entry-points.js

@@ -1,125 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.collectWorkspaceLibrarySecondaryEntryPoints = collectWorkspaceLibrarySecondaryEntryPoints;
-exports.getNonNodeModulesSubDirs = getNonNodeModulesSubDirs;
-exports.recursivelyCollectSecondaryEntryPointsFromDirectory = recursivelyCollectSecondaryEntryPointsFromDirectory;
-exports.collectPackageSecondaryEntryPoints = collectPackageSecondaryEntryPoints;
-const path_1 = require("path");
-const fs_1 = require("fs");
-const devkit_1 = require("@nx/devkit");
-const internal_1 = require("@nx/devkit/internal");
-function collectWorkspaceLibrarySecondaryEntryPoints(library, tsconfigPathAliases) {
-    const libraryRoot = (0, path_1.join)(devkit_1.workspaceRoot, library.root);
-    const needsSecondaryEntryPointsCollected = (0, fs_1.existsSync)((0, path_1.join)(libraryRoot, 'ng-package.json'));
-    const secondaryEntryPoints = [];
-    if (needsSecondaryEntryPointsCollected) {
-        const tsConfigAliasesForLibWithSecondaryEntryPoints = Object.entries(tsconfigPathAliases).reduce((acc, [tsKey, tsPaths]) => {
-            if (!tsKey.startsWith(library.importKey)) {
-                return { ...acc };
-            }
-            if (tsPaths.some((path) => path.startsWith(`${library.root}/`))) {
-                acc = { ...acc, [tsKey]: tsPaths };
-            }
-            return acc;
-        }, {});
-        for (const [alias] of Object.entries(tsConfigAliasesForLibWithSecondaryEntryPoints)) {
-            const pathToLib = (0, path_1.dirname)((0, path_1.join)(devkit_1.workspaceRoot, tsconfigPathAliases[alias][0]));
-            let searchDir = pathToLib;
-            while (searchDir !== libraryRoot) {
-                if ((0, fs_1.existsSync)((0, path_1.join)(searchDir, 'ng-package.json'))) {
-                    secondaryEntryPoints.push({ name: alias, path: pathToLib });
-                    break;
-                }
-                searchDir = (0, path_1.dirname)(searchDir);
-            }
-        }
-    }
-    return secondaryEntryPoints;
-}
-function getNonNodeModulesSubDirs(directory) {
-    return (0, fs_1.readdirSync)(directory)
-        .filter((file) => file !== 'node_modules')
-        .map((file) => (0, path_1.join)(directory, file))
-        .filter((file) => (0, fs_1.lstatSync)(file).isDirectory());
-}
-function recursivelyCollectSecondaryEntryPointsFromDirectory(pkgName, pkgVersion, pkgRoot, mainEntryPointExports, directories, collectedPackages) {
-    for (const directory of directories) {
-        const packageJsonPath = (0, path_1.join)(directory, 'package.json');
-        const relativeEntryPointPath = (0, path_1.relative)(pkgRoot, directory);
-        const entryPointName = (0, devkit_1.joinPathFragments)(pkgName, relativeEntryPointPath);
-        if ((0, fs_1.existsSync)(packageJsonPath)) {
-            try {
-                // require the secondary entry point to try to rule out sample code
-                require.resolve(entryPointName, { paths: [devkit_1.workspaceRoot] });
-                const { name } = (0, devkit_1.readJsonFile)(packageJsonPath);
-                // further check to make sure what we were able to require is the
-                // same as the package name
-                if (name === entryPointName) {
-                    collectedPackages.push({ name, version: pkgVersion });
-                }
-            }
-            catch { }
-        }
-        else if (mainEntryPointExports) {
-            // if the package.json doesn't exist, check if the directory is
-            // exported by the main entry point
-            const entryPointExportKey = `./${relativeEntryPointPath}`;
-            const entryPointInfo = mainEntryPointExports[entryPointExportKey];
-            if (entryPointInfo) {
-                collectedPackages.push({
-                    name: entryPointName,
-                    version: pkgVersion,
-                });
-            }
-        }
-        const subDirs = getNonNodeModulesSubDirs(directory);
-        recursivelyCollectSecondaryEntryPointsFromDirectory(pkgName, pkgVersion, pkgRoot, mainEntryPointExports, subDirs, collectedPackages);
-    }
-}
-function collectPackagesFromExports(pkgName, pkgVersion, exports, collectedPackages) {
-    for (const [relativeEntryPoint, exportOptions] of Object.entries(exports)) {
-        const defaultExportOptions = typeof exportOptions?.['default'] === 'string'
-            ? exportOptions?.['default']
-            : exportOptions?.['default']?.['default'];
-        if (defaultExportOptions?.search(/\.(js|mjs|cjs)$/)) {
-            let entryPointName = (0, devkit_1.joinPathFragments)(pkgName, relativeEntryPoint);
-            if (entryPointName.endsWith('.json')) {
-                entryPointName = (0, path_1.dirname)(entryPointName);
-            }
-            if (entryPointName === '.') {
-                continue;
-            }
-            if (collectedPackages.find((p) => p.name === entryPointName)) {
-                continue;
-            }
-            collectedPackages.push({ name: entryPointName, version: pkgVersion });
-        }
-    }
-}
-function collectPackageSecondaryEntryPoints(pkgName, pkgVersion, collectedPackages) {
-    let pathToPackage;
-    let packageJsonPath;
-    let packageJson;
-    try {
-        ({ path: packageJsonPath, packageJson } = (0, internal_1.readModulePackageJson)(pkgName));
-        pathToPackage = (0, path_1.dirname)(packageJsonPath);
-    }
-    catch {
-        // the package.json might not resolve if the package has the "exports"
-        // entry and is not exporting the package.json file, fall back to trying
-        // to find it from the top-level node_modules
-        pathToPackage = (0, path_1.join)(devkit_1.workspaceRoot, 'node_modules', pkgName);
-        packageJsonPath = (0, path_1.join)(pathToPackage, 'package.json');
-        if (!(0, fs_1.existsSync)(packageJsonPath)) {
-            // might not exist if it's nested in another package, just return here
-            return;
-        }
-        packageJson = (0, devkit_1.readJsonFile)(packageJsonPath);
-    }
-    const { exports } = packageJson;
-    if (exports) {
-        collectPackagesFromExports(pkgName, pkgVersion, exports, collectedPackages);
-    }
-    const subDirs = getNonNodeModulesSubDirs(pathToPackage);
-    recursivelyCollectSecondaryEntryPointsFromDirectory(pkgName, pkgVersion, pathToPackage, exports, subDirs, collectedPackages);
-}

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

@@ -1,58 +0,0 @@
-import type { SharedLibraryConfig, SharedWorkspaceLibraryConfig, WorkspaceLibrary } from './models';
-import { AdditionalSharedConfig, SharedFunction } from './models';
-import { type ProjectGraph } from '@nx/devkit';
-/**
- * Build an object of functions to be used with the ModuleFederationPlugin to
- * share Nx Workspace Libraries between Hosts and Remotes.
- *
- * @param workspaceLibs - The Nx Workspace Libraries to share
- * @param tsConfigPath - The path to TS Config File that contains the Path Mappings for the Libraries
- * @param bundler - The bundler to use for the replacement plugin
- */
-export declare function shareWorkspaceLibraries(workspaceLibs: WorkspaceLibrary[], tsConfigPath?: string, bundler?: 'rspack' | 'webpack'): SharedWorkspaceLibraryConfig;
-/**
- * Build the Module Federation Share Config for a specific package and the
- * specified version of that package.
- * @param pkgName - Name of the package to share
- * @param version - Version of the package to require by other apps in the Module Federation setup
- */
-export declare function getNpmPackageSharedConfig(pkgName: string, version: string): SharedLibraryConfig | undefined;
-/**
- * Narrow a list of package names down to those with a version declared in the
- * root package.json.
- *
- * Version resolution matches {@link sharePackages}, so a package kept here never
- * trips the missing-version warning in {@link getNpmPackageSharedConfig}.
- * @param packages - Array of package names as strings
- */
-export declare function filterPackagesDeclaredInRootPackageJson(packages: string[]): string[];
-/**
- * Create a dictionary of packages and their Module Federation Shared Config
- * from an array of package names.
- *
- * Lookup the versions of the packages from the root package.json file in the
- * workspace.
- * @param packages - Array of package names as strings
- */
-export declare function sharePackages(packages: string[]): Record<string, SharedLibraryConfig>;
-/**
- * Apply a custom function provided by the user that will modify the Shared Config
- * of the dependencies for the Module Federation build.
- *
- * @param sharedConfig - The original Shared Config to be modified
- * @param sharedFn - The custom function to run
- */
-export declare function applySharedFunction(sharedConfig: Record<string, SharedLibraryConfig>, sharedFn: SharedFunction | undefined): void;
-/**
- * Add additional dependencies to the shared package that may not have been
- * discovered by the project graph.
- *
- * This can be useful for applications that use a Dependency Injection system
- * that expects certain Singleton values to be present in the shared injection
- * hierarchy.
- *
- * @param sharedConfig - The original Shared Config
- * @param additionalShared - The additional dependencies to add
- * @param projectGraph - The Nx project graph
- */
-export declare function applyAdditionalShared(sharedConfig: Record<string, SharedLibraryConfig>, additionalShared: AdditionalSharedConfig | undefined, projectGraph: ProjectGraph): void;