@module-federation/rsbuild-plugin 0.14.3 → 0.16.0

package/dist/constant.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/constant";

package/dist/constant.cjs.js

@@ -0,0 +1,18 @@
+'use strict';
+
+var DEFAULT_ASSET_PREFIX = '/';
+var DATA_FETCH_IDENTIFIER = 'data';
+var DATA_FETCH_CLIENT_SUFFIX = '.client';
+var CALL_NAME_MAP = {
+    RSPRESS: 'rspress',
+    RSLIB: 'rslib'
+};
+var RSPRESS_BUNDLER_CONFIG_NAME = 'node';
+var RSPRESS_SSR_DIR = 'ssr';
+
+exports.CALL_NAME_MAP = CALL_NAME_MAP;
+exports.DATA_FETCH_CLIENT_SUFFIX = DATA_FETCH_CLIENT_SUFFIX;
+exports.DATA_FETCH_IDENTIFIER = DATA_FETCH_IDENTIFIER;
+exports.DEFAULT_ASSET_PREFIX = DEFAULT_ASSET_PREFIX;
+exports.RSPRESS_BUNDLER_CONFIG_NAME = RSPRESS_BUNDLER_CONFIG_NAME;
+exports.RSPRESS_SSR_DIR = RSPRESS_SSR_DIR;

package/dist/constant.esm.d.ts

@@ -0,0 +1 @@
+export * from "./src/constant";

package/dist/constant.esm.mjs

@@ -0,0 +1,11 @@
+var DEFAULT_ASSET_PREFIX = '/';
+var DATA_FETCH_IDENTIFIER = 'data';
+var DATA_FETCH_CLIENT_SUFFIX = '.client';
+var CALL_NAME_MAP = {
+    RSPRESS: 'rspress',
+    RSLIB: 'rslib'
+};
+var RSPRESS_BUNDLER_CONFIG_NAME = 'node';
+var RSPRESS_SSR_DIR = 'ssr';
+
+export { CALL_NAME_MAP, DATA_FETCH_CLIENT_SUFFIX, DATA_FETCH_IDENTIFIER, DEFAULT_ASSET_PREFIX, RSPRESS_BUNDLER_CONFIG_NAME, RSPRESS_SSR_DIR };

package/dist/index.cjs.js

@@ -4,7 +4,11 @@ var enhanced = require('@module-federation/enhanced');
 var rspack = require('@module-federation/enhanced/rspack');
 var sdk = require('@module-federation/sdk');
 var utils = require('./utils.cjs.js');
+var constant = require('./constant.cjs.js');
 require('util');
+require('fs-extra');
+require('path');
+require('node:module');
 
 var name = "@module-federation/rsbuild-plugin";
 var pkgJson = {
@@ -20,12 +24,59 @@ function _array_like_to_array(arr, len) {
 function _array_without_holes(arr) {
     if (Array.isArray(arr)) return _array_like_to_array(arr);
 }
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
 function _iterable_to_array(iter) {
     if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
 }
 function _non_iterable_spread() {
     throw new TypeError("Invalid attempt to spread non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
 }
+function _object_spread(target) {
+    for(var i = 1; i < arguments.length; i++){
+        var source = arguments[i] != null ? arguments[i] : {};
+        var ownKeys = Object.keys(source);
+        if (typeof Object.getOwnPropertySymbols === "function") {
+            ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(source, sym).enumerable;
+            }));
+        }
+        ownKeys.forEach(function(key) {
+            _define_property(target, key, source[key]);
+        });
+    }
+    return target;
+}
+function ownKeys(object, enumerableOnly) {
+    var keys = Object.keys(object);
+    if (Object.getOwnPropertySymbols) {
+        var symbols = Object.getOwnPropertySymbols(object);
+        keys.push.apply(keys, symbols);
+    }
+    return keys;
+}
+function _object_spread_props(target, source) {
+    source = source != null ? source : {};
+    if (Object.getOwnPropertyDescriptors) {
+        Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
+    } else {
+        ownKeys(Object(source)).forEach(function(key) {
+            Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+        });
+    }
+    return target;
+}
 function _to_consumable_array(arr) {
     return _array_without_holes(arr) || _iterable_to_array(arr) || _unsupported_iterable_to_array(arr) || _non_iterable_spread();
 }
@@ -42,11 +93,12 @@ function _unsupported_iterable_to_array(o, minLen) {
     if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _array_like_to_array(o, minLen);
 }
 var RSBUILD_PLUGIN_MODULE_FEDERATION_NAME = 'rsbuild:module-federation-enhanced';
-var RSPACK_PLUGIN_MODULE_FEDERATION_NAME = 'module-federation';
+var RSBUILD_PLUGIN_NAME = '@module-federation/rsbuild-plugin';
 var LIB_FORMAT = [
     'umd',
     'modern-module'
 ];
+var DEFAULT_MF_ENVIRONMENT_NAME = 'mf';
 function isStoryBook(rsbuildConfig) {
     var _rsbuildConfig_plugins;
     if ((_rsbuildConfig_plugins = rsbuildConfig.plugins) === null || _rsbuildConfig_plugins === void 0 ? void 0 : _rsbuildConfig_plugins.find(function(p) {
@@ -58,13 +110,44 @@ function isStoryBook(rsbuildConfig) {
 function isMFFormat(bundlerConfig) {
     var _bundlerConfig_output;
     var library = (_bundlerConfig_output = bundlerConfig.output) === null || _bundlerConfig_output === void 0 ? void 0 : _bundlerConfig_output.library;
+    if (bundlerConfig.name === utils.SSR_ENV_NAME) {
+        return true;
+    }
     return !((typeof library === "undefined" ? "undefined" : _type_of(library)) === 'object' && !Array.isArray(library) && 'type' in library && //  if the type is umd/modern-module or commonjs*, means this is a normal library , not mf
     (LIB_FORMAT.includes(library.type) || /commonjs/.test(library.type)));
 }
-var pluginModuleFederation = function(moduleFederationOptions) {
+var isSSRConfig = function(bundlerConfigName) {
+    return Boolean(bundlerConfigName === utils.SSR_ENV_NAME);
+};
+var isRspressSSGConfig = function(bundlerConfigName) {
+    return bundlerConfigName === constant.RSPRESS_BUNDLER_CONFIG_NAME;
+};
+var pluginModuleFederation = function(moduleFederationOptions, rsbuildOptions) {
     return {
         name: RSBUILD_PLUGIN_MODULE_FEDERATION_NAME,
         setup: function(api) {
+            var _ref = rsbuildOptions || {}, _ref_ssr = _ref.ssr, ssr = _ref_ssr === void 0 ? undefined : _ref_ssr, _ref_ssrDir = _ref.ssrDir, ssrDir = _ref_ssrDir === void 0 ? utils.SSR_DIR : _ref_ssrDir, _ref_environment = _ref.environment, environment = _ref_environment === void 0 ? DEFAULT_MF_ENVIRONMENT_NAME : _ref_environment;
+            var callerName = api.context.callerName;
+            var originalRsbuildConfig = api.getRsbuildConfig();
+            if (!callerName) {
+                throw new Error('`callerName` is undefined. Please ensure the @rsbuild/core version is higher than 1.3.21 .');
+            }
+            var isRslib = callerName === constant.CALL_NAME_MAP.RSLIB;
+            var isRspress = callerName === constant.CALL_NAME_MAP.RSPRESS;
+            var isSSR = Boolean(ssr);
+            if (isSSR && !isStoryBook(originalRsbuildConfig)) {
+                var _rsbuildConfig_environments;
+                if (!isRslib && !isRspress) {
+                    throw new Error("'ssr' option is only supported in rslib.");
+                }
+                var rsbuildConfig = api.getRsbuildConfig();
+                if (!((_rsbuildConfig_environments = rsbuildConfig.environments) === null || _rsbuildConfig_environments === void 0 ? void 0 : _rsbuildConfig_environments[environment]) || Object.keys(rsbuildConfig.environments).some(function(key) {
+                    return key.startsWith(environment) && key !== environment;
+                })) {
+                    throw new Error("Please set ".concat(RSBUILD_PLUGIN_NAME, " as global plugin in rslib.config.ts if you set 'ssr:true' ."));
+                }
+                utils.setSSREnv();
+            }
             var sharedOptions = enhanced.parseOptions(moduleFederationOptions.shared || [], function(item, key) {
                 if (typeof item !== 'string') throw new Error('Unexpected array in shared');
                 var config = item === key || !sdk.isRequiredVersion(item) ? {
@@ -81,20 +164,85 @@ var pluginModuleFederation = function(moduleFederationOptions) {
             var shared = sharedOptions.map(function(shared) {
                 return shared[0].endsWith('/') ? shared[0].slice(0, -1) : shared[0];
             });
+            api.modifyRsbuildConfig(function(config) {
+                // skip storybook
+                if (isStoryBook(config)) {
+                    return;
+                }
+                // Change some default configs for remote modules
+                if (moduleFederationOptions.exposes) {
+                    var _userConfig_server, _config_server, _config_dev_client, _originalConfig_dev, _config_server1;
+                    var _config, _config1, // Allow remote modules to be loaded by setting CORS headers
+                    // This is required for MF to work properly across different origins
+                    _config_server2;
+                    (_config = config).dev || (_config.dev = {});
+                    (_config1 = config).server || (_config1.server = {});
+                    var userConfig = api.getRsbuildConfig('original');
+                    (_config_server2 = config.server).headers || (_config_server2.headers = {});
+                    if (!config.server.headers['Access-Control-Allow-Origin'] && !(_type_of((_userConfig_server = userConfig.server) === null || _userConfig_server === void 0 ? void 0 : _userConfig_server.cors) === 'object' && userConfig.server.cors.origin)) {
+                        var corsWarnMsgs = [
+                            'Detect that CORS options are not set, mf Rsbuild plugin will add default cors header: server.headers["Access-Control-Allow-Headers"] = "*". It is recommended to specify an allowlist of trusted origins in "server.cors" instead.',
+                            'View https://module-federation.io/guide/troubleshooting/other.html#cors-warn for more details.'
+                        ];
+                        !isRslib && !isRspress && logger.warn(corsWarnMsgs.join('\n'));
+                        config.server.headers['Access-Control-Allow-Origin'] = '*';
+                    }
+                    // For remote modules, Rsbuild should send the ws request to the provider's dev server.
+                    // This allows the provider to do HMR when the provider module is loaded in the consumer's page.
+                    if (((_config_server = config.server) === null || _config_server === void 0 ? void 0 : _config_server.port) && !((_config_dev_client = config.dev.client) === null || _config_dev_client === void 0 ? void 0 : _config_dev_client.port)) {
+                        var _config_dev;
+                        (_config_dev = config.dev).client || (_config_dev.client = {});
+                        config.dev.client.port = config.server.port;
+                    }
+                    // Change the default assetPrefix to `true` for remote modules.
+                    // This ensures that the remote module's assets can be requested by consumer apps with the correct URL.
+                    var originalConfig = api.getRsbuildConfig('original');
+                    if (((_originalConfig_dev = originalConfig.dev) === null || _originalConfig_dev === void 0 ? void 0 : _originalConfig_dev.assetPrefix) === undefined && config.dev.assetPrefix === ((_config_server1 = config.server) === null || _config_server1 === void 0 ? void 0 : _config_server1.base)) {
+                        config.dev.assetPrefix = true;
+                    }
+                }
+                if (isSSR) {
+                    var _config_environments, _config_environments1;
+                    if ((_config_environments = config.environments) === null || _config_environments === void 0 ? void 0 : _config_environments[utils.SSR_ENV_NAME]) {
+                        throw new Error("'".concat(utils.SSR_ENV_NAME, "' environment is already defined. Please use another name."));
+                    }
+                    config.environments[utils.SSR_ENV_NAME] = utils.createSSRREnvConfig((_config_environments1 = config.environments) === null || _config_environments1 === void 0 ? void 0 : _config_environments1[environment], moduleFederationOptions, ssrDir, config, callerName);
+                }
+            });
+            api.modifyEnvironmentConfig(function(config) {
+                // Module Federation runtime uses ES6+ syntax,
+                // adding to include and let SWC transform it
+                config.source.include = _to_consumable_array(config.source.include || []).concat([
+                    /@module-federation[\\/]/
+                ]);
+                return config;
+            });
+            var generateMergedStatsAndManifestOptions = {
+                options: {
+                    nodePlugin: undefined,
+                    browserPlugin: undefined,
+                    distOutputDir: undefined
+                },
+                isSSRConfig: isSSRConfig,
+                isRspressSSGConfig: isRspressSSGConfig
+            };
+            api.expose(RSBUILD_PLUGIN_MODULE_FEDERATION_NAME, generateMergedStatsAndManifestOptions);
             api.onBeforeCreateCompiler(function(param) {
                 var bundlerConfigs = param.bundlerConfigs;
                 if (!bundlerConfigs) {
                     throw new Error('Can not get bundlerConfigs!');
                 }
                 bundlerConfigs.forEach(function(bundlerConfig) {
-                    if (!isMFFormat(bundlerConfig)) {
+                    if (!isMFFormat(bundlerConfig) && !isRspress) {
                         return;
-                    } else if (isStoryBook(api.getRsbuildConfig())) {
+                    } else if (isStoryBook(originalRsbuildConfig)) {
                         bundlerConfig.output.uniqueName = "".concat(moduleFederationOptions.name, "-storybook-host");
                     } else {
-                        var _bundlerConfig_optimization, _bundlerConfig_output, _bundlerConfig_output1;
+                        var _bundlerConfig_optimization, _bundlerConfig_optimization1, _bundlerConfig_output, _bundlerConfig_output1;
                         // mf
                         utils.autoDeleteSplitChunkCacheGroups(moduleFederationOptions, bundlerConfig === null || bundlerConfig === void 0 ? void 0 : (_bundlerConfig_optimization = bundlerConfig.optimization) === null || _bundlerConfig_optimization === void 0 ? void 0 : _bundlerConfig_optimization.splitChunks);
+                        utils.addDataFetchExposes(moduleFederationOptions.exposes, isSSRConfig(bundlerConfig.name));
+                        (_bundlerConfig_optimization1 = bundlerConfig.optimization) === null || _bundlerConfig_optimization1 === void 0 ? true : delete _bundlerConfig_optimization1.runtimeChunk;
                         var externals = bundlerConfig.externals;
                         if (Array.isArray(externals)) {
                             var sharedModules = new Set();
@@ -152,8 +300,9 @@ var pluginModuleFederation = function(moduleFederationOptions) {
                                 }
                             }
                         }
-                        if (!((_bundlerConfig_output = bundlerConfig.output) === null || _bundlerConfig_output === void 0 ? void 0 : _bundlerConfig_output.chunkLoadingGlobal)) {
+                        if (!((_bundlerConfig_output = bundlerConfig.output) === null || _bundlerConfig_output === void 0 ? void 0 : _bundlerConfig_output.chunkLoadingGlobal) && !isSSRConfig(bundlerConfig.name) && !isRspressSSGConfig(bundlerConfig.name)) {
                             bundlerConfig.output.chunkLoading = 'jsonp';
+                            bundlerConfig.output.chunkLoadingGlobal = "chunk_".concat(moduleFederationOptions.name);
                         }
                         // `uniqueName` is required for react refresh to work
                         if (!((_bundlerConfig_output1 = bundlerConfig.output) === null || _bundlerConfig_output1 === void 0 ? void 0 : _bundlerConfig_output1.uniqueName)) {
@@ -162,71 +311,61 @@ var pluginModuleFederation = function(moduleFederationOptions) {
                         if (!bundlerConfig.plugins.find(function(p) {
                             return p && p.name === rspack.PLUGIN_NAME;
                         })) {
-                            bundlerConfig.plugins.push(new rspack.ModuleFederationPlugin(moduleFederationOptions));
+                            var _bundlerConfig_output2;
+                            if (isSSRConfig(bundlerConfig.name)) {
+                                generateMergedStatsAndManifestOptions.options.nodePlugin = new rspack.ModuleFederationPlugin(utils.createSSRMFConfig(moduleFederationOptions));
+                                bundlerConfig.plugins.push(generateMergedStatsAndManifestOptions.options.nodePlugin);
+                                return;
+                            } else if (isRspressSSGConfig(bundlerConfig.name)) {
+                                var _bundlerConfig;
+                                var mfConfig = _object_spread_props(_object_spread({}, utils.createSSRMFConfig(moduleFederationOptions)), {
+                                    // expose in mf-ssg env
+                                    exposes: {},
+                                    manifest: false,
+                                    library: undefined
+                                });
+                                utils.patchSSRRspackConfig(bundlerConfig, mfConfig, constant.RSPRESS_SSR_DIR, callerName, false, false);
+                                (_bundlerConfig = bundlerConfig).output || (_bundlerConfig.output = {});
+                                bundlerConfig.output.publicPath = '/';
+                                // MF depend on asyncChunks
+                                bundlerConfig.output.asyncChunks = undefined;
+                                generateMergedStatsAndManifestOptions.options.rspressSSGPlugin = new rspack.ModuleFederationPlugin(mfConfig);
+                                bundlerConfig.plugins.push(generateMergedStatsAndManifestOptions.options.rspressSSGPlugin);
+                                return;
+                            }
+                            generateMergedStatsAndManifestOptions.options.browserPlugin = new rspack.ModuleFederationPlugin(moduleFederationOptions);
+                            generateMergedStatsAndManifestOptions.options.distOutputDir = ((_bundlerConfig_output2 = bundlerConfig.output) === null || _bundlerConfig_output2 === void 0 ? void 0 : _bundlerConfig_output2.path) || '';
+                            bundlerConfig.plugins.push(generateMergedStatsAndManifestOptions.options.browserPlugin);
                         }
                     }
                 });
             });
-            // dev config only works on format: 'mf'
-            api.modifyRsbuildConfig(function(config) {
-                // skip storybook
-                if (isStoryBook(config)) {
+            var generateMergedStatsAndManifest = function() {
+                var _generateMergedStatsAndManifestOptions_options = generateMergedStatsAndManifestOptions.options, nodePlugin = _generateMergedStatsAndManifestOptions_options.nodePlugin, browserPlugin = _generateMergedStatsAndManifestOptions_options.browserPlugin, distOutputDir = _generateMergedStatsAndManifestOptions_options.distOutputDir;
+                if (!nodePlugin || !browserPlugin || !distOutputDir) {
                     return;
                 }
-                // Change some default configs for remote modules
-                if (moduleFederationOptions.exposes) {
-                    var _userConfig_server, _config_server, _config_dev_client, _originalConfig_dev, _config_server1;
-                    var _config, _config1, // Allow remote modules to be loaded by setting CORS headers
-                    // This is required for MF to work properly across different origins
-                    _config_server2;
-                    (_config = config).dev || (_config.dev = {});
-                    (_config1 = config).server || (_config1.server = {});
-                    var userConfig = api.getRsbuildConfig('original');
-                    (_config_server2 = config.server).headers || (_config_server2.headers = {});
-                    if (!config.server.headers['Access-Control-Allow-Origin'] && !(_type_of((_userConfig_server = userConfig.server) === null || _userConfig_server === void 0 ? void 0 : _userConfig_server.cors) === 'object' && userConfig.server.cors.origin)) {
-                        var corsWarnMsgs = [
-                            'Detect that CORS options are not set, mf Rsbuild plugin will add default cors header: server.headers["Access-Control-Allow-Headers"] = "*". It is recommended to specify an allowlist of trusted origins in "server.cors" instead.',
-                            'View https://module-federation.io/guide/troubleshooting/other.html#cors-warn for more details.'
-                        ];
-                        logger.warn(corsWarnMsgs.join('\n'));
-                        config.server.headers['Access-Control-Allow-Origin'] = '*';
-                    }
-                    // For remote modules, Rsbuild should send the ws request to the provider's dev server.
-                    // This allows the provider to do HMR when the provider module is loaded in the consumer's page.
-                    if (((_config_server = config.server) === null || _config_server === void 0 ? void 0 : _config_server.port) && !((_config_dev_client = config.dev.client) === null || _config_dev_client === void 0 ? void 0 : _config_dev_client.port)) {
-                        var _config_dev;
-                        (_config_dev = config.dev).client || (_config_dev.client = {});
-                        config.dev.client.port = config.server.port;
-                    }
-                    // Change the default assetPrefix to `true` for remote modules.
-                    // This ensures that the remote module's assets can be requested by consumer apps with the correct URL.
-                    var originalConfig = api.getRsbuildConfig('original');
-                    if (((_originalConfig_dev = originalConfig.dev) === null || _originalConfig_dev === void 0 ? void 0 : _originalConfig_dev.assetPrefix) === undefined && config.dev.assetPrefix === ((_config_server1 = config.server) === null || _config_server1 === void 0 ? void 0 : _config_server1.base)) {
-                        config.dev.assetPrefix = true;
-                    }
-                }
+                utils.updateStatsAndManifest(nodePlugin, browserPlugin, distOutputDir);
+            };
+            api.onDevCompileDone(function() {
+                generateMergedStatsAndManifest();
             });
-            api.modifyEnvironmentConfig(function(config) {
-                // Module Federation runtime uses ES6+ syntax,
-                // adding to include and let SWC transform it
-                config.source.include = _to_consumable_array(config.source.include || []).concat([
-                    /@module-federation[\\/]/
-                ]);
-                return config;
+            api.onAfterBuild(function() {
+                generateMergedStatsAndManifest();
             });
         }
     };
 };
 
-Object.defineProperty(exports, "createModuleFederationConfig", {
-  enumerable: true,
-  get: function () { return enhanced.createModuleFederationConfig; }
-});
 Object.defineProperty(exports, "PLUGIN_NAME", {
   enumerable: true,
   get: function () { return rspack.PLUGIN_NAME; }
 });
+Object.defineProperty(exports, "createModuleFederationConfig", {
+  enumerable: true,
+  get: function () { return sdk.createModuleFederationConfig; }
+});
+exports.SSR_DIR = utils.SSR_DIR;
 exports.RSBUILD_PLUGIN_MODULE_FEDERATION_NAME = RSBUILD_PLUGIN_MODULE_FEDERATION_NAME;
-exports.RSPACK_PLUGIN_MODULE_FEDERATION_NAME = RSPACK_PLUGIN_MODULE_FEDERATION_NAME;
 exports.isMFFormat = isMFFormat;
 exports.pluginModuleFederation = pluginModuleFederation;