@module-federation/sdk 0.3.0 → 0.3.1

package/dist/normalize-webpack-path.cjs.js

@@ -0,0 +1,48 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var path = require('path');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
+
+function getWebpackPath(compiler, options = {
+    framework: 'other'
+}) {
+    try {
+        // @ts-ignore just throw err
+        compiler.webpack();
+        return '';
+    } catch (err) {
+        var _err_stack;
+        const trace = ((_err_stack = err.stack) == null ? void 0 : _err_stack.split('\n')) || [];
+        const webpackErrLocation = trace.find((item)=>item.includes('at webpack')) || '';
+        const webpackLocationWithDetail = webpackErrLocation.replace(/[^\(\)]+/, '').slice(1, -1);
+        const webpackPath = webpackLocationWithDetail.split(':').slice(0, -2).join(':');
+        if ((options == null ? void 0 : options.framework) === 'nextjs') {
+            if (webpackPath.endsWith('webpack.js')) {
+                return webpackPath.replace('webpack.js', 'index.js');
+            }
+            return '';
+        }
+        return require.resolve('webpack', {
+            paths: [
+                webpackPath
+            ]
+        });
+    }
+}
+const normalizeWebpackPath = (fullPath)=>{
+    if (fullPath === 'webpack') {
+        return process.env['FEDERATION_WEBPACK_PATH'] || fullPath;
+    }
+    if (process.env['FEDERATION_WEBPACK_PATH']) {
+        return path__default["default"].resolve(process.env['FEDERATION_WEBPACK_PATH'], fullPath.replace('webpack', '../../'));
+    }
+    return fullPath;
+};
+
+exports.getWebpackPath = getWebpackPath;
+exports.normalizeWebpackPath = normalizeWebpackPath;

package/dist/normalize-webpack-path.esm.js

@@ -0,0 +1,39 @@
+import path from 'path';
+
+function getWebpackPath(compiler, options = {
+    framework: 'other'
+}) {
+    try {
+        // @ts-ignore just throw err
+        compiler.webpack();
+        return '';
+    } catch (err) {
+        var _err_stack;
+        const trace = ((_err_stack = err.stack) == null ? void 0 : _err_stack.split('\n')) || [];
+        const webpackErrLocation = trace.find((item)=>item.includes('at webpack')) || '';
+        const webpackLocationWithDetail = webpackErrLocation.replace(/[^\(\)]+/, '').slice(1, -1);
+        const webpackPath = webpackLocationWithDetail.split(':').slice(0, -2).join(':');
+        if ((options == null ? void 0 : options.framework) === 'nextjs') {
+            if (webpackPath.endsWith('webpack.js')) {
+                return webpackPath.replace('webpack.js', 'index.js');
+            }
+            return '';
+        }
+        return require.resolve('webpack', {
+            paths: [
+                webpackPath
+            ]
+        });
+    }
+}
+const normalizeWebpackPath = (fullPath)=>{
+    if (fullPath === 'webpack') {
+        return process.env['FEDERATION_WEBPACK_PATH'] || fullPath;
+    }
+    if (process.env['FEDERATION_WEBPACK_PATH']) {
+        return path.resolve(process.env['FEDERATION_WEBPACK_PATH'], fullPath.replace('webpack', '../../'));
+    }
+    return fullPath;
+};
+
+export { getWebpackPath, normalizeWebpackPath };

package/dist/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@module-federation/sdk",
+  "version": "0.3.1",
+  "license": "MIT",
+  "description": "A sdk for support module federation",
+  "keywords": [
+    "Module Federation",
+    "sdk"
+  ],
+  "files": [
+    "dist/",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "zhanghang <hanric.zhang@gmail.com>",
+  "sideEffects": false,
+  "main": "./index.cjs.js",
+  "module": "./index.esm.js",
+  "types": "./dist/index.cjs.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.cjs.d.ts",
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.cjs.js"
+    },
+    "./normalize-webpack-path": {
+      "types": "./dist/normalize-webpack-path.cjs.d.ts",
+      "import": "./dist/normalize-webpack-path.esm.js",
+      "require": "./dist/normalize-webpack-path.cjs.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/index.cjs.d.ts"
+      ],
+      "normalize-webpack-path": [
+        "./dist/normalize-webpack-path.cjs.d.ts"
+      ]
+    }
+  }
+}

package/{src → dist/src}/constant.d.ts

@@ -14,3 +14,12 @@ export declare const EncodedNameTransformMap: {
     [x: string]: string;
 };
 export declare const SEPARATOR = ":";
+export declare const ManifestFileName = "mf-manifest.json";
+export declare const StatsFileName = "mf-stats.json";
+export declare const MFModuleType: {
+    NPM: string;
+    APP: string;
+};
+export declare const MODULE_DEVTOOL_IDENTIFIER = "__MF_DEVTOOLS_MODULE_INFO__";
+export declare const ENCODE_NAME_PREFIX = "ENCODE_NAME_PREFIX";
+export declare const TEMP_DIR = ".federation";

package/dist/src/dom.d.ts

@@ -0,0 +1,30 @@
+export declare function safeWrapper<T extends (...args: Array<any>) => any>(callback: T, disableWarn?: boolean): Promise<ReturnType<T> | undefined>;
+export declare function isStaticResourcesEqual(url1: string, url2: string): boolean;
+export type CreateScriptHookReturn = HTMLScriptElement | {
+    script?: HTMLScriptElement;
+    timeout?: number;
+} | void;
+export declare function createScript(info: {
+    url: string;
+    cb?: (value: void | PromiseLike<void>) => void;
+    attrs?: Record<string, any>;
+    needDeleteScript?: boolean;
+    createScriptHook?: (url: string, attrs?: Record<string, any> | undefined) => CreateScriptHookReturn;
+}): {
+    script: HTMLScriptElement;
+    needAttach: boolean;
+};
+export declare function createLink(info: {
+    url: string;
+    cb: (value: void | PromiseLike<void>) => void;
+    attrs: Record<string, string>;
+    needDeleteLink?: boolean;
+    createLinkHook?: (url: string) => HTMLLinkElement | void;
+}): {
+    link: HTMLLinkElement;
+    needAttach: boolean;
+};
+export declare function loadScript(url: string, info: {
+    attrs?: Record<string, any>;
+    createScriptHook?: (url: string, attrs?: Record<string, any> | undefined) => CreateScriptHookReturn;
+}): Promise<void>;

package/{src → dist/src}/generateSnapshotFromManifest.d.ts

@@ -5,6 +5,7 @@ interface IOptions {
     version?: string;
 }
 export declare const simpleJoinRemoteEntry: (rPath: string, rName: string) => string;
+export declare function inferAutoPublicPath(url: string): string;
 export declare function generateSnapshotFromManifest(manifest: Manifest, options?: IOptions): ProviderModuleInfo;
 export declare function isManifestProvider(moduleInfo: ModuleInfo | ManifestProvider): moduleInfo is ManifestProvider;
 export {};

package/dist/src/index.d.ts

@@ -0,0 +1,9 @@
+export * from './constant';
+export * from './types';
+export * from './utils';
+export { generateSnapshotFromManifest, isManifestProvider, simpleJoinRemoteEntry, inferAutoPublicPath, } from './generateSnapshotFromManifest';
+export * from './logger';
+export * from './env';
+export * from './dom';
+export * from './node';
+export * from './normalizeOptions';

package/dist/src/node.d.ts

@@ -0,0 +1,5 @@
+export declare function createScriptNode(url: string, cb: (error?: Error, scriptContext?: any) => void, attrs?: Record<string, any>, createScriptHook?: (url: string) => any | void): void;
+export declare function loadScriptNode(url: string, info: {
+    attrs?: Record<string, any>;
+    createScriptHook?: (url: string) => void;
+}): Promise<void>;

package/{src → dist/src}/normalize-webpack-path.d.ts

@@ -1,3 +1,5 @@
 import type webpack from 'webpack';
-export declare function getWebpackPath(compiler: webpack.Compiler): string;
+export declare function getWebpackPath(compiler: webpack.Compiler, options?: {
+    framework: 'nextjs' | 'other';
+}): string;
 export declare const normalizeWebpackPath: (fullPath: string) => string;

package/dist/src/normalizeOptions.d.ts

@@ -0,0 +1 @@
+export declare function normalizeOptions<T>(enableDefault: boolean, defaultOptions: T, key: string): <U extends boolean | undefined | T>(options: U) => T | false;

package/{src → dist/src}/types/index.d.ts

@@ -2,3 +2,4 @@ export * from './common';
 export * from './manifest';
 export * from './stats';
 export * from './snapshot';
+export * from './plugins';

package/dist/src/types/plugins/ContainerPlugin.d.ts

@@ -0,0 +1,159 @@
+/**
+ * Modules that should be exposed by this container. When provided, property name is used as public name, otherwise public name is automatically inferred from request.
+ */
+export type Exposes = (ExposesItem | ExposesObject)[] | ExposesObject;
+/**
+ * Module that should be exposed by this container.
+ */
+export type ExposesItem = string;
+/**
+ * Modules that should be exposed by this container.
+ */
+export type ExposesItems = ExposesItem[];
+/**
+ * Add a container for define/require functions in the AMD module.
+ */
+export type AmdContainer = string;
+/**
+ * Add a comment in the UMD wrapper.
+ */
+export type AuxiliaryComment = string | LibraryCustomUmdCommentObject;
+/**
+ * Specify which export should be exposed as library.
+ */
+export type LibraryExport = string[] | string;
+/**
+ * The name of the library (some types allow unnamed libraries too).
+ */
+export type LibraryName = string[] | string | LibraryCustomUmdObject;
+/**
+ * Type of library (types included by default are 'var', 'module', 'assign', 'assign-properties', 'this', 'window', 'self', 'global', 'commonjs', 'commonjs2', 'commonjs-module', 'commonjs-static', 'amd', 'amd-require', 'umd', 'umd2', 'jsonp', 'system', but others might be added by plugins).
+ */
+export type LibraryType = ('var' | 'module' | 'assign' | 'assign-properties' | 'this' | 'window' | 'self' | 'global' | 'commonjs' | 'commonjs2' | 'commonjs-module' | 'commonjs-static' | 'amd' | 'amd-require' | 'umd' | 'umd2' | 'jsonp' | 'system') | string;
+/**
+ * If `output.libraryTarget` is set to umd and `output.library` is set, setting this to true will name the AMD module.
+ */
+export type UmdNamedDefine = boolean;
+/**
+ * The name of the runtime chunk. If set a runtime chunk with this name is created or an existing entrypoint is used as runtime.
+ */
+export type EntryRuntime = false | string;
+export interface ContainerPluginOptions {
+    /**
+     * Modules that should be exposed by this container. When provided, property name is used as public name, otherwise public name is automatically inferred from request.
+     */
+    exposes: Exposes;
+    /**
+     * The filename for this container relative path inside the `output.path` directory.
+     */
+    filename?: string;
+    /**
+     * Options for library.
+     */
+    library?: LibraryOptions;
+    /**
+     * The name for this container.
+     */
+    name: string;
+    /**
+     * The name of the runtime chunk. If set a runtime chunk with this name is created or an existing entrypoint is used as runtime.
+     */
+    runtime?: EntryRuntime;
+    /**
+     * The name of the share scope which is shared with the host (defaults to 'default').
+     */
+    shareScope?: string;
+    /**
+     * Runtime plugin file paths or package name.
+     */
+    runtimePlugins?: string[];
+}
+/**
+ * Modules that should be exposed by this container. Property names are used as public paths.
+ */
+export interface ExposesObject {
+    /**
+     * Modules that should be exposed by this container.
+     */
+    [k: string]: ExposesConfig | ExposesItem | ExposesItems;
+}
+/**
+ * Advanced configuration for modules that should be exposed by this container.
+ */
+export interface ExposesConfig {
+    /**
+     * Request to a module that should be exposed by this container.
+     */
+    import: ExposesItem | ExposesItems;
+    /**
+     * Custom chunk name for the exposed module.
+     */
+    name?: string;
+}
+/**
+ * Options for library.
+ */
+export interface LibraryOptions {
+    /**
+     * Add a container for define/require functions in the AMD module.
+     */
+    amdContainer?: AmdContainer;
+    /**
+     * Add a comment in the UMD wrapper.
+     */
+    auxiliaryComment?: AuxiliaryComment;
+    /**
+     * Specify which export should be exposed as library.
+     */
+    export?: LibraryExport;
+    /**
+     * The name of the library (some types allow unnamed libraries too).
+     */
+    name?: LibraryName;
+    /**
+     * Type of library (types included by default are 'var', 'module', 'assign', 'assign-properties', 'this', 'window', 'self', 'global', 'commonjs', 'commonjs2', 'commonjs-module', 'commonjs-static', 'amd', 'amd-require', 'umd', 'umd2', 'jsonp', 'system', but others might be added by plugins).
+     */
+    type: LibraryType;
+    /**
+     * If `output.libraryTarget` is set to umd and `output.library` is set, setting this to true will name the AMD module.
+     */
+    umdNamedDefine?: UmdNamedDefine;
+}
+/**
+ * Set explicit comments for `commonjs`, `commonjs2`, `amd`, and `root`.
+ */
+export interface LibraryCustomUmdCommentObject {
+    /**
+     * Set comment for `amd` section in UMD.
+     */
+    amd?: string;
+    /**
+     * Set comment for `commonjs` (exports) section in UMD.
+     */
+    commonjs?: string;
+    /**
+     * Set comment for `commonjs2` (module.exports) section in UMD.
+     */
+    commonjs2?: string;
+    /**
+     * Set comment for `root` (global variable) section in UMD.
+     */
+    root?: string;
+}
+/**
+ * Description object for all UMD variants of the library name.
+ */
+export interface LibraryCustomUmdObject {
+    /**
+     * Name of the exposed AMD library in the UMD.
+     */
+    amd?: string;
+    /**
+     * Name of the exposed commonjs export in the UMD.
+     */
+    commonjs?: string;
+    /**
+     * Name of the property exposed globally by a UMD library.
+     */
+    root?: string[] | string;
+}

package/dist/src/types/plugins/ContainerReferencePlugin.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Specifies the default type of externals ('amd*', 'umd*', 'system' and 'jsonp' depend on output.libraryTarget set to the same value).
+ */
+export type ExternalsType = 'var' | 'module' | 'assign' | 'this' | 'window' | 'self' | 'global' | 'commonjs' | 'commonjs2' | 'commonjs-module' | 'commonjs-static' | 'amd' | 'amd-require' | 'umd' | 'umd2' | 'jsonp' | 'system' | 'promise' | 'import' | 'script' | 'node-commonjs';
+/**
+ * Container locations and request scopes from which modules should be resolved and loaded at runtime. When provided, property name is used as request scope, otherwise request scope is automatically inferred from container location.
+ */
+export type Remotes = (RemotesItem | RemotesObject)[] | RemotesObject;
+/**
+ * Container location from which modules should be resolved and loaded at runtime.
+ */
+export type RemotesItem = string;
+/**
+ * Container locations from which modules should be resolved and loaded at runtime.
+ */
+export type RemotesItems = RemotesItem[];
+export interface ContainerReferencePluginOptions {
+    /**
+     * The external type of the remote containers.
+     */
+    remoteType: ExternalsType;
+    /**
+     * Container locations and request scopes from which modules should be resolved and loaded at runtime. When provided, property name is used as request scope, otherwise request scope is automatically inferred from container location.
+     */
+    remotes: Remotes;
+    /**
+     * The name of the share scope shared with all remotes (defaults to 'default').
+     */
+    shareScope?: string;
+}
+/**
+ * Container locations from which modules should be resolved and loaded at runtime. Property names are used as request scopes.
+ */
+export interface RemotesObject {
+    /**
+     * Container locations from which modules should be resolved and loaded at runtime.
+     */
+    [k: string]: RemotesConfig | RemotesItem | RemotesItems;
+}
+/**
+ * Advanced configuration for container locations from which modules should be resolved and loaded at runtime.
+ */
+export interface RemotesConfig {
+    /**
+     * Container locations from which modules should be resolved and loaded at runtime.
+     */
+    external: RemotesItem | RemotesItems;
+    /**
+     * The name of the share scope shared with this remote.
+     */
+    shareScope?: string;
+}