@module-federation/utilities 1.0.1 → 1.0.3

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [1.0.3](https://github.com/module-federation/nextjs-mf/compare/utils-1.0.2...utils-1.0.3) (2022-12-27)
+
+
+### Bug Fixes
+
+* bad references to webpack globals ([#458](https://github.com/module-federation/nextjs-mf/issues/458)) ([8ef224b](https://github.com/module-federation/nextjs-mf/commit/8ef224bd08f1e39475cac3795f09debae50bbc0f))
+
+
+
+## [1.0.2](https://github.com/module-federation/nextjs-mf/compare/utils-1.0.1...utils-1.0.2) (2022-12-27)
+
+
+
 ## [1.0.1](https://github.com/module-federation/nextjs-mf/compare/utils-1.0.0...utils-1.0.1) (2022-11-20)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/utilities",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "type": "commonjs",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/index.d.ts

@@ -1,4 +1,5 @@
 export * from './types';
 export * from './utils/common';
 export * from './utils/isEmpty';
+export * from './utils/importRemote';
 export * from './Logger';

package/src/index.js

@@ -4,5 +4,6 @@ var tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./types"), exports);
 tslib_1.__exportStar(require("./utils/common"), exports);
 tslib_1.__exportStar(require("./utils/isEmpty"), exports);
+tslib_1.__exportStar(require("./utils/importRemote"), exports);
 tslib_1.__exportStar(require("./Logger"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/utilities/src/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,yDAA+B;AAC/B,0DAAgC;AAChC,mDAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/utilities/src/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,yDAA+B;AAC/B,0DAAgC;AAChC,+DAAqC;AACrC,mDAAyB"}

package/src/types/index.d.ts

@@ -1,12 +1,18 @@
 /// <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, {
+export declare type WebpackRequire = {
+    l: (url: string, cb: (event: any) => void, id: string) => Record<string, unknown>;
+};
+export declare type WebpackShareScopes = Record<string, Record<string, {
     loaded?: 1;
     get: () => Promise<unknown>;
     from: string;
     eager: boolean;
-}>>;
+}>> & {
+    default?: string;
+};
+export declare const __webpack_init_sharing__: (parameter: string) => Promise<void>;
 export interface NextFederationPluginExtraOptions {
     enableImageLoaderFix?: boolean;
     enableUrlLoaderFix?: boolean;

package/src/utils/importRemote.d.ts

@@ -0,0 +1,8 @@
+export interface ImportRemoteOptions {
+    url: string;
+    scope: string;
+    module: string;
+    remoteEntryFileName?: string;
+    bustRemoteEntryCache?: boolean;
+}
+export declare const importRemote: <T>({ url, scope, module, remoteEntryFileName, bustRemoteEntryCache, }: ImportRemoteOptions) => Promise<T>;

package/src/utils/importRemote.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.importRemote = void 0;
+var tslib_1 = require("tslib");
+var REMOTE_ENTRY_FILE = 'remoteEntry.js';
+var loadRemote = function (url, scope, bustRemoteEntryCache) {
+    return new Promise(function (resolve, reject) {
+        var timestamp = bustRemoteEntryCache ? "?t=".concat(new Date().getTime()) : '';
+        var webpackRequire = __webpack_require__;
+        webpackRequire.l("".concat(url).concat(timestamp), function (event) {
+            var _a;
+            if ((event === null || event === void 0 ? void 0 : event.type) === 'load') {
+                // Script loaded successfully:
+                return resolve();
+            }
+            var realSrc = (_a = event === null || event === void 0 ? void 0 : event.target) === null || _a === void 0 ? void 0 : _a.src;
+            var error = new Error();
+            error.message = 'Loading script failed.\n(missing: ' + realSrc + ')';
+            error.name = 'ScriptExternalLoadError';
+            reject(error);
+        }, scope);
+    });
+};
+var initSharing = function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
+    var webpackShareScopes;
+    return tslib_1.__generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                webpackShareScopes = __webpack_share_scopes__;
+                if (!!(webpackShareScopes === null || webpackShareScopes === void 0 ? void 0 : webpackShareScopes.default)) return [3 /*break*/, 2];
+                return [4 /*yield*/, __webpack_init_sharing__('default')];
+            case 1:
+                _a.sent();
+                _a.label = 2;
+            case 2: return [2 /*return*/];
+        }
+    });
+}); };
+// __initialized and __initializing flags prevent some concurrent re-initialization corner cases
+var initContainer = function (containerScope) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
+    var webpackShareScopes, error_1;
+    return tslib_1.__generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                _a.trys.push([0, 3, , 4]);
+                webpackShareScopes = __webpack_share_scopes__;
+                if (!(!containerScope.__initialized && !containerScope.__initializing)) return [3 /*break*/, 2];
+                containerScope.__initializing = true;
+                return [4 /*yield*/, containerScope.init(webpackShareScopes.default)];
+            case 1:
+                _a.sent();
+                containerScope.__initialized = true;
+                delete containerScope.__initializing;
+                _a.label = 2;
+            case 2: return [3 /*break*/, 4];
+            case 3:
+                error_1 = _a.sent();
+                console.error(error_1);
+                return [3 /*break*/, 4];
+            case 4: return [2 /*return*/];
+        }
+    });
+}); };
+/*
+    Dynamically import a remote module using Webpack's loading mechanism:
+    https://webpack.js.org/concepts/module-federation/
+  */
+var importRemote = function (_a) {
+    var url = _a.url, scope = _a.scope, module = _a.module, _b = _a.remoteEntryFileName, remoteEntryFileName = _b === void 0 ? REMOTE_ENTRY_FILE : _b, _c = _a.bustRemoteEntryCache, bustRemoteEntryCache = _c === void 0 ? true : _c;
+    return tslib_1.__awaiter(void 0, void 0, void 0, function () {
+        var _d, moduleFactory, moduleFactory;
+        return tslib_1.__generator(this, function (_e) {
+            switch (_e.label) {
+                case 0:
+                    if (!!window[scope]) return [3 /*break*/, 3];
+                    // Load the remote and initialize the share scope if it's empty
+                    return [4 /*yield*/, Promise.all([
+                            loadRemote("".concat(url, "/").concat(remoteEntryFileName), scope, bustRemoteEntryCache),
+                            initSharing(),
+                        ])];
+                case 1:
+                    // Load the remote and initialize the share scope if it's empty
+                    _e.sent();
+                    if (!window[scope]) {
+                        throw new Error("Remote loaded successfully but ".concat(scope, " could not be found! Verify that the name is correct in the Webpack configuration!"));
+                    }
+                    return [4 /*yield*/, Promise.all([
+                            initContainer(window[scope]),
+                            window[scope].get(module.startsWith('./') ? module : "./".concat(module)),
+                        ])];
+                case 2:
+                    _d = _e.sent(), moduleFactory = _d[1];
+                    return [2 /*return*/, moduleFactory()];
+                case 3: return [4 /*yield*/, window[scope].get(module.startsWith('./') ? module : "./".concat(module))];
+                case 4:
+                    moduleFactory = _e.sent();
+                    return [2 /*return*/, moduleFactory()];
+            }
+        });
+    });
+};
+exports.importRemote = importRemote;
+//# sourceMappingURL=importRemote.js.map

package/src/utils/importRemote.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"importRemote.js","sourceRoot":"","sources":["../../../../../packages/utilities/src/utils/importRemote.ts"],"names":[],"mappings":";;;;AAUA,IAAM,iBAAiB,GAAG,gBAAgB,CAAC;AAE3C,IAAM,UAAU,GAAG,UACjB,GAA+B,EAC/B,KAAmC,EACnC,oBAAiE;IAEjE,OAAA,IAAI,OAAO,CAAO,UAAC,OAAO,EAAE,MAAM;QAChC,IAAM,SAAS,GAAG,oBAAoB,CAAC,CAAC,CAAC,aAAM,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3E,IAAM,cAAc,GAAG,mBAAgD,CAAC;QACxE,cAAc,CAAC,CAAC,CACd,UAAG,GAAG,SAAG,SAAS,CAAE,EACpB,UAAC,KAAK;;YACJ,IAAI,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,MAAK,MAAM,EAAE;gBAC1B,8BAA8B;gBAC9B,OAAO,OAAO,EAAE,CAAC;aAClB;YACD,IAAM,OAAO,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,0CAAE,GAAG,CAAC;YACnC,IAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC;YAC1B,KAAK,CAAC,OAAO,GAAG,oCAAoC,GAAG,OAAO,GAAG,GAAG,CAAC;YACrE,KAAK,CAAC,IAAI,GAAG,yBAAyB,CAAC;YACvC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,EACD,KAAK,CACN,CAAC;IACJ,CAAC,CAAC;AAlBF,CAkBE,CAAC;AAEL,IAAM,WAAW,GAAG;;;;;gBACZ,kBAAkB,GACtB,wBAAyD,CAAC;qBACxD,CAAC,CAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,OAAO,CAAA,EAA5B,wBAA4B;gBAC9B,qBAAM,wBAAwB,CAAC,SAAS,CAAC,EAAA;;gBAAzC,SAAyC,CAAC;;;;;KAE7C,CAAC;AAEF,gGAAgG;AAChG,IAAM,aAAa,GAAG,UAAO,cAAmB;;;;;;gBAEtC,kBAAkB,GACtB,wBAAyD,CAAC;qBACxD,CAAA,CAAC,cAAc,CAAC,aAAa,IAAI,CAAC,cAAc,CAAC,cAAc,CAAA,EAA/D,wBAA+D;gBACjE,cAAc,CAAC,cAAc,GAAG,IAAI,CAAC;gBACrC,qBAAM,cAAc,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAA;;gBAArD,SAAqD,CAAC;gBACtD,cAAc,CAAC,aAAa,GAAG,IAAI,CAAC;gBACpC,OAAO,cAAc,CAAC,cAAc,CAAC;;;;;gBAGvC,OAAO,CAAC,KAAK,CAAC,OAAK,CAAC,CAAC;;;;;KAExB,CAAC;AAEF;;;IAGI;AACG,IAAM,YAAY,GAAG,UAAU,EAMhB;QALpB,GAAG,SAAA,EACH,KAAK,WAAA,EACL,MAAM,YAAA,EACN,2BAAuC,EAAvC,mBAAmB,mBAAG,iBAAiB,KAAA,EACvC,4BAA2B,EAA3B,oBAAoB,mBAAG,IAAI,KAAA;;;;;;yBAEvB,CAAC,MAAM,CAAC,KAAK,CAAC,EAAd,wBAAc;oBAChB,+DAA+D;oBAC/D,qBAAM,OAAO,CAAC,GAAG,CAAC;4BAChB,UAAU,CAAC,UAAG,GAAG,cAAI,mBAAmB,CAAE,EAAE,KAAK,EAAE,oBAAoB,CAAC;4BACxE,WAAW,EAAE;yBACd,CAAC,EAAA;;oBAJF,+DAA+D;oBAC/D,SAGE,CAAC;oBACH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;wBAClB,MAAM,IAAI,KAAK,CACb,yCAAkC,KAAK,uFAAoF,CAC5H,CAAC;qBACH;oBAEyB,qBAAM,OAAO,CAAC,GAAG,CAAC;4BAC1C,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;4BAC5B,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,YAAK,MAAM,CAAE,CAAC;yBACpE,CAAC,EAAA;;oBAHI,KAAoB,SAGxB,EAHO,aAAa,QAAA;oBAItB,sBAAO,aAAa,EAAE,EAAC;wBAED,qBAAM,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAC3C,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,YAAK,MAAM,CAAE,CACjD,EAAA;;oBAFK,aAAa,GAAG,SAErB;oBACD,sBAAO,aAAa,EAAE,EAAC;;;;CAE1B,CAAC;AA9BW,QAAA,YAAY,gBA8BvB"}