@softarc/native-federation 4.1.3 → 4.2.0

package/src/lib/core/federation-cache.js

@@ -1,16 +0,0 @@
-export function createFederationCache(cachePath, bundlerCache) {
-    return { externals: [], cachePath, bundlerCache };
-}
-export function addExternalsToCache(cache, { externals, chunks, integrity, }) {
-    cache.externals.push(...externals);
-    if (chunks) {
-        if (!cache.chunks)
-            cache.chunks = {};
-        cache.chunks = { ...cache.chunks, ...chunks };
-    }
-    if (integrity) {
-        if (!cache.integrity)
-            cache.integrity = {};
-        cache.integrity = { ...cache.integrity, ...integrity };
-    }
-}

package/src/lib/core/get-externals.d.ts

@@ -1,2 +0,0 @@
-import type { NormalizedFederationConfig } from '../domain/config/federation-config.contract.js';
-export declare function getExternals(config: NormalizedFederationConfig): string[];

package/src/lib/core/get-externals.js

@@ -1,6 +0,0 @@
-export function getExternals(config) {
-    const shared = Object.keys(config.shared);
-    const sharedMappings = Object.values(config.sharedMappings);
-    const externals = [...shared, ...sharedMappings, ...config.externals];
-    return externals;
-}

package/src/lib/core/normalize-options.js

@@ -1,58 +0,0 @@
-import * as path from 'path';
-import * as fs from 'fs';
-import { pathToFileURL } from 'url';
-import { removeUnusedDeps } from '../config/remove-unused-deps.js';
-import { createFederationCache } from './federation-cache.js';
-import { getDefaultCachePath } from '../utils/cache-persistence.js';
-import { getUsedDependenciesFactory } from '../utils/get-used-dependencies.js';
-import { logger } from '../utils/logger.js';
-import { normalizePackageName } from '../utils/normalize.js';
-export async function normalizeFederationOptions(options, cache) {
-    /**
-     * Step 1: normalizing config
-     */
-    const fullConfigPath = path.join(options.workspaceRoot, options.federationConfig);
-    const getUsedDeps = getUsedDependenciesFactory(options.workspaceRoot, options.entryPoints);
-    if (!fs.existsSync(fullConfigPath)) {
-        throw new Error('Expected ' + fullConfigPath);
-    }
-    let config = (await import(pathToFileURL(fullConfigPath).href))
-        ?.default;
-    /**
-     * Step 2: normalizing options
-     */
-    const federationCache = cache ??
-        createFederationCache(getDefaultCachePath(options.workspaceRoot));
-    const normalizedOptions = {
-        ...options,
-        entryPoints: options.entryPoints ?? Object.values(config.exposes ?? {}).map(e => e.file),
-        projectName: resolveProjectName(options.projectName ?? config.name),
-        cacheExternalArtifacts: options.cacheExternalArtifacts ?? true,
-        federationCache,
-    };
-    /**
-     * Step 3: Remove unused deps
-     */
-    if (config.features.ignoreUnusedDeps) {
-        config = removeUnusedDeps(getUsedDeps(config), config);
-        logger.info('Removed unused dependencies.');
-        logger.debug('This can be disabled per dependency/external using the "includeSecondaries: {keepAll: true}" property. Or in general by disabling the "ignoreUnusedDeps" feature. ');
-    }
-    else {
-        const withWildcard = Object.keys(config.sharedMappings).some(m => m.includes('*'));
-        if (withWildcard) {
-            logger.warn('Sharing mapped paths with wildcards (*) is only supported with ignoreUnusedDeps feature.');
-            config.sharedMappings = Object.entries(config.sharedMappings)
-                .filter(([_path]) => !_path.includes('*'))
-                .reduce((acc, [_path, _import]) => ({ ...acc, [_path]: _import }), {});
-        }
-    }
-    return { config, options: normalizedOptions };
-}
-export function resolveProjectName(name) {
-    if (!name || name.length < 1) {
-        logger.warn("Project name in 'federation.config.js' is empty, defaulting to 'shell' cache folder (could collide with other projects in the workspace).");
-        return 'shell';
-    }
-    return normalizePackageName(name);
-}

package/src/lib/core/rebuild-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 rebuildForFederation(config: NormalizedFederationConfig, fedOptions: NormalizedFederationOptions, externals: string[], modifiedFiles: string[], signal?: AbortSignal): Promise<FederationInfo>;

package/src/lib/core/rebuild-for-federation.js

@@ -1,43 +0,0 @@
-import { bundleExposedAndMappings, describeExposed, describeSharedMappings, } from './bundle-exposed-and-mappings.js';
-import { writeFederationInfo } from './write-federation-info.js';
-import { writeImportMap } from './write-import-map.js';
-import { logger } from '../utils/logger.js';
-import { AbortedError } from '../utils/errors.js';
-export async function rebuildForFederation(config, fedOptions, externals, modifiedFiles, signal) {
-    const federationCache = fedOptions.federationCache;
-    logger.info(`Re-bundling all internal libraries and exposed modules..'`);
-    const start = process.hrtime();
-    const artifactInfo = await bundleExposedAndMappings(config, fedOptions, externals, modifiedFiles, signal);
-    logger.measure(start, 'To re-bundle all internal libraries and exposed modules.');
-    if (signal?.aborted)
-        throw new AbortedError('[buildForFederation] After exposed-and-mappings bundle');
-    const exposedInfo = !artifactInfo ? describeExposed(config, fedOptions) : artifactInfo.exposes;
-    const sharedMappingInfo = !artifactInfo
-        ? describeSharedMappings(config, fedOptions)
-        : artifactInfo.mappings;
-    const sharedExternals = [...federationCache.externals, ...sharedMappingInfo];
-    const buildNotificationsEndpoint = fedOptions.buildNotifications?.enable && fedOptions.dev
-        ? fedOptions.buildNotifications?.endpoint
-        : undefined;
-    const federationInfo = {
-        name: config.name,
-        shared: sharedExternals,
-        exposes: exposedInfo,
-        buildNotificationsEndpoint,
-    };
-    if (federationCache.chunks) {
-        federationInfo.chunks = federationCache.chunks;
-    }
-    if (artifactInfo?.chunks) {
-        federationInfo.chunks = { ...(federationInfo.chunks ?? {}), ...artifactInfo?.chunks };
-    }
-    if (config.features.integrityHashes) {
-        federationInfo.integrity = {
-            ...(federationCache.integrity ?? {}),
-            ...(artifactInfo?.integrity ?? {}),
-        };
-    }
-    writeFederationInfo(federationInfo, fedOptions);
-    writeImportMap(federationCache, fedOptions, federationInfo.integrity);
-    return federationInfo;
-}

package/src/lib/core/write-federation-info.d.ts

@@ -1,3 +0,0 @@
-import type { FederationInfo } from '../domain/core/federation-info.contract.js';
-import type { FederationOptions } from '../domain/core/federation-options.contract.js';
-export declare function writeFederationInfo(federationInfo: FederationInfo, fedOptions: FederationOptions): void;

package/src/lib/core/write-federation-info.js

@@ -1,6 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-export function writeFederationInfo(federationInfo, fedOptions) {
-    const metaDataPath = path.join(fedOptions.workspaceRoot, fedOptions.outputPath, 'remoteEntry.json');
-    fs.writeFileSync(metaDataPath, JSON.stringify(federationInfo, null, 2));
-}

package/src/lib/core/write-import-map.d.ts

@@ -1,6 +0,0 @@
-import type { ChunkInfo, IntegrityMap, SharedInfo } from '../domain/core/federation-info.contract.js';
-import type { FederationOptions } from '../domain/core/federation-options.contract.js';
-export declare function writeImportMap(sharedInfo: {
-    externals: SharedInfo[];
-    chunks?: ChunkInfo;
-}, fedOption: FederationOptions, fileIntegrity?: IntegrityMap): void;

package/src/lib/core/write-import-map.js

@@ -1,33 +0,0 @@
-import * as path from 'path';
-import * as fs from 'fs';
-import { toChunkImport } from '../domain/core/chunk.js';
-export function writeImportMap(sharedInfo, fedOption, fileIntegrity) {
-    const imports = sharedInfo.externals.reduce((acc, cur) => {
-        return {
-            ...acc,
-            [cur.packageName]: cur.outFileName,
-        };
-    }, {});
-    if (sharedInfo.chunks) {
-        Object.values(sharedInfo.chunks).forEach(c => {
-            c.forEach(e => {
-                const key = toChunkImport(e);
-                imports[key] = e;
-            });
-        });
-    }
-    const importMap = { imports };
-    if (fileIntegrity) {
-        const integrity = {};
-        for (const url of Object.values(imports)) {
-            const sri = fileIntegrity[url];
-            if (sri)
-                integrity[url] = sri;
-        }
-        if (Object.keys(integrity).length > 0) {
-            importMap.integrity = integrity;
-        }
-    }
-    const importMapPath = path.join(fedOption.workspaceRoot, fedOption.outputPath, 'importmap.json');
-    fs.writeFileSync(importMapPath, JSON.stringify(importMap, null, 2));
-}

package/src/lib/domain/config/external-config.contract.js

@@ -1 +0,0 @@
-export {};

package/src/lib/domain/config/federation-config.contract.js

@@ -1 +0,0 @@
-export {};

package/src/lib/domain/config/index.js

@@ -1 +0,0 @@
-export {};

package/src/lib/domain/config/skip-list.contract.js

@@ -1 +0,0 @@
-export {};

package/src/lib/domain/config/with-native-federation.contract.d.ts

@@ -1,2 +0,0 @@
-import type { NormalizedFederationConfig } from './federation-config.contract.js';
-export type WithNativeFederation = NormalizedFederationConfig;

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

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};

package/src/lib/domain/core/build-notification-options.contract.js

@@ -1,6 +0,0 @@
-export var BuildNotificationType;
-(function (BuildNotificationType) {
-    BuildNotificationType["COMPLETED"] = "federation-rebuild-complete";
-    BuildNotificationType["ERROR"] = "federation-rebuild-error";
-    BuildNotificationType["CANCELLED"] = "federation-rebuild-cancelled";
-})(BuildNotificationType || (BuildNotificationType = {}));

package/src/lib/domain/core/chunk.js

@@ -1,8 +0,0 @@
-export const CHUNK_PREFIX = '@nf-internal';
-export function toChunkImport(fileName) {
-    if (fileName.startsWith('./')) {
-        fileName = fileName.slice(2);
-    }
-    const packageName = fileName.replace(/.(m|c)?js$/, '');
-    return CHUNK_PREFIX + '/' + packageName;
-}

package/src/lib/domain/core/federation-cache.contract.js

@@ -1 +0,0 @@
-export {};

package/src/lib/domain/core/federation-info.contract.js

@@ -1 +0,0 @@
-export {};

package/src/lib/domain/core/federation-options.contract.js

@@ -1 +0,0 @@
-export {};

package/src/lib/domain/core/index.js

@@ -1,2 +0,0 @@
-export { BuildNotificationType, } from './build-notification-options.contract.js';
-export { CHUNK_PREFIX, toChunkImport } from './chunk.js';

package/src/lib/domain/core/manifest.contract.js

@@ -1 +0,0 @@
-export {};

package/src/lib/domain/utils/file-watcher.contract.js

@@ -1 +0,0 @@
-export {};

package/src/lib/domain/utils/index.d.ts

@@ -1,2 +0,0 @@
-export type { KeyValuePair } from './keyvaluepair.contract.js';
-export type { PathToImport } from './mapped-path.contract.js';

package/src/lib/domain/utils/index.js

@@ -1 +0,0 @@
-export {};

package/src/lib/domain/utils/keyvaluepair.contract.js

@@ -1 +0,0 @@
-export {};

package/src/lib/domain/utils/mapped-path.contract.js

@@ -1,5 +0,0 @@
-// export interface MappedPath {
-//   key: string;
-//   path: string;
-// }
-export {};

package/src/lib/domain/utils/used-dependencies.contract.js

@@ -1 +0,0 @@
-export {};

package/src/lib/utils/build-result-map.js

@@ -1,29 +0,0 @@
-import path from 'path';
-function stripHash(fileName) {
-    const start = fileName.lastIndexOf('-');
-    const end = fileName.lastIndexOf('.');
-    if (start < 0 || end < 0 || start > end)
-        return fileName;
-    return fileName.substring(0, start) + fileName.substring(end);
-}
-export function createBuildResultMap(buildResult, isHashed, expectedNames = []) {
-    const expected = new Set(expectedNames.map(n => path.basename(n)));
-    const map = {};
-    for (const item of buildResult) {
-        const resultName = path.basename(item.fileName);
-        const requestName = isHashed && expected.has(stripHash(resultName)) ? stripHash(resultName) : resultName;
-        map[requestName] = item.fileName;
-    }
-    return map;
-}
-export function lookupInResultMap(map, requestName) {
-    const key = path.basename(requestName);
-    // path.basename is to maintain backwards compatible
-    return path.basename(map[key]);
-}
-export function popFromResultMap(map, requestName) {
-    const key = path.basename(requestName);
-    const out = map[key];
-    delete map[key];
-    return out;
-}

package/src/lib/utils/cache-persistence.d.ts

@@ -1,19 +0,0 @@
-import type { NormalizedExternalConfig } from '../domain/config/external-config.contract.js';
-import type { ChunkInfo, IntegrityMap, SharedInfo } from '../domain/core/federation-info.contract.js';
-export declare const getDefaultCachePath: (workspaceRoot: string) => string;
-export declare const getFilename: (title: string, dev?: boolean) => string;
-export declare const getChecksum: (shared: Record<string, NormalizedExternalConfig>, dev: "1" | "0") => string;
-type CacheMetadata = {
-    checksum: string;
-    externals: SharedInfo[];
-    chunks?: ChunkInfo;
-    integrity?: IntegrityMap;
-    files: string[];
-};
-export declare const cacheEntry: (pathToCache: string, fileName: string) => {
-    getMetadata: (checksum: string) => CacheMetadata | undefined;
-    persist: (payload: CacheMetadata) => void;
-    copyFiles: (fullOutputPath: string) => void;
-    clear: () => void;
-};
-export {};

package/src/lib/utils/cache-persistence.js

@@ -1,66 +0,0 @@
-import path from 'path';
-import fs from 'fs';
-import crypto from 'crypto';
-import { logger } from './logger.js';
-export const getDefaultCachePath = (workspaceRoot) => path.join(workspaceRoot, 'node_modules/.cache/native-federation');
-export const getFilename = (title, dev) => {
-    const devSuffix = dev ? '-dev' : '';
-    return `${title}${devSuffix}.meta.json`;
-};
-export const getChecksum = (shared, dev) => {
-    const denseExternals = Object.keys(shared)
-        .sort()
-        .reduce((clean, external) => {
-        return (clean + ':' + external + (shared[external].version ? `@${shared[external].version}` : ''));
-    }, 'deps');
-    return crypto
-        .createHash('sha256')
-        .update(denseExternals + `:dev=${dev}`)
-        .digest('hex');
-};
-export const cacheEntry = (pathToCache, fileName) => ({
-    getMetadata: (checksum) => {
-        const metadataFile = path.join(pathToCache, fileName);
-        if (!fs.existsSync(pathToCache) || !fs.existsSync(metadataFile))
-            return undefined;
-        const cachedResult = JSON.parse(fs.readFileSync(metadataFile, 'utf-8'));
-        if (cachedResult.checksum !== checksum)
-            return undefined;
-        return cachedResult;
-    },
-    persist: (payload) => {
-        fs.writeFileSync(path.join(pathToCache, fileName), JSON.stringify(payload), 'utf-8');
-    },
-    copyFiles: (fullOutputPath) => {
-        const metadataFile = path.join(pathToCache, fileName);
-        if (!fs.existsSync(metadataFile))
-            throw new Error('Error copying artifacts to dist, metadata file could not be found.');
-        const cachedResult = JSON.parse(fs.readFileSync(metadataFile, 'utf-8'));
-        fs.mkdirSync(path.dirname(fullOutputPath), { recursive: true });
-        cachedResult.files.forEach(file => {
-            const cachedFile = path.join(pathToCache, file);
-            const distFileName = path.join(fullOutputPath, file);
-            if (fs.existsSync(cachedFile)) {
-                fs.copyFileSync(cachedFile, distFileName);
-            }
-        });
-    },
-    clear: () => {
-        const metadataFile = path.join(pathToCache, fileName);
-        if (!fs.existsSync(pathToCache)) {
-            fs.mkdirSync(pathToCache, { recursive: true });
-            logger.debug(`Creating cache folder '${pathToCache}' for '${fileName}'.`);
-            return;
-        }
-        if (!fs.existsSync(metadataFile))
-            return;
-        logger.debug(`Purging cached bundle '${metadataFile}'.`);
-        const cachedResult = JSON.parse(fs.readFileSync(metadataFile, 'utf-8'));
-        cachedResult.files.forEach(file => {
-            const cachedFile = path.join(pathToCache, file);
-            if (fs.existsSync(cachedFile))
-                fs.unlinkSync(cachedFile);
-        });
-        fs.unlinkSync(metadataFile);
-    },
-});

package/src/lib/utils/errors.js

@@ -1,7 +0,0 @@
-export class AbortedError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = 'AbortedError';
-        Object.setPrototypeOf(this, AbortedError.prototype);
-    }
-}

package/src/lib/utils/file-watcher.js

@@ -1,51 +0,0 @@
-import { logger } from '@softarc/native-federation/internal';
-import { watch, statSync } from 'fs';
-import { join } from 'path';
-const toUnix = (p) => p.replace(/\\/g, '/');
-export function createNfWatcher(options = {}) {
-    const { onChange } = options;
-    const watchers = new Map();
-    const dirtyPaths = new Set();
-    const notify = (path) => {
-        if (onChange)
-            onChange(path);
-        else
-            dirtyPaths.add(path);
-    };
-    return {
-        addPaths(paths) {
-            const list = typeof paths === 'string' ? [paths] : [...paths];
-            for (const p of list) {
-                if (watchers.has(p))
-                    continue;
-                try {
-                    const isDir = statSync(p).isDirectory();
-                    const w = isDir
-                        ? watch(p, { recursive: true }, (_, filename) => {
-                            if (filename)
-                                notify(toUnix(join(p, filename)));
-                        })
-                        : watch(p, () => notify(toUnix(p)));
-                    watchers.set(p, w);
-                }
-                catch {
-                    logger.debug(`Could not watch path '${p}'.`);
-                }
-            }
-        },
-        get: () => dirtyPaths,
-        clear: () => dirtyPaths.clear(),
-        mutate: fn => fn(dirtyPaths),
-        async close() {
-            for (const w of watchers.values()) {
-                w.close();
-            }
-            watchers.clear();
-        },
-    };
-}
-export function syncNfFileWatcher(watcher, bundlerCache) {
-    const files = [...bundlerCache.keys()].filter(k => !k.includes('node_modules'));
-    if (files.length)
-        watcher.addPaths(files);
-}

package/src/lib/utils/get-external-imports.d.ts

@@ -1 +0,0 @@
-export declare function getExternalImports(entryFilePath: string): string[];

package/src/lib/utils/get-external-imports.js

@@ -1,80 +0,0 @@
-import * as path from 'path';
-import * as fs from 'fs';
-import * as ts from 'typescript';
-export function getExternalImports(entryFilePath) {
-    const visited = new Set();
-    const externals = new Set();
-    function isExternal(specifier) {
-        return !specifier.startsWith('.') && !path.isAbsolute(specifier);
-    }
-    function normalizeExternal(specifier) {
-        return specifier;
-    }
-    function resolveAsFileOrDirectory(p) {
-        const abs = path.resolve(p);
-        if (fs.existsSync(abs) && fs.statSync(abs).isFile())
-            return abs;
-        const extensions = ['.ts', '.js', '.mjs', '.cjs'];
-        for (const ext of extensions) {
-            if (fs.existsSync(abs + ext) && fs.statSync(abs + ext).isFile()) {
-                return abs + ext;
-            }
-        }
-        if (fs.existsSync(abs) && fs.statSync(abs).isDirectory()) {
-            for (const file of extensions.map(e => 'index' + e)) {
-                const indexPath = path.join(abs, file);
-                if (fs.existsSync(indexPath) && fs.statSync(indexPath).isFile()) {
-                    return indexPath;
-                }
-            }
-        }
-        return null;
-    }
-    function visit(filePath) {
-        const absPath = path.resolve(filePath);
-        if (visited.has(absPath))
-            return;
-        visited.add(absPath);
-        const resolved = resolveAsFileOrDirectory(absPath);
-        if (!resolved)
-            return;
-        const source = fs.readFileSync(resolved, 'utf8');
-        const sourceFile = ts.createSourceFile(resolved, source, ts.ScriptTarget.Latest, true);
-        function walk(node) {
-            if (ts.isImportDeclaration(node) || ts.isExportDeclaration(node)) {
-                const moduleSpecifier = node.moduleSpecifier;
-                if (moduleSpecifier && ts.isStringLiteral(moduleSpecifier)) {
-                    const spec = moduleSpecifier.text;
-                    if (isExternal(spec)) {
-                        externals.add(normalizeExternal(spec));
-                    }
-                    else {
-                        const resolvedPath = resolveAsFileOrDirectory(path.resolve(path.dirname(resolved ?? ''), spec));
-                        if (resolvedPath)
-                            visit(resolvedPath);
-                    }
-                }
-            }
-            if (ts.isCallExpression(node) &&
-                ts.isIdentifier(node.expression) &&
-                node.expression.kind === ts.SyntaxKind.Identifier &&
-                node.expression.escapedText === 'require' &&
-                node.arguments.length === 1 &&
-                ts.isStringLiteral(node.arguments[0])) {
-                const spec = node.arguments[0].text;
-                if (isExternal(spec)) {
-                    externals.add(normalizeExternal(spec));
-                }
-                else {
-                    const resolvedPath = resolveAsFileOrDirectory(path.resolve(path.dirname(resolved ?? ''), spec));
-                    if (resolvedPath)
-                        visit(resolvedPath);
-                }
-            }
-            ts.forEachChild(node, walk);
-        }
-        ts.forEachChild(sourceFile, walk);
-    }
-    visit(entryFilePath);
-    return Array.from(externals);
-}

package/src/lib/utils/get-used-dependencies.d.ts

@@ -1,8 +0,0 @@
-import { type PathToImport } from '../domain/utils/mapped-path.contract.js';
-import { type UsedDependencies } from '../domain/utils/used-dependencies.contract.js';
-import { type ExposeEntry } from '../domain/config/federation-config.contract.js';
-export declare function getUsedDependenciesFactory(workspaceRoot: string, fallbackEntryPoints?: string[]): (config: {
-    name?: string;
-    exposes?: Record<string, ExposeEntry>;
-    sharedMappings: PathToImport;
-}) => UsedDependencies;