@softarc/native-federation 4.1.3 → 4.2.0

package/package.json

@@ -1,43 +1,66 @@
 {
   "name": "@softarc/native-federation",
-  "version": "4.1.3",
+  "version": "4.2.0",
   "type": "module",
   "license": "MIT",
+  "scripts": {
+    "build": "node esbuild.config.mjs && tsc -p tsconfig.build.json",
+    "lint": "eslint src",
+    "typecheck": "tsc -p tsconfig.build.json --noEmit",
+    "knip": "knip",
+    "test": "vitest"
+  },
   "dependencies": {
     "@softarc/sheriff-core": "^0.19.6",
     "chalk": "^5.6.2",
+    "esbuild": "^0.28.0",
     "fast-glob": "^3.3.3",
-    "json5": "^2.2.3",
-    "esbuild": "^0.28.0"
+    "json5": "^2.2.3"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@types/node": "~24.13.0",
+    "@vitest/coverage-v8": "^4.0.0",
+    "@vitest/ui": "^4.0.0",
+    "eslint": "^10.4.1",
+    "globals": "^17.3.0",
+    "jiti": "^2.6.1",
+    "jsdom": "^29.0.0",
+    "knip": "^6.16.1",
+    "prettier": "^3.8.1",
+    "tslib": "^2.3.0",
+    "typescript": "~6.0.0",
+    "typescript-eslint": "^8.61.0",
+    "vite": "^8.0.0",
+    "vitest": "^4.0.0"
   },
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./src/index.d.ts",
-      "import": "./src/index.js",
-      "default": "./src/index.js"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
     },
     "./config": {
-      "types": "./src/config.d.ts",
-      "import": "./src/config.js",
-      "default": "./src/config.js"
+      "types": "./dist/config.d.ts",
+      "import": "./dist/config.js",
+      "default": "./dist/config.js"
     },
     "./domain": {
-      "types": "./src/domain.d.ts",
-      "import": "./src/domain.js",
-      "default": "./src/domain.js"
+      "types": "./dist/domain.d.ts",
+      "import": "./dist/domain.js",
+      "default": "./dist/domain.js"
     },
     "./internal": {
-      "types": "./src/internal.d.ts",
-      "import": "./src/internal.js",
-      "default": "./src/internal.js"
+      "types": "./dist/internal.d.ts",
+      "import": "./dist/internal.js",
+      "default": "./dist/internal.js"
     }
   },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
-    "src",
-    "!**/*.tsbuildinfo"
-  ],
-  "types": "./src/index.d.ts",
-  "module": "./src/index.js",
-  "main": "./src/index.js"
-}
+    "dist"
+  ]
+}

package/src/config.js

@@ -1,4 +0,0 @@
-export * from './lib/domain/config/index.js';
-export { withNativeFederation } from './lib/config/with-native-federation.js';
-export { findRootTsConfigJson, share, shareAll, setInferVersion, } from './lib/config/share-utils.js';
-export { DEFAULT_SKIP_LIST } from './lib/config/default-skip-list.js';

package/src/domain.js

@@ -1,2 +0,0 @@
-export * from './lib/domain/config/index.js';
-export * from './lib/domain/core/index.js';

package/src/index.d.ts

@@ -1,10 +0,0 @@
-export { setBuildAdapter } from './lib/core/build-adapter.js';
-export { buildForFederation } from './lib/core/build-for-federation.js';
-export { rebuildForFederation } from './lib/core/rebuild-for-federation.js';
-export { createFederationCache } from './lib/core/federation-cache.js';
-export { bundleExposedAndMappings } from './lib/core/bundle-exposed-and-mappings.js';
-export { getExternals } from './lib/core/get-externals.js';
-export { normalizeFederationOptions } from './lib/core/normalize-options.js';
-export { writeFederationInfo } from './lib/core/write-federation-info.js';
-export { type BuildHelperParams, federationBuilder } from './lib/core/federation-builder.js';
-export * from './domain.js';

package/src/index.js

@@ -1,10 +0,0 @@
-export { setBuildAdapter } from './lib/core/build-adapter.js';
-export { buildForFederation } from './lib/core/build-for-federation.js';
-export { rebuildForFederation } from './lib/core/rebuild-for-federation.js';
-export { createFederationCache } from './lib/core/federation-cache.js';
-export { bundleExposedAndMappings } from './lib/core/bundle-exposed-and-mappings.js';
-export { getExternals } from './lib/core/get-externals.js';
-export { normalizeFederationOptions } from './lib/core/normalize-options.js';
-export { writeFederationInfo } from './lib/core/write-federation-info.js';
-export { federationBuilder } from './lib/core/federation-builder.js';
-export * from './domain.js';

package/src/internal.js

@@ -1,11 +0,0 @@
-export * from './lib/utils/build-result-map.js';
-export { hashFile } from './lib/utils/hash-file.js';
-export * from './lib/utils/errors.js';
-export { logger, setLogLevel } from './lib/utils/logger.js';
-export { RebuildQueue } from './lib/utils/rebuild-queue.js';
-export { AbortedError } from './lib/utils/errors.js';
-export { createBuildResultMap, lookupInResultMap, popFromResultMap, } from './lib/utils/build-result-map.js';
-export { writeImportMap } from './lib/core/write-import-map.js';
-export { getDefaultCachePath, getChecksum } from './lib/utils/cache-persistence.js';
-export { isInSkipList, prepareSkipList } from './lib/config/default-skip-list.js';
-export { syncNfFileWatcher, createNfWatcher } from './lib/utils/file-watcher.js';

package/src/lib/config/configuration-context.js

@@ -1,10 +0,0 @@
-let _context = {};
-export function useWorkspace(workspaceRoot) {
-    _context = { ..._context, workspaceRoot };
-}
-export function usePackageJson(packageJson) {
-    _context = { ..._context, packageJson };
-}
-export function getConfigContext() {
-    return _context;
-}

package/src/lib/config/default-skip-list.js

@@ -1,31 +0,0 @@
-export const DEFAULT_SKIP_LIST = [
-    '@softarc/native-federation',
-    '@softarc/native-federation-core',
-    '@softarc/native-federation-node',
-    '@softarc/native-federation-esbuild',
-    '@softarc/native-federation-runtime',
-    '@softarc/native-federation-orchestrator',
-    'vanilla-native-federation',
-    'es-module-shims',
-    'tslib/',
-    pkg => pkg.startsWith('@types/'),
-];
-export function prepareSkipList(skipList) {
-    return {
-        strings: new Set(skipList.filter(e => typeof e === 'string')),
-        functions: skipList.filter(e => typeof e === 'function'),
-        regexps: skipList.filter(e => typeof e === 'object'),
-    };
-}
-export function isInSkipList(entry, skipList) {
-    if (skipList.strings.has(entry)) {
-        return true;
-    }
-    if (skipList.functions.find(f => f(entry))) {
-        return true;
-    }
-    if (skipList.regexps.find(r => r.test(entry))) {
-        return true;
-    }
-    return false;
-}

package/src/lib/config/remove-unused-deps.js

@@ -1,10 +0,0 @@
-export function removeUnusedDeps(usedDependencies, config) {
-    const filteredDependencies = Object.entries(config.shared)
-        .filter(([shared, meta]) => !!meta.includeSecondaries || usedDependencies.external.has(shared))
-        .reduce((acc, [shared, meta]) => ({ ...acc, [shared]: meta }), {});
-    return {
-        ...config,
-        shared: filteredDependencies,
-        sharedMappings: usedDependencies.internal,
-    };
-}

package/src/lib/config/share-utils.d.ts

@@ -1,10 +0,0 @@
-import { type SkipList } from '../domain/config/skip-list.contract.js';
-import type { ShareAllExternalsOptions, ShareExternalsOptions } from '../domain/config/external-config.contract.js';
-export declare function findRootTsConfigJson(): string;
-export declare function shareAll(config: ShareAllExternalsOptions, opts?: {
-    skipList?: SkipList;
-    projectPath?: string;
-    overrides?: ShareExternalsOptions;
-}): ShareExternalsOptions | null;
-export declare function setInferVersion(infer: boolean): void;
-export declare function share(configuredShareObjects: ShareExternalsOptions, projectPath?: string, skipList?: SkipList): ShareExternalsOptions;

package/src/lib/config/share-utils.js

@@ -1,302 +0,0 @@
-import * as path from 'path';
-import * as fs from 'fs';
-import { cwd } from 'process';
-import { DEFAULT_SKIP_LIST, isInSkipList, prepareSkipList } from './default-skip-list.js';
-import { findDepPackageJson, getVersionMaps } from '../utils/package-info.js';
-import { getConfigContext } from './configuration-context.js';
-import { logger } from '../utils/logger.js';
-import { resolvePackageJsonExportsWildcard } from '../utils/resolve-wildcard-keys.js';
-let inferVersion = false;
-export function findRootTsConfigJson() {
-    const packageJson = findPackageJson(cwd());
-    const projectRoot = path.dirname(packageJson);
-    const tsConfigBaseJson = path.join(projectRoot, 'tsconfig.base.json');
-    const tsConfigJson = path.join(projectRoot, 'tsconfig.json');
-    if (fs.existsSync(tsConfigBaseJson)) {
-        return tsConfigBaseJson;
-    }
-    else if (fs.existsSync(tsConfigJson)) {
-        return tsConfigJson;
-    }
-    throw new Error('Neither a tsconfig.json nor a tsconfig.base.json was found');
-}
-function findPackageJson(folder) {
-    while (!fs.existsSync(path.join(folder, 'package.json')) && path.dirname(folder) !== folder) {
-        folder = path.dirname(folder);
-    }
-    const filePath = path.join(folder, 'package.json');
-    if (fs.existsSync(filePath)) {
-        return filePath;
-    }
-    throw new Error('no package.json found. Searched the following folder and all parents: ' + folder);
-}
-function lookupVersion(key, workspaceRoot) {
-    const versionMaps = getVersionMaps(workspaceRoot, workspaceRoot);
-    for (const versionMap of versionMaps) {
-        const version = lookupVersionInMap(key, versionMap);
-        if (version) {
-            return version;
-        }
-    }
-    throw new Error(`Shared Dependency ${key} has requiredVersion:'auto'. However, this dependency is not found in your package.json`);
-}
-function lookupVersionInMap(key, versions) {
-    const parts = key.split('/');
-    if (parts.length >= 2 && parts[0].startsWith('@')) {
-        key = parts[0] + '/' + parts[1];
-    }
-    else {
-        key = parts[0];
-    }
-    if (!versions[key]) {
-        return null;
-    }
-    return versions[key];
-}
-function _findSecondaries(libPath, excludes, shareObject, acc, preparedSkipList) {
-    const files = fs.readdirSync(libPath);
-    const secondaries = files
-        .map(f => path.join(libPath, f))
-        .filter(f => fs.lstatSync(f).isDirectory() && !f.endsWith('node_modules'));
-    for (const s of secondaries) {
-        if (fs.existsSync(path.join(s, 'package.json'))) {
-            const secondaryLibName = s.replace(/\\/g, '/').replace(/^.*node_modules[/]/, '');
-            const inCustomSkipList = excludes.some(e => e === secondaryLibName || (e.endsWith('*') && secondaryLibName.startsWith(e.slice(0, -1))));
-            if (inCustomSkipList)
-                continue;
-            if (isInSkipList(secondaryLibName, preparedSkipList)) {
-                continue;
-            }
-            acc[secondaryLibName] = { ...shareObject };
-        }
-        _findSecondaries(s, excludes, shareObject, acc, preparedSkipList);
-    }
-}
-function findSecondaries(libPath, excludes, shareObject, preparedSkipList) {
-    const acc = {};
-    _findSecondaries(libPath, excludes, shareObject, acc, preparedSkipList);
-    return acc;
-}
-function getSecondaries(includeSecondaries, libPath, key, shareObject, preparedSkipList) {
-    let exclude = [];
-    let resolveGlob = false;
-    if (typeof includeSecondaries === 'object') {
-        if (Array.isArray(includeSecondaries.skip)) {
-            exclude = includeSecondaries.skip;
-        }
-        else if (typeof includeSecondaries.skip === 'string') {
-            exclude = [includeSecondaries.skip];
-        }
-        resolveGlob = !!includeSecondaries.resolveGlob;
-    }
-    // const libPath = path.join(path.dirname(packagePath), 'node_modules', key);
-    if (!fs.existsSync(libPath)) {
-        return {};
-    }
-    const configured = readConfiguredSecondaries(key, libPath, exclude, shareObject, preparedSkipList, resolveGlob);
-    if (configured) {
-        return configured;
-    }
-    // Fallback: Search folders
-    const secondaries = findSecondaries(libPath, exclude, shareObject, preparedSkipList);
-    return secondaries;
-}
-function readConfiguredSecondaries(parent, libPath, exclude, shareObject, preparedSkipList, resolveGlob) {
-    const libPackageJson = path.join(libPath, 'package.json');
-    if (!fs.existsSync(libPackageJson)) {
-        return null;
-    }
-    const packageJson = JSON.parse(fs.readFileSync(libPackageJson, 'utf-8'));
-    const version = packageJson['version'];
-    const esm = packageJson['type'] === 'module';
-    const exports = packageJson['exports'];
-    if (!exports) {
-        return null;
-    }
-    const keys = Object.keys(exports).filter(key => key !== '.' &&
-        key !== './package.json' &&
-        key.startsWith('./') &&
-        (exports[key]?.['default'] || exports[key]?.['import'] || typeof exports[key] === 'string'));
-    const result = {};
-    const discoveredFiles = new Set();
-    for (const key of keys) {
-        const secondaryName = path.join(parent, key).replace(/\\/g, '/');
-        const inCustomSkipList = exclude.some(e => e === secondaryName || (e.endsWith('*') && secondaryName.startsWith(e.slice(0, -1))));
-        if (inCustomSkipList)
-            continue;
-        if (isInSkipList(secondaryName, preparedSkipList)) {
-            continue;
-        }
-        const entry = getDefaultEntry(exports, key);
-        if (typeof entry !== 'string') {
-            console.log('No entry point found for ' + secondaryName);
-            continue;
-        }
-        if (!entry?.endsWith('.js') && !entry?.endsWith('.mjs') && !entry?.endsWith('.cjs')) {
-            continue;
-        }
-        const items = resolveGlobSecondaries(key, libPath, parent, secondaryName, entry, { discovered: discoveredFiles, skip: exclude }, resolveGlob);
-        items.forEach(e => discoveredFiles.add(typeof e === 'string' ? e : e.value));
-        for (const item of items) {
-            if (typeof item === 'object') {
-                result[item.key] = {
-                    ...shareObject,
-                    packageInfo: {
-                        entryPoint: item.value,
-                        version: shareObject.version ?? version,
-                        esm,
-                    },
-                };
-            }
-            else {
-                result[item] = {
-                    ...shareObject,
-                };
-            }
-        }
-    }
-    return result;
-}
-function resolveGlobSecondaries(key, libPath, parent, secondaryName, entry, excludes, resolveGlob) {
-    let items = [];
-    if (key.includes('*')) {
-        if (!resolveGlob)
-            return items;
-        const expanded = resolvePackageJsonExportsWildcard(key, entry, libPath);
-        items = expanded
-            .map(e => ({
-            key: path.join(parent, e.key),
-            value: path.join(libPath, e.value),
-        }))
-            .filter(i => {
-            if (excludes.skip.some(e => e.endsWith('*') ? i.key.startsWith(e.slice(0, -1)) : e === i.key)) {
-                return false;
-            }
-            if (excludes.discovered.has(i.value)) {
-                return false;
-            }
-            return true;
-        });
-    }
-    else {
-        items = [secondaryName];
-    }
-    return items;
-}
-function getDefaultEntry(exports, key) {
-    let entry = '';
-    if (typeof exports[key] === 'string') {
-        entry = exports[key];
-    }
-    if (!entry) {
-        entry = exports[key]?.['default'];
-        if (typeof entry === 'object') {
-            entry = entry['default'];
-        }
-    }
-    if (!entry) {
-        entry = exports[key]?.['import'];
-        if (typeof entry === 'object') {
-            entry = entry['import'] ?? entry['default'];
-        }
-    }
-    if (!entry) {
-        entry = exports[key]?.['require'];
-        if (typeof entry === 'object') {
-            entry = entry['require'] ?? entry['default'];
-        }
-    }
-    return entry;
-}
-export function shareAll(config, opts = {}) {
-    // let workspacePath: string | undefined = undefined;
-    const projectPath = inferProjectPath(opts.projectPath);
-    // workspacePath = getConfigContext().workspaceRoot ?? '';
-    // if (!workspacePath) {
-    //   workspacePath = projectPath;
-    // }
-    const versionMaps = getVersionMaps(projectPath, projectPath);
-    const sharedExternals = {};
-    const skipList = opts.skipList ?? DEFAULT_SKIP_LIST;
-    for (const versions of versionMaps) {
-        for (const key in versions) {
-            if (isInSkipList(key, prepareSkipList(skipList))) {
-                continue;
-            }
-            if (!!opts.overrides && Object.keys(opts.overrides).some(o => key.startsWith(o))) {
-                continue;
-            }
-            const inferVersion = !config.requiredVersion || config.requiredVersion === 'auto';
-            const requiredVersion = inferVersion ? versions[key] : config.requiredVersion;
-            if (!sharedExternals[key]) {
-                sharedExternals[key] = { ...config, requiredVersion };
-            }
-        }
-    }
-    return {
-        ...share(sharedExternals, opts.projectPath, skipList),
-        ...(!opts.overrides ? {} : share(opts.overrides, opts.projectPath, skipList)),
-    };
-}
-function inferProjectPath(projectPath) {
-    if (!projectPath && getConfigContext().packageJson) {
-        projectPath = path.dirname(getConfigContext().packageJson || '');
-    }
-    if (!projectPath && getConfigContext().workspaceRoot) {
-        projectPath = getConfigContext().workspaceRoot || '';
-    }
-    if (!projectPath) {
-        projectPath = cwd();
-    }
-    return projectPath;
-}
-export function setInferVersion(infer) {
-    inferVersion = infer;
-}
-export function share(configuredShareObjects, projectPath = '', skipList = DEFAULT_SKIP_LIST) {
-    projectPath = inferProjectPath(projectPath);
-    const packagePath = findPackageJson(projectPath);
-    const preparedSkipList = prepareSkipList(skipList);
-    const shareObjects = { ...configuredShareObjects };
-    const result = {};
-    let includeSecondaries;
-    for (const key in shareObjects) {
-        includeSecondaries = false;
-        const shareObject = shareObjects[key];
-        if (shareObject.requiredVersion === 'auto' ||
-            (inferVersion && typeof shareObject.requiredVersion === 'undefined') ||
-            shareObject.requiredVersion.length < 1) {
-            const version = lookupVersion(key, projectPath);
-            shareObject.requiredVersion = version;
-            shareObject.version = version.replace(/^\D*/, '');
-        }
-        if (typeof shareObject.includeSecondaries === 'undefined') {
-            shareObject.includeSecondaries = true;
-        }
-        if (shareObject.includeSecondaries) {
-            includeSecondaries = shareObject.includeSecondaries;
-            delete shareObject.includeSecondaries;
-            if (includeSecondaries?.keepAll)
-                shareObject.includeSecondaries = true;
-        }
-        result[key] = shareObject;
-        if (includeSecondaries) {
-            const libPackageJson = findDepPackageJson(key, path.dirname(packagePath));
-            if (!libPackageJson) {
-                logger.error('Could not find folder containing dep ' + key);
-                continue;
-            }
-            const libPath = path.dirname(libPackageJson);
-            const secondaries = getSecondaries(includeSecondaries, libPath, key, shareObject, preparedSkipList);
-            if (secondaries) {
-                addSecondaries(secondaries, result);
-            }
-        }
-    }
-    return result;
-}
-function addSecondaries(secondaries, result) {
-    for (const key in secondaries) {
-        result[key] = secondaries[key];
-    }
-}

package/src/lib/config/with-native-federation.js

@@ -1,79 +0,0 @@
-import { getRawMappedPaths } from '../utils/mapped-paths.js';
-import { shareAll, findRootTsConfigJson } from './share-utils.js';
-import { isInSkipList, prepareSkipList } from './default-skip-list.js';
-import { logger } from '../utils/logger.js';
-export function withNativeFederation(config) {
-    const skip = prepareSkipList(config.skip ?? []);
-    const chunks = config.chunks ?? true;
-    const normalized = {
-        $type: 'classic',
-        name: config.name ?? '',
-        exposes: normalizeExposes(config.exposes),
-        shared: normalizeShared(config, skip, chunks),
-        sharedMappings: removeSkippedMappings(config, skip),
-        chunks,
-        skip,
-        externals: config.externals ?? [],
-        features: {
-            mappingVersion: config.features?.mappingVersion ?? true,
-            ignoreUnusedDeps: config.features?.ignoreUnusedDeps ?? true,
-            denseChunking: config.features?.denseChunking ?? false,
-            integrityHashes: config.features?.integrityHashes ?? false,
-        },
-        ...(config.shareScope && { shareScope: config.shareScope }),
-    };
-    return normalized;
-}
-function normalizeExposes(exposes) {
-    if (!exposes)
-        return {};
-    return Object.fromEntries(Object.entries(exposes).map(([key, value]) => [
-        key,
-        typeof value === 'string' ? { file: value } : value,
-    ]));
-}
-function normalizeShared(config, skip, chunks) {
-    let result = {};
-    const shared = config.shared ??
-        shareAll({
-            singleton: true,
-            strictVersion: true,
-            requiredVersion: 'auto',
-            platform: 'browser',
-        });
-    result = Object.keys(shared).reduce((acc, cur) => {
-        const key = cur.replace(/\\/g, '/');
-        const sharedConfig = shared[cur];
-        if (!!sharedConfig.chunks && !sharedConfig.build && sharedConfig.chunks !== chunks) {
-            logger.warn(`External '${cur}' has explicit chunk settings, consider switching build type to { build: 'package' }.`);
-            sharedConfig.chunks = chunks;
-        }
-        const normalizedConfig = {
-            requiredVersion: sharedConfig.requiredVersion ?? 'auto',
-            singleton: sharedConfig.singleton ?? false,
-            strictVersion: sharedConfig.strictVersion ?? false,
-            version: sharedConfig.version,
-            chunks: sharedConfig.chunks ?? chunks,
-            includeSecondaries: sharedConfig.includeSecondaries,
-            packageInfo: sharedConfig.packageInfo,
-            platform: sharedConfig.platform ?? config.platform ?? 'browser',
-            build: sharedConfig.build ?? 'default',
-            ...(sharedConfig.shareScope && { shareScope: sharedConfig.shareScope }),
-        };
-        return {
-            ...acc,
-            [key]: normalizedConfig,
-        };
-    }, {});
-    result = Object.keys(result)
-        .filter(key => !isInSkipList(key, skip))
-        .reduce((acc, cur) => ({ ...acc, [cur]: result[cur] }), {});
-    return result;
-}
-function removeSkippedMappings(config, skipList) {
-    const rootTsConfigPath = findRootTsConfigJson();
-    const paths = getRawMappedPaths(rootTsConfigPath, config.sharedMappings);
-    return Object.entries(paths)
-        .filter(([, _import]) => !isInSkipList(_import, skipList))
-        .reduce((acc, [_path, _import]) => ({ ...acc, [_path]: _import }), {});
-}

package/src/lib/core/build-adapter.js

@@ -1,12 +0,0 @@
-import { logger } from '../utils/logger.js';
-let _buildAdapter = null;
-export function setBuildAdapter(buildAdapter) {
-    _buildAdapter = buildAdapter;
-}
-export function getBuildAdapter() {
-    if (!_buildAdapter) {
-        logger.error('Please set a BuildAdapter!');
-        throw new Error('BuildAdapter not set');
-    }
-    return _buildAdapter;
-}

package/src/lib/core/build-for-federation.d.ts

@@ -1,4 +0,0 @@
-import type { FederationInfo } from '../domain/core/federation-info.contract.js';
-import type { NormalizedFederationOptions } from '../domain/core/federation-options.contract.js';
-import type { NormalizedFederationConfig } from '../domain/config/federation-config.contract.js';
-export declare function buildForFederation(config: NormalizedFederationConfig, fedOptions: NormalizedFederationOptions, externals: string[], signal?: AbortSignal): Promise<FederationInfo>;