@module-federation/utilities 0.0.1

package/README.md

@@ -0,0 +1,11 @@
+# utils
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build utils` to build the library.
+
+## Running unit tests
+
+Run `nx test utils` to execute the unit tests via [Jest](https://jestjs.io).

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@module-federation/utilities",
+  "version": "0.0.1",
+  "type": "commonjs",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "repository": "https://github.com/module-federation/nextjs-mf/tree/main/packages/utilities",
+  "typings": "./src/index.d.ts",
+  "dependencies": {},
+  "peerDependencies": {
+    "webpack": "^5.74.0",
+    "tslib": "^2.3.0"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './utils/common';
+export * from './types';

package/src/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./utils/common"), exports);
+tslib_1.__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/utilities/src/index.ts"],"names":[],"mappings":";;;AAAA,yDAA8B;AAC9B,kDAAuB"}

package/src/types/index.d.ts

@@ -0,0 +1,53 @@
+/// <reference types="webpack/module" />
+import type { container, WebpackOptionsNormalized } from 'webpack';
+export declare type ModuleFederationPluginOptions = ConstructorParameters<typeof container.ModuleFederationPlugin>['0'];
+declare const __webpack_share_scopes__: Record<string, Record<string, {
+    loaded?: 1;
+    get: () => Promise<unknown>;
+    from: string;
+    eager: boolean;
+}>>;
+export interface NextFederationPluginExtraOptions {
+    enableImageLoaderFix?: boolean;
+    enableUrlLoaderFix?: boolean;
+    exposePages?: Record<string, unknown>;
+    skipSharingNextInternals?: boolean;
+    automaticPageStitching?: boolean;
+}
+export interface NextFederationPluginOptions extends ModuleFederationPluginOptions {
+    extraOptions: NextFederationPluginExtraOptions;
+}
+export declare type Shared = ModuleFederationPluginOptions['shared'];
+export declare type Remotes = ModuleFederationPluginOptions['remotes'];
+export declare type SharedObject = Extract<Shared, ModuleFederationPluginOptions>;
+export declare type SharedConfig = Extract<SharedObject[keyof SharedObject], {
+    eager?: boolean;
+}>;
+export declare type ExternalsType = Required<ModuleFederationPluginOptions['remoteType']>;
+declare type ModulePath = string;
+export declare type WebpackRemoteContainer = {
+    get(modulePath: ModulePath): () => any;
+    init: (obj?: typeof __webpack_share_scopes__) => void;
+};
+export declare type AsyncContainer = Promise<WebpackRemoteContainer>;
+export declare type RemoteData = {
+    global: string;
+    url: string;
+};
+export declare type RuntimeRemote = Partial<RemoteData> & {
+    asyncContainer?: AsyncContainer;
+};
+export declare type RuntimeRemotesMap = Record<string, RuntimeRemote>;
+declare type Module = WebpackOptionsNormalized['module'];
+declare type Rules = Module['rules'];
+export declare type RuleSetRuleUnion = Rules[0];
+declare type RuleSetRule = Extract<RuleSetRuleUnion, {
+    loader?: string;
+}>;
+export declare type Loader = Extract<RuleSetRule['use'], {
+    loader?: string;
+}>;
+export declare type EventTypes = 'loadStart' | 'loadComplete' | 'loadError';
+declare type NextRoute = string;
+export declare type PageMap = Record<NextRoute, ModulePath>;
+export {};

package/src/types/index.js

@@ -0,0 +1,5 @@
+"use strict";
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
+/// <reference path="../../../../node_modules/webpack/module.d.ts" />
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/src/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/utilities/src/types/index.ts"],"names":[],"mappings":";AAAA,qEAAqE;AACrE,qEAAqE"}

package/src/utils/common.d.ts

@@ -0,0 +1,14 @@
+import type { Remotes, RuntimeRemotesMap, RuntimeRemote } from '../types';
+export declare const extractUrlAndGlobal: (urlAndGlobal: string) => [string, string];
+export declare const runtimeRemotes: RuntimeRemotesMap;
+export declare const remotes: RuntimeRemotesMap;
+/**
+ * Return initialized remote container by remote's key or its runtime remote item data.
+ *
+ * `runtimeRemoteItem` might be
+ *    { global, url } - values obtained from webpack remotes option `global@url`
+ * or
+ *    { asyncContainer } - async container is a promise that resolves to the remote container
+ */
+export declare const injectScript: (keyOrRuntimeRemoteItem: string | RuntimeRemote) => Promise<import("../types").WebpackRemoteContainer>;
+export declare const createRuntimeVariables: (remotes: Remotes) => Record<string, string>;

package/src/utils/common.js

@@ -0,0 +1,140 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRuntimeVariables = exports.injectScript = exports.remotes = exports.runtimeRemotes = exports.extractUrlAndGlobal = void 0;
+// @ts-ignore
+var remoteVars = (process.env.REMOTES || {});
+// split the @ syntax into url and global
+var extractUrlAndGlobal = function (urlAndGlobal) {
+    var index = urlAndGlobal.indexOf('@');
+    if (index <= 0 || index === urlAndGlobal.length - 1) {
+        throw new Error("Invalid request \"".concat(urlAndGlobal, "\""));
+    }
+    return [urlAndGlobal.substring(index + 1), urlAndGlobal.substring(0, index)];
+};
+exports.extractUrlAndGlobal = extractUrlAndGlobal;
+exports.runtimeRemotes = Object.entries(remoteVars).reduce(function (acc, item) {
+    var key = item[0], value = item[1];
+    // if its an object with a thennable (eagerly executing function)
+    if (typeof value === 'object' && typeof value.then === 'function') {
+        acc[key] = { asyncContainer: value };
+    }
+    // if its a function that must be called (lazily executing function)
+    else if (typeof value === 'function') {
+        acc[key] = { asyncContainer: value() };
+    }
+    // if its just a string (global@url)
+    else if (typeof value === 'string') {
+        var _a = (0, exports.extractUrlAndGlobal)(value), url = _a[0], global_1 = _a[1];
+        acc[key] = { global: global_1, url: url };
+    }
+    // we dont know or currently support this type
+    else {
+        //@ts-ignore
+        console.log('remotes process', process.env.REMOTES);
+        throw new Error("[mf] Invalid value received for runtime_remote \"".concat(key, "\""));
+    }
+    return acc;
+}, {});
+exports.remotes = exports.runtimeRemotes;
+/**
+ * Return initialized remote container by remote's key or its runtime remote item data.
+ *
+ * `runtimeRemoteItem` might be
+ *    { global, url } - values obtained from webpack remotes option `global@url`
+ * or
+ *    { asyncContainer } - async container is a promise that resolves to the remote container
+ */
+var injectScript = function (keyOrRuntimeRemoteItem) {
+    // 1) Load remote container if needed
+    var asyncContainer;
+    var reference = typeof keyOrRuntimeRemoteItem === 'string'
+        ? exports.runtimeRemotes[keyOrRuntimeRemoteItem]
+        : keyOrRuntimeRemoteItem;
+    if (reference.asyncContainer) {
+        asyncContainer = reference.asyncContainer;
+    }
+    else {
+        // This casting is just to satisfy typescript,
+        // In reality remoteGlobal will always be a string;
+        var remoteGlobal_1 = reference.global;
+        var __webpack_error__1 = new Error();
+        asyncContainer = new Promise(function (resolve, reject) {
+            function resolveRemoteGlobal() {
+                var asyncContainer = window[remoteGlobal_1];
+                return resolve(asyncContainer);
+            }
+            if (typeof window[remoteGlobal_1] !== 'undefined') {
+                return resolveRemoteGlobal();
+            }
+            __webpack_require__.l(reference.url, function (event) {
+                if (typeof window[remoteGlobal_1] !== 'undefined') {
+                    return resolveRemoteGlobal();
+                }
+                var errorType = event && (event.type === 'load' ? 'missing' : event.type);
+                var realSrc = event && event.target && event.target.src;
+                __webpack_error__1.message =
+                    'Loading script failed.\n(' +
+                        errorType +
+                        ': ' +
+                        realSrc +
+                        ' or global var ' +
+                        remoteGlobal_1 +
+                        ')';
+                __webpack_error__1.name = 'ScriptExternalLoadError';
+                __webpack_error__1.type = errorType;
+                __webpack_error__1.request = realSrc;
+                reject(__webpack_error__1);
+            }, remoteGlobal_1);
+        });
+    }
+    // 2) Initialize remote container
+    return asyncContainer
+        .then(function (container) {
+        if (!__webpack_share_scopes__['default']) {
+            // not always a promise, so we wrap it in a resolve
+            return Promise.resolve(__webpack_init_sharing__('default')).then(function () {
+                return container;
+            });
+        }
+        else {
+            return container;
+        }
+    })
+        .then(function (container) {
+        try {
+            // WARNING: here might be a potential BUG.
+            //   `container.init` does not return a Promise, and here we do not call `then` on it.
+            // But according to [docs](https://webpack.js.org/concepts/module-federation/#dynamic-remote-containers)
+            //   it must be async.
+            // The problem may be in Proxy in NextFederationPlugin.js.
+            //   or maybe a bug in the webpack itself - instead of returning rejected promise it just throws an error.
+            // But now everything works properly and we keep this code as is.
+            container.init(__webpack_share_scopes__['default']);
+        }
+        catch (e) {
+            // maybe container already initialized so nothing to throw
+        }
+        return container;
+    });
+};
+exports.injectScript = injectScript;
+var createRuntimeVariables = function (remotes) {
+    if (!remotes) {
+        return {};
+    }
+    return Object.entries(remotes).reduce(function (acc, remote) {
+        // handle promise new promise and external new promise
+        if (remote[1].startsWith('promise ') || remote[1].startsWith('external ')) {
+            var promiseCall = remote[1]
+                .replace('promise ', '')
+                .replace('external ', '');
+            acc[remote[0]] = "function() {\n        return ".concat(promiseCall, "\n      }");
+            return acc;
+        }
+        // if somehow its just the @ syntax or something else, pass it through
+        acc[remote[0]] = JSON.stringify(remote[1]);
+        return acc;
+    }, {});
+};
+exports.createRuntimeVariables = createRuntimeVariables;
+//# sourceMappingURL=common.js.map

package/src/utils/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../../../packages/utilities/src/utils/common.ts"],"names":[],"mappings":";;;AAOA,aAAa;AACb,IAAM,UAAU,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAG5C,CAAC;AAEF,yCAAyC;AAClC,IAAM,mBAAmB,GAAG,UAAC,YAAoB;IACtD,IAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,KAAK,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;QACnD,MAAM,IAAI,KAAK,CAAC,4BAAoB,YAAY,OAAG,CAAC,CAAC;KACtD;IACD,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;AAC/E,CAAC,CAAC;AANW,QAAA,mBAAmB,uBAM9B;AAEW,QAAA,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,UAC9D,GAAG,EACH,IAAI;IAEG,IAAA,GAAG,GAAW,IAAI,GAAf,EAAE,KAAK,GAAI,IAAI,GAAR,CAAS;IAC1B,iEAAiE;IACjE,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE;QACjE,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC;KACtC;IACD,oEAAoE;SAC/D,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;QACpC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,CAAC;KACxC;IACD,oCAAoC;SAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC5B,IAAA,KAAgB,IAAA,2BAAmB,EAAC,KAAK,CAAC,EAAzC,GAAG,QAAA,EAAE,QAAM,QAA8B,CAAC;QACjD,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,UAAA,EAAE,GAAG,KAAA,EAAE,CAAC;KAC5B;IACD,8CAA8C;SACzC;QACH,YAAY;QACZ,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACpD,MAAM,IAAI,KAAK,CAAC,2DAAmD,GAAG,OAAG,CAAC,CAAC;KAC5E;IACD,OAAO,GAAG,CAAC;AACb,CAAC,EACD,EAAuB,CAAC,CAAC;AAEZ,QAAA,OAAO,GAAG,sBAAc,CAAC;AAEtC;;;;;;;GAOG;AACI,IAAM,YAAY,GAAG,UAC1B,sBAA8C;IAE9C,qCAAqC;IACrC,IAAI,cAA+C,CAAC;IACpD,IAAM,SAAS,GACb,OAAO,sBAAsB,KAAK,QAAQ;QACxC,CAAC,CAAC,sBAAc,CAAC,sBAAsB,CAAC;QACxC,CAAC,CAAC,sBAAsB,CAAC;IAE7B,IAAI,SAAS,CAAC,cAAc,EAAE;QAC5B,cAAc,GAAG,SAAS,CAAC,cAAc,CAAC;KAC3C;SAAM;QACL,8CAA8C;QAC9C,mDAAmD;QACnD,IAAM,cAAY,GAAG,SAAS,CAAC,MAA2B,CAAC;QAC3D,IAAM,kBAAiB,GAAG,IAAI,KAAK,EAGlC,CAAC;QAEF,cAAc,GAAG,IAAI,OAAO,CAAC,UAAU,OAAO,EAAE,MAAM;YACpD,SAAS,mBAAmB;gBAC1B,IAAM,cAAc,GAAG,MAAM,CAC3B,cAAY,CACgB,CAAC;gBAC/B,OAAO,OAAO,CAAC,cAAc,CAAC,CAAC;YACjC,CAAC;YAED,IAAI,OAAO,MAAM,CAAC,cAAY,CAAC,KAAK,WAAW,EAAE;gBAC/C,OAAO,mBAAmB,EAAE,CAAC;aAC9B;YAEA,mBAA2B,CAAC,CAAC,CAC5B,SAAS,CAAC,GAAG,EACb,UAAU,KAAY;gBACpB,IAAI,OAAO,MAAM,CAAC,cAAY,CAAC,KAAK,WAAW,EAAE;oBAC/C,OAAO,mBAAmB,EAAE,CAAC;iBAC9B;gBAED,IAAM,SAAS,GACb,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC5D,IAAM,OAAO,GACX,KAAK,IAAI,KAAK,CAAC,MAAM,IAAK,KAAK,CAAC,MAA4B,CAAC,GAAG,CAAC;gBAEnE,kBAAiB,CAAC,OAAO;oBACvB,2BAA2B;wBAC3B,SAAS;wBACT,IAAI;wBACJ,OAAO;wBACP,iBAAiB;wBACjB,cAAY;wBACZ,GAAG,CAAC;gBAEN,kBAAiB,CAAC,IAAI,GAAG,yBAAyB,CAAC;gBACnD,kBAAiB,CAAC,IAAI,GAAG,SAAS,CAAC;gBACnC,kBAAiB,CAAC,OAAO,GAAG,OAAO,CAAC;gBAEpC,MAAM,CAAC,kBAAiB,CAAC,CAAC;YAC5B,CAAC,EACD,cAAY,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;KACJ;IAED,iCAAiC;IACjC,OAAO,cAAc;SAClB,IAAI,CAAC,UAAU,SAAS;QACvB,IAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,EAAE;YACxC,mDAAmD;YACnD,OAAO,OAAO,CAAC,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAC9D;gBACE,OAAO,SAAS,CAAC;YACnB,CAAC,CACF,CAAC;SACH;aAAM;YACL,OAAO,SAAS,CAAC;SAClB;IACH,CAAC,CAAC;SACD,IAAI,CAAC,UAAU,SAAS;QACvB,IAAI;YACF,0CAA0C;YAC1C,sFAAsF;YACtF,wGAAwG;YACxG,sBAAsB;YACtB,0DAA0D;YAC1D,0GAA0G;YAC1G,iEAAiE;YACjE,SAAS,CAAC,IAAI,CAAC,wBAAwB,CAAC,SAAS,CAAQ,CAAC,CAAC;SAC5D;QAAC,OAAO,CAAC,EAAE;YACV,0DAA0D;SAC3D;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AA9FW,QAAA,YAAY,gBA8FvB;AAEK,IAAM,sBAAsB,GAAG,UAAC,OAAgB;IACrD,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,EAAE,CAAC;KACX;IAED,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,UAAC,GAAG,EAAE,MAAM;QAChD,sDAAsD;QACtD,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;YACzE,IAAM,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC;iBAC1B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;iBACvB,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAC5B,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,uCACN,WAAW,cACpB,CAAC;YACH,OAAO,GAAG,CAAC;SACZ;QACD,sEAAsE;QACtE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3C,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAA4B,CAAC,CAAC;AACnC,CAAC,CAAC;AArBW,QAAA,sBAAsB,0BAqBjC"}