@module-federation/metro-plugin-rnef 0.0.0-next-20250827124348

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Callstack and Zephyr Cloud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,85 @@
+# @module-federation/metro-plugin-rnef
+
+Module Federation for React Native Enterprise Framework (RNEF) using Metro bundler. This plugin integrates the `@module-federation/metro` package with RNEF, providing commands to bundle Module Federation host and remotes.
+
+## Installation
+
+1. First, ensure you have [RNEF](https://github.com/callstack/rnef) set up in your project.
+
+2. Install the plugin:
+
+```bash
+npm install --save-dev @module-federation/metro-plugin-rnef
+```
+
+3. Add the plugin to your RNEF configuration (typically in `rnef.config.mjs`):
+
+```typescript
+import { pluginMetro } from "@rnef/plugin-metro";
+import moduleFederation from "@module-federation/metro-plugin-rnef";
+
+/** @type {import('@rnef/config').Config} */
+export default {
+  bundler: pluginMetro(),
+  plugins: [moduleFederation()],
+};
+```
+
+## Usage
+
+### Bundle a Module Federation Host
+
+```bash
+# Bundle for iOS
+rnef bundle-mf-host --entry-file index.js --platform ios
+
+# Bundle for Android
+rnef bundle-mf-host --entry-file index.js --platform android
+```
+
+### Bundle a Module Federation Remote
+
+```bash
+# Bundle for iOS
+rnef bundle-mf-remote --platform ios
+
+# Bundle for Android
+rnef bundle-mf-remote --platform android
+```
+
+### Available Options
+
+#### `bundle-mf-host`
+
+- `--entry-file <path>`: Path to the root JavaScript entry file
+- `--platform <string>`: Target platform (default: "ios") - Either "ios" or "android"
+- `--transformer <string>`: Specify a custom transformer
+- `--dev [boolean]`: If false, warnings are disabled and the bundle is minified (default: true)
+- `--minify [boolean]`: Allows overriding whether bundle is minified. This defaults to false if dev is true, and true if dev is false. Disabling minification can be useful for speeding up production builds for testing purposes.
+- `--bundle-output <string>`: File path where to store the resulting bundle
+- `--bundle-encoding <string>`: Encoding the bundle should be written in (default: "utf8")
+- `--resolver-option <string...>`: Custom resolver options (key=value format, URL-encoded, can be specified multiple times)
+- `--sourcemap-output <string>`: File name where to store the sourcemap file for resulting bundle, ex. /tmp/groups.map
+- `--sourcemap-sources-root <string>`: Path to make sourcemap's sources entries relative to, ex. /root/dir
+- `--sourcemap-use-absolute-path`: Report SourceMapURL using its full path (default: false)
+- `--max-workers <number>`: Specifies the maximum number of workers the worker-pool will spawn for transforming files. This defaults to the number of the cores available on your machine.
+- `--assets-dest <string>`: Directory name where to store assets referenced in the bundle
+- `--reset-cache`: Removes cached files (default: false)
+- `--read-global-cache`: Try to fetch transformed JS code from the global cache, if configured (default: false)
+- `--config <string>`: Path to the CLI configuration file
+
+#### `bundle-mf-remote`
+
+- `--platform <string>`: Target platform (default: "ios") - Either "ios" or "android"
+- `--dev [boolean]`: If false, warnings are disabled and the bundle is minified (default: true)
+- `--minify [boolean]`: Allows overriding whether bundle is minified. This defaults to false if dev is true, and true if dev is false. Disabling minification can be useful for speeding up production builds for testing purposes.
+- `--bundle-encoding <string>`: Encoding the bundle should be written in (default: "utf8")
+- `--max-workers <number>`: Specifies the maximum number of workers the worker-pool will spawn for transforming files. This defaults to the number of the cores available on your machine.
+- `--bundle-output <string>`: File path where to store the resulting bundle
+- `--sourcemap-output <string>`: File name where to store the sourcemap file for resulting bundle, ex. /tmp/groups.map
+- `--sourcemap-sources-root <string>`: Path to make sourcemap's sources entries relative to, ex. /root/dir
+- `--sourcemap-use-absolute-path`: Report SourceMapURL using its full path (default: false)
+- `--assets-dest <string>`: Directory name where to store assets referenced in the bundle
+- `--asset-catalog-dest [string]`: Path where to create an iOS Asset Catalog for images
+- `--reset-cache`: Removes cached files (default: false)
+- `--config <string>`: Path to the CLI configuration file

package/dist/index.cjs

@@ -0,0 +1,40 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.d = (exports1, definition)=>{
+        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+            enumerable: true,
+            get: definition[key]
+        });
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+__webpack_require__.d(__webpack_exports__, {
+    pluginMetroModuleFederation: ()=>external_plugin_cjs_namespaceObject.pluginMetroModuleFederation,
+    default: ()=>src
+});
+const external_plugin_cjs_namespaceObject = require("./plugin.cjs");
+const src = external_plugin_cjs_namespaceObject.pluginMetroModuleFederation;
+exports["default"] = __webpack_exports__["default"];
+exports.pluginMetroModuleFederation = __webpack_exports__.pluginMetroModuleFederation;
+for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+    "default",
+    "pluginMetroModuleFederation"
+].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { pluginMetroModuleFederation } from './plugin.js';
+export { pluginMetroModuleFederation };
+export default pluginMetroModuleFederation;

package/dist/index.js

@@ -0,0 +1,3 @@
+import { pluginMetroModuleFederation } from "./plugin.js";
+const src = pluginMetroModuleFederation;
+export { src as default, pluginMetroModuleFederation };

package/dist/plugin.cjs

@@ -0,0 +1,93 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.n = (module)=>{
+        var getter = module && module.__esModule ? ()=>module['default'] : ()=>module;
+        __webpack_require__.d(getter, {
+            a: getter
+        });
+        return getter;
+    };
+})();
+(()=>{
+    __webpack_require__.d = (exports1, definition)=>{
+        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+            enumerable: true,
+            get: definition[key]
+        });
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+__webpack_require__.d(__webpack_exports__, {
+    pluginMetroModuleFederation: ()=>pluginMetroModuleFederation
+});
+const commands_namespaceObject = require("@module-federation/metro/commands");
+var commands_default = /*#__PURE__*/ __webpack_require__.n(commands_namespaceObject);
+const tools_namespaceObject = require("@rnef/tools");
+const pluginMetroModuleFederation = (pluginConfig = {})=>(api)=>{
+        api.registerCommand({
+            name: 'bundle-mf-host',
+            description: 'Bundles a Module Federation host',
+            action: async (args)=>{
+                const commandConfig = {
+                    root: api.getProjectRoot(),
+                    platforms: api.getPlatforms(),
+                    reactNativePath: api.getReactNativePath(),
+                    ...pluginConfig
+                };
+                tools_namespaceObject.logger.info(`Bundling Module Federation host for platform ${tools_namespaceObject.color.cyan(args.platform)}`);
+                await commands_default().bundleFederatedHost([], commandConfig, args);
+                tools_namespaceObject.logger.info('Bundle artifacts available at ...');
+                (0, tools_namespaceObject.outro)("Success \uD83C\uDF89.");
+            },
+            options: [
+                ...commands_default().bundleFederatedHostOptions,
+                {
+                    name: '--config-cmd [string]',
+                    description: "[Internal] A hack for Xcode build script pointing to wrong bundle command that recognizes this flag. Do not use."
+                }
+            ]
+        });
+        api.registerCommand({
+            name: 'bundle-mf-remote',
+            description: 'Bundles a Module Federation remote, including its container entry and all exposed modules for consumption by host applications',
+            action: async (args)=>{
+                const commandConfig = {
+                    root: api.getProjectRoot(),
+                    platforms: api.getPlatforms(),
+                    reactNativePath: api.getReactNativePath(),
+                    ...pluginConfig
+                };
+                tools_namespaceObject.logger.info(`Bundling Module Federation remote for platform ${tools_namespaceObject.color.cyan(args.platform)}`);
+                await commands_default().bundleFederatedRemote([], commandConfig, args);
+                tools_namespaceObject.logger.info('Bundle artifacts available at ...');
+                (0, tools_namespaceObject.outro)("Success \uD83C\uDF89.");
+            },
+            options: commands_default().bundleFederatedRemoteOptions
+        });
+        return {
+            name: '@module-federation/metro-plugin-rnef',
+            description: 'RNEF plugin for Module Federation with Metro'
+        };
+    };
+exports.pluginMetroModuleFederation = __webpack_exports__.pluginMetroModuleFederation;
+for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+    "pluginMetroModuleFederation"
+].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/plugin.d.ts

@@ -0,0 +1,6 @@
+import type { PluginApi, PluginOutput } from '@rnef/config';
+interface PluginConfig {
+    platforms?: Record<string, object>;
+}
+export declare const pluginMetroModuleFederation: (pluginConfig?: PluginConfig) => (api: PluginApi) => PluginOutput;
+export {};

package/dist/plugin.js

@@ -0,0 +1,49 @@
+import commands from "@module-federation/metro/commands";
+import { color, logger, outro } from "@rnef/tools";
+const pluginMetroModuleFederation = (pluginConfig = {})=>(api)=>{
+        api.registerCommand({
+            name: 'bundle-mf-host',
+            description: 'Bundles a Module Federation host',
+            action: async (args)=>{
+                const commandConfig = {
+                    root: api.getProjectRoot(),
+                    platforms: api.getPlatforms(),
+                    reactNativePath: api.getReactNativePath(),
+                    ...pluginConfig
+                };
+                logger.info(`Bundling Module Federation host for platform ${color.cyan(args.platform)}`);
+                await commands.bundleFederatedHost([], commandConfig, args);
+                logger.info('Bundle artifacts available at ...');
+                outro("Success \uD83C\uDF89.");
+            },
+            options: [
+                ...commands.bundleFederatedHostOptions,
+                {
+                    name: '--config-cmd [string]',
+                    description: "[Internal] A hack for Xcode build script pointing to wrong bundle command that recognizes this flag. Do not use."
+                }
+            ]
+        });
+        api.registerCommand({
+            name: 'bundle-mf-remote',
+            description: 'Bundles a Module Federation remote, including its container entry and all exposed modules for consumption by host applications',
+            action: async (args)=>{
+                const commandConfig = {
+                    root: api.getProjectRoot(),
+                    platforms: api.getPlatforms(),
+                    reactNativePath: api.getReactNativePath(),
+                    ...pluginConfig
+                };
+                logger.info(`Bundling Module Federation remote for platform ${color.cyan(args.platform)}`);
+                await commands.bundleFederatedRemote([], commandConfig, args);
+                logger.info('Bundle artifacts available at ...');
+                outro("Success \uD83C\uDF89.");
+            },
+            options: commands.bundleFederatedRemoteOptions
+        });
+        return {
+            name: '@module-federation/metro-plugin-rnef',
+            description: 'RNEF plugin for Module Federation with Metro'
+        };
+    };
+export { pluginMetroModuleFederation };

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@module-federation/metro-plugin-rnef",
+  "version": "0.0.0-next-20250827124348",
+  "description": "Metro Module Federation plugin for React Native Enterprise Framework (RNEF)",
+  "keywords": [
+    "rnef",
+    "module-federation",
+    "metro",
+    "react-native"
+  ],
+  "type": "module",
+  "license": "MIT",
+  "contributors": [
+    "Jakub Romańczyk <j.romanczyk@gmail.com> (https://github.com/jbroma)",
+    "Kacper Wiszczuk <kacperwiszczuk@gmail.com> (https://github.com/esemesek)"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/module-federation/core",
+    "directory": "packages/metro-plugin-rnef"
+  },
+  "files": [
+    "dist/"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "require": "./dist/index.cjs",
+    "default": "./dist/index.js"
+  },
+  "peerDependencies": {
+    "@rnef/tools": "^0.7.18",
+    "@module-federation/metro": "0.0.0-next-20250827124348"
+  },
+  "devDependencies": {
+    "@rnef/config": "^0.7.18",
+    "@rnef/tools": "^0.7.18",
+    "@rslib/core": "^0.10.0",
+    "@types/node": "^20.0.0",
+    "typescript": "^5.8.3",
+    "@module-federation/metro": "0.0.0-next-20250827124348"
+  },
+  "scripts": {
+    "build": "rslib build",
+    "typecheck": "tsc --noEmit"
+  }
+}