@module-federation/electron 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1 +1,24 @@
 # Changelog
+
+## [0.2.0](https://github.com/module-federation/electron/compare/0.1.1...0.2.0) (2026-11-09)
+
+
+### Features
+
+* load remotes from a URL with an offline cache ([#12](https://github.com/module-federation/electron/issues/12)) ([fbd816a](https://github.com/module-federation/electron/commit/fbd816ad54b6751b25a6835d2da9e6833d1b2872))
+
+## [0.1.1](https://github.com/module-federation/electron/compare/0.1.0...0.1.1) (2026-11-04)
+
+
+### Documentation
+
+* list requirements in the package README ([#9](https://github.com/module-federation/electron/issues/9)) ([c35a574](https://github.com/module-federation/electron/commit/c35a574dfbe2e47354db63c48007279e9338b44a))
+
+## [0.1.0](https://github.com/module-federation/electron/compare/0.0.1...0.1.0) (2026-11-04)
+
+
+### Features
+
+* add Electron integration for Rsbuild and Vite ([#4](https://github.com/module-federation/electron/issues/4)) ([edd080c](https://github.com/module-federation/electron/commit/edd080cfba75f9eb1829fd608ed649ca26dd8494))
+
+## Changelog

package/README.md

@@ -1,3 +1,178 @@
-# @module-federation/electron
+<h1 align="center">@module-federation/electron</h1>
 
-Project scaffold for a future Module Federation integration for Electron. No integration API is available yet.
+<p align="center">
+  <a href="https://www.npmjs.com/package/@module-federation/electron">
+    <img src="https://img.shields.io/npm/v/@module-federation/electron?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
+  </a>
+  <a href="https://npmcharts.com/compare/@module-federation/electron?minimal=true">
+    <img src="https://img.shields.io/npm/dm/@module-federation/electron.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" />
+  </a>
+  <a href="https://github.com/module-federation/electron/blob/main/LICENSE">
+    <img src="https://img.shields.io/npm/l/@module-federation/electron?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
+  </a>
+</p>
+
+Module Federation for Electron renderers built with Rsbuild or Vite. Hosts and remotes can use either bundler.
+
+In production every federated app is served from one privileged custom protocol, `mf://local/<app-id>/`. All apps share one origin, so remote entries, manifests and chunks load without CORS setup, whether an app's files sit on disk or come from a CDN. Remotes fetched from a URL are cached on disk, so the app keeps working offline.
+
+## Install
+
+```sh
+pnpm add @module-federation/electron
+# plus the Module Federation plugin for each bundler you use:
+pnpm add -D @module-federation/rsbuild-plugin   # Rsbuild
+pnpm add -D @module-federation/vite             # Vite, 1.23.9 or later
+```
+
+Requires Electron 30 or later and Node.js 22.18+, 24.11+ or 26+ for builds. Rsbuild 2 and Vite 7 or 8 are supported.
+
+## Main process
+
+```ts
+import { app, BrowserWindow } from 'electron';
+import {
+  federationUrl,
+  registerFederationScheme,
+  serveFederatedApps,
+} from '@module-federation/electron';
+
+registerFederationScheme(); // before `app` is ready
+
+app.whenReady().then(() => {
+  serveFederatedApps({
+    apps: { host: '/path/to/host/dist', remote: '/path/to/remote/dist' },
+  });
+  new BrowserWindow().loadURL(federationUrl('host', 'index.html'));
+});
+```
+
+`serveFederatedApps` maps each federation `name` to its build directory and returns a function that unregisters the handler. Requests outside an app's directory get a 404.
+
+## Remotes deployed to a URL
+
+An app can also be an `http(s)` URL. Requests for `mf://local/<app-id>/<path>` are fetched from `<url>/<path>` in the main process, so the renderer still sees one origin and needs no CORS setup:
+
+```ts
+serveFederatedApps({
+  apps: {
+    host: '/path/to/host/dist',
+    remote: 'https://cdn.example.com/remote/',
+  },
+});
+```
+
+Build the remote with the Rsbuild or Vite plugin from this package, so its chunks load from `mf://local/<app-id>/` too. A remote whose `publicPath` is an absolute `https://` URL loads its chunks directly, without the offline cache.
+
+### Offline cache
+
+Responses from remote apps are cached on disk, so the app keeps working when a remote is down:
+
+| Situation                                                                       | Response                                                                                   |
+| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
+| Remote answers 2xx                                                              | The fresh response. It replaces the cached copy.                                           |
+| Offline, DNS failure, connection refused                                        | The cached copy.                                                                           |
+| Remote answers an error status (a broken deploy returning 500 or 404)           | The cached copy. Error responses are never cached.                                         |
+| No response within the connect timeout, or the body stalls for the read timeout | The cached copy. For the next 30 s, other cached requests to that origin skip the network. |
+| Not reachable and never cached (first launch offline)                           | `502`, or `504` on a timeout. Module Federation reports a failed remote.                   |
+
+- **Network first.** The cache is used only when the network fails, so a remote that is up serves its latest release. After any failed request, other cached requests to that origin skip the network for 30 s, so a remote that has just recovered is picked up after that window.
+- **Only `GET` responses are cached**, together with their headers, so ES module remotes still pass MIME checks offline. Query strings are ignored, so cache-busting parameters still hit the cache.
+- Responses served from the cache carry an `x-mf-cache: stale` header (exported as `CACHE_HEADER`). Fallbacks are logged with `console.warn`.
+- Writes go through a temporary file and a rename, so a crash never leaves a partial entry. To reset the cache, quit the app and delete its directory.
+
+```ts
+serveFederatedApps({
+  apps: { remote: 'https://cdn.example.com/remote/' },
+  cache: {
+    dir: path.join(app.getPath('userData'), 'remotes'), // default: <sessionData>/module-federation
+    connectTimeout: 10_000, // ms to wait for response headers
+    readTimeout: 10_000, // ms the body may stall, not a limit on the whole download
+  },
+});
+```
+
+Pass `cache: false` to proxy remote apps without caching.
+
+## Rsbuild
+
+`./rsbuild` and `./vite` re-export the URL helpers, so build configs don't load `electron`.
+
+```ts
+import { defineConfig } from '@rsbuild/core';
+import { federationUrl, pluginModuleFederationElectron } from '@module-federation/electron/rsbuild';
+
+export default defineConfig({
+  plugins: [
+    pluginModuleFederationElectron({
+      name: 'host',
+      remotes: { remote: `remote@${federationUrl('remote', 'mf-manifest.json')}` },
+    }),
+  ],
+});
+```
+
+## Vite
+
+```ts
+import { defineConfig } from 'vite';
+import { federationElectron } from '@module-federation/electron/vite';
+
+export default defineConfig({
+  plugins: [
+    federationElectron({
+      name: 'remote',
+      exposes: { './Card': './src/Card.tsx' },
+    }),
+  ],
+});
+```
+
+## Options
+
+Both plugins take a second argument, `{ electron: { protocol, scheme, host } }`:
+
+- `protocol` (default `true`): set `output.assetPrefix` (Rsbuild) or `base` (Vite) to `mf://local/<app-id>/` for production builds. Dev servers, explicit values, and `protocol: false` are left alone.
+- `scheme` / `host` (default `mf` / `local`): change the URL. Pass the same values to `registerFederationScheme` and `serveFederatedApps`.
+
+The Rsbuild plugin also takes `{ rsbuild }`, which is passed through to `@module-federation/rsbuild-plugin`.
+
+## API
+
+From `@module-federation/electron` (main process only, it imports `electron`):
+
+| Export                                                 | Description                                                                                                |
+| ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- |
+| `registerFederationScheme({ scheme? })`                | Registers the scheme as privileged (standard, secure, fetch, CORS, streaming). Call before `app` is ready. |
+| `serveFederatedApps({ apps, cache?, scheme?, host? })` | Serves each app from its directory or URL. Call after `app.whenReady()`. Returns an unregister function.   |
+| `resolveAppFile(pathname, dirs)`                       | Resolves an `mf://` path to a file inside an app's directory, or `undefined` if it falls outside.          |
+| `CACHE_HEADER`                                         | `'x-mf-cache'`, set to `stale` on responses served from the offline cache.                                 |
+
+From every entry point, including `./rsbuild` and `./vite`:
+
+| Export                                | Description                                                                               |
+| ------------------------------------- | ----------------------------------------------------------------------------------------- |
+| `federationUrl(name, file, options?)` | URL of a file inside an app, e.g. `mf://local/remote-vite/mf-manifest.json`.              |
+| `federationBaseUrl(name, options?)`   | Base URL an app is served from, e.g. `mf://local/remote-vite/`.                           |
+| `toAppId(name)`                       | Normalizes a federation `name` into the URL path segment (`remote_vite` → `remote-vite`). |
+| `DEFAULT_SCHEME`, `DEFAULT_HOST`      | `'mf'` and `'local'`.                                                                     |
+
+From `./rsbuild`: `pluginModuleFederationElectron(federation, { electron?, rsbuild? })`, and `pluginElectron(name, options?)` if you register `@module-federation/rsbuild-plugin` yourself.
+
+From `./vite`: `federationElectron(federation, { electron? })`, and `electron(name, options?)` if you register `@module-federation/vite` yourself.
+
+## Troubleshooting
+
+- **A Vite remote's React bindings are `undefined` in an Rsbuild host**: use `@module-federation/vite` 1.23.9 or later ([module-federation/vite#1535](https://github.com/module-federation/vite/issues/1535)).
+- **`does not provide an export named 'net'`**: `ELECTRON_RUN_AS_NODE=1` is set, usually by a terminal inside VS Code or another Electron app. Unset it before starting Electron.
+
+## Links
+
+- [Repository and examples](https://github.com/module-federation/electron)
+- [Module Federation documentation](https://module-federation.io/)
+- [Discord](https://discord.gg/n69NnT3ACV)
+- [Issues](https://github.com/module-federation/electron/issues)
+
+## License
+
+[MIT](https://github.com/module-federation/electron/blob/main/LICENSE)

package/dist/index.cjs

@@ -1,5 +1,29 @@
 "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, getters, values)=>{
+        var define = (defs, kind)=>{
+            for(var key in defs)if (__webpack_require__.o(defs, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+                enumerable: true,
+                [kind]: defs[key]
+            });
+        };
+        define(getters, "get");
+        define(values, "value");
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
 (()=>{
     __webpack_require__.r = (exports1)=>{
         if ("u" > typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
@@ -12,7 +36,86 @@ var __webpack_require__ = {};
 })();
 var __webpack_exports__ = {};
 __webpack_require__.r(__webpack_exports__);
-for(var __rspack_i in __webpack_exports__)exports[__rspack_i] = __webpack_exports__[__rspack_i];
+__webpack_require__.d(__webpack_exports__, {
+    CACHE_HEADER: ()=>external_remote_cjs_namespaceObject.CACHE_HEADER,
+    DEFAULT_HOST: ()=>external_url_cjs_namespaceObject.DEFAULT_HOST,
+    DEFAULT_SCHEME: ()=>external_url_cjs_namespaceObject.DEFAULT_SCHEME,
+    federationBaseUrl: ()=>external_url_cjs_namespaceObject.federationBaseUrl,
+    federationUrl: ()=>external_url_cjs_namespaceObject.federationUrl,
+    registerFederationScheme: ()=>registerFederationScheme,
+    resolveAppFile: ()=>external_resolve_cjs_namespaceObject.resolveAppFile,
+    serveFederatedApps: ()=>serveFederatedApps,
+    toAppId: ()=>external_url_cjs_namespaceObject.toAppId
+});
+const external_node_path_namespaceObject = require("node:path");
+var external_node_path_default = /*#__PURE__*/ __webpack_require__.n(external_node_path_namespaceObject);
+const external_node_url_namespaceObject = require("node:url");
+const external_electron_namespaceObject = require("electron");
+const external_remote_cjs_namespaceObject = require("./remote.cjs");
+const external_resolve_cjs_namespaceObject = require("./resolve.cjs");
+const external_url_cjs_namespaceObject = require("./url.cjs");
+function registerFederationScheme(options = {}) {
+    external_electron_namespaceObject.protocol.registerSchemesAsPrivileged([
+        {
+            scheme: options.scheme ?? external_url_cjs_namespaceObject.DEFAULT_SCHEME,
+            privileges: {
+                standard: true,
+                secure: true,
+                supportFetchAPI: true,
+                corsEnabled: true,
+                stream: true,
+                codeCache: true
+            }
+        }
+    ]);
+}
+function serveFederatedApps(options) {
+    const scheme = options.scheme ?? external_url_cjs_namespaceObject.DEFAULT_SCHEME;
+    const host = options.host ?? external_url_cjs_namespaceObject.DEFAULT_HOST;
+    const dirs = {};
+    const urls = {};
+    for (const [name, location] of Object.entries(options.apps))((0, external_remote_cjs_namespaceObject.isRemoteLocation)(location) ? urls : dirs)[(0, external_url_cjs_namespaceObject.toAppId)(name)] = location;
+    const fetchRemote = (0, external_remote_cjs_namespaceObject.createRemoteHandler)({
+        fetch: (url, init)=>external_electron_namespaceObject.net.fetch(url, init),
+        cache: false === options.cache ? false : {
+            ...options.cache,
+            dir: options.cache?.dir ?? external_node_path_default().join(external_electron_namespaceObject.app.getPath('sessionData'), 'module-federation')
+        }
+    });
+    external_electron_namespaceObject.protocol.handle(scheme, async (request)=>{
+        const url = new URL(request.url);
+        if (url.host === host) {
+            const upstream = (0, external_remote_cjs_namespaceObject.resolveAppUrl)(url, urls);
+            if (upstream) return fetchRemote(request, upstream);
+            const file = (0, external_resolve_cjs_namespaceObject.resolveAppFile)(url.pathname, dirs);
+            if (file) return external_electron_namespaceObject.net.fetch((0, external_node_url_namespaceObject.pathToFileURL)(file).href);
+        }
+        return new Response('Not found', {
+            status: 404
+        });
+    });
+    return ()=>external_electron_namespaceObject.protocol.unhandle(scheme);
+}
+exports.CACHE_HEADER = __webpack_exports__.CACHE_HEADER;
+exports.DEFAULT_HOST = __webpack_exports__.DEFAULT_HOST;
+exports.DEFAULT_SCHEME = __webpack_exports__.DEFAULT_SCHEME;
+exports.federationBaseUrl = __webpack_exports__.federationBaseUrl;
+exports.federationUrl = __webpack_exports__.federationUrl;
+exports.registerFederationScheme = __webpack_exports__.registerFederationScheme;
+exports.resolveAppFile = __webpack_exports__.resolveAppFile;
+exports.serveFederatedApps = __webpack_exports__.serveFederatedApps;
+exports.toAppId = __webpack_exports__.toAppId;
+for(var __rspack_i in __webpack_exports__)if (-1 === [
+    "CACHE_HEADER",
+    "DEFAULT_HOST",
+    "DEFAULT_SCHEME",
+    "federationBaseUrl",
+    "federationUrl",
+    "registerFederationScheme",
+    "resolveAppFile",
+    "serveFederatedApps",
+    "toAppId"
+].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
 Object.defineProperty(exports, '__esModule', {
     value: true
 });

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["webpack://webpack/runtime/make_namespace_object"],"sourcesContent":["// define __esModule on exports\n__webpack_require__.r = (exports) => {\n\tif(typeof Symbol !== 'undefined' && Symbol.toStringTag) {\n\t\tObject.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });\n\t}\n\tObject.defineProperty(exports, '__esModule', { value: true });\n};"],"names":["__webpack_require__","Symbol","Object"],"mappings":";;;IACAA,oBAAoB,CAAC,GAAG,CAAC;QACxB,IAAG,AAAkB,MAAlB,OAAOC,UAA0BA,OAAO,WAAW,EACrDC,OAAO,cAAc,CAAC,UAASD,OAAO,WAAW,EAAE;YAAE,OAAO;QAAS;QAEtEC,OAAO,cAAc,CAAC,UAAS,cAAc;YAAE,OAAO;QAAK;IAC5D"}
+{"version":3,"file":"index.cjs","sources":["webpack://webpack/runtime/compat_get_default_export","webpack://webpack/runtime/define_property_getters","webpack://webpack/runtime/has_own_property","webpack://webpack/runtime/make_namespace_object","../src/index.ts"],"sourcesContent":["// getDefaultExport function for compatibility with non-ESM modules\n__webpack_require__.n = (module) => {\n\tvar getter = module && module.__esModule ?\n\t\t() => (module['default']) :\n\t\t() => (module);\n\t__webpack_require__.d(getter, { a: getter });\n\treturn getter;\n};\n","__webpack_require__.d = (exports, getters, values) => {\n\tvar define = (defs, kind) => {\n\t\tfor(var key in defs) {\n\t\t\tif(__webpack_require__.o(defs, key) && !__webpack_require__.o(exports, key)) {\n\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, [kind]: defs[key] });\n\t\t\t}\n\t\t}\n\t};\n\tdefine(getters, \"get\");\n\tdefine(values, \"value\");\n};","__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))","// define __esModule on exports\n__webpack_require__.r = (exports) => {\n\tif(typeof Symbol !== 'undefined' && Symbol.toStringTag) {\n\t\tObject.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });\n\t}\n\tObject.defineProperty(exports, '__esModule', { value: true });\n};","/**\n * Electron main-process integration. Build configs should import the URL helpers\n * from `@module-federation/electron/rsbuild` or `/vite` instead: this entry imports `electron`.\n */\nimport path from 'node:path';\nimport { pathToFileURL } from 'node:url';\nimport { app, net, protocol } from 'electron';\nimport {\n  createRemoteHandler,\n  isRemoteLocation,\n  resolveAppUrl,\n  type RemoteCacheOptions,\n} from './remote.ts';\nimport { resolveAppFile } from './resolve.ts';\nimport { DEFAULT_HOST, DEFAULT_SCHEME, toAppId } from './url.ts';\n\nexport { CACHE_HEADER, type RemoteCacheOptions } from './remote.ts';\nexport { resolveAppFile } from './resolve.ts';\nexport {\n  DEFAULT_HOST,\n  DEFAULT_SCHEME,\n  federationBaseUrl,\n  federationUrl,\n  toAppId,\n  type FederationUrlOptions,\n} from './url.ts';\n\nexport interface RegisterSchemeOptions {\n  scheme?: string;\n}\n\n/**\n * Registers the federation scheme as privileged (fetch, CORS, ESM, service workers).\n * Must be called before the `ready` event of `app`.\n */\nexport function registerFederationScheme(options: RegisterSchemeOptions = {}): void {\n  protocol.registerSchemesAsPrivileged([\n    {\n      scheme: options.scheme ?? DEFAULT_SCHEME,\n      privileges: {\n        standard: true,\n        secure: true,\n        supportFetchAPI: true,\n        corsEnabled: true,\n        stream: true,\n        codeCache: true,\n      },\n    },\n  ]);\n}\n\nexport interface ServeFederatedAppsOptions {\n  scheme?: string;\n  host?: string;\n  /**\n   * Map of federation `name` (or app id) to the directory holding its build output,\n   * or the http(s) URL it is deployed to.\n   */\n  apps: Record<string, string>;\n  /**\n   * Offline cache for apps served from a URL. Pass `false` to proxy them without caching.\n   * By default responses are cached in `<sessionData>/module-federation`.\n   */\n  cache?: false | Partial<RemoteCacheOptions>;\n}\n\n/**\n * Serves each app on `<scheme>://<host>/<appId>/`, from its build directory or from the\n * URL it is deployed to. Call after `app.whenReady()`. Returns a function that unregisters\n * the handler.\n */\nexport function serveFederatedApps(options: ServeFederatedAppsOptions): () => void {\n  const scheme = options.scheme ?? DEFAULT_SCHEME;\n  const host = options.host ?? DEFAULT_HOST;\n  const dirs: Record<string, string> = {};\n  const urls: Record<string, string> = {};\n  for (const [name, location] of Object.entries(options.apps)) {\n    (isRemoteLocation(location) ? urls : dirs)[toAppId(name)] = location;\n  }\n  const fetchRemote = createRemoteHandler({\n    fetch: (url, init) => net.fetch(url, init),\n    cache:\n      options.cache === false\n        ? false\n        : {\n            ...options.cache,\n            dir: options.cache?.dir ?? path.join(app.getPath('sessionData'), 'module-federation'),\n          },\n  });\n\n  protocol.handle(scheme, async (request) => {\n    const url = new URL(request.url);\n    if (url.host === host) {\n      const upstream = resolveAppUrl(url, urls);\n      if (upstream) return fetchRemote(request, upstream);\n      const file = resolveAppFile(url.pathname, dirs);\n      if (file) return net.fetch(pathToFileURL(file).href);\n    }\n    return new Response('Not found', { status: 404 });\n  });\n\n  return () => protocol.unhandle(scheme);\n}\n"],"names":["__webpack_require__","module","getter","getters","values","define","defs","kind","key","Object","obj","prop","Symbol","registerFederationScheme","options","protocol","DEFAULT_SCHEME","serveFederatedApps","scheme","host","DEFAULT_HOST","dirs","urls","name","location","isRemoteLocation","toAppId","fetchRemote","createRemoteHandler","url","init","net","path","app","request","URL","upstream","resolveAppUrl","file","resolveAppFile","pathToFileURL","Response"],"mappings":";;;IACAA,oBAAoB,CAAC,GAAG,CAACC;QACxB,IAAIC,SAASD,UAAUA,OAAO,UAAU,GACvC,IAAOA,MAAM,CAAC,UAAU,GACxB,IAAOA;QACRD,oBAAoB,CAAC,CAACE,QAAQ;YAAE,GAAGA;QAAO;QAC1C,OAAOA;IACR;;;ICPAF,oBAAoB,CAAC,GAAG,CAAC,UAASG,SAASC;QAC1C,IAAIC,SAAS,CAACC,MAAMC;YACnB,IAAI,IAAIC,OAAOF,KACd,IAAGN,oBAAoB,CAAC,CAACM,MAAME,QAAQ,CAACR,oBAAoB,CAAC,CAAC,UAASQ,MACtEC,OAAO,cAAc,CAAC,UAASD,KAAK;gBAAE,YAAY;gBAAM,CAACD,KAAK,EAAED,IAAI,CAACE,IAAI;YAAC;QAG7E;QACAH,OAAOF,SAAS;QAChBE,OAAOD,QAAQ;IAChB;;;ICVAJ,oBAAoB,CAAC,GAAG,CAACU,KAAKC,OAAUF,OAAO,SAAS,CAAC,cAAc,CAAC,IAAI,CAACC,KAAKC;;;ICClFX,oBAAoB,CAAC,GAAG,CAAC;QACxB,IAAG,AAAkB,MAAlB,OAAOY,UAA0BA,OAAO,WAAW,EACrDH,OAAO,cAAc,CAAC,UAASG,OAAO,WAAW,EAAE;YAAE,OAAO;QAAS;QAEtEH,OAAO,cAAc,CAAC,UAAS,cAAc;YAAE,OAAO;QAAK;IAC5D;;;;;;;;;;;;;;;;;;;;;;AC6BO,SAASI,yBAAyBC,UAAiC,CAAC,CAAC;IAC1EC,kCAAAA,QAAAA,CAAAA,2BAAoC,CAAC;QACnC;YACE,QAAQD,QAAQ,MAAM,IAAIE,iCAAAA,cAAcA;YACxC,YAAY;gBACV,UAAU;gBACV,QAAQ;gBACR,iBAAiB;gBACjB,aAAa;gBACb,QAAQ;gBACR,WAAW;YACb;QACF;KACD;AACH;AAsBO,SAASC,mBAAmBH,OAAkC;IACnE,MAAMI,SAASJ,QAAQ,MAAM,IAAIE,iCAAAA,cAAcA;IAC/C,MAAMG,OAAOL,QAAQ,IAAI,IAAIM,iCAAAA,YAAYA;IACzC,MAAMC,OAA+B,CAAC;IACtC,MAAMC,OAA+B,CAAC;IACtC,KAAK,MAAM,CAACC,MAAMC,SAAS,IAAIf,OAAO,OAAO,CAACK,QAAQ,IAAI,EACvDW,AAAAA,CAAAA,IAAAA,oCAAAA,gBAAAA,AAAAA,EAAiBD,YAAYF,OAAOD,IAAG,CAAE,CAACK,AAAAA,IAAAA,iCAAAA,OAAAA,AAAAA,EAAQH,MAAM,GAAGC;IAE9D,MAAMG,cAAcC,AAAAA,IAAAA,oCAAAA,mBAAAA,AAAAA,EAAoB;QACtC,OAAO,CAACC,KAAKC,OAASC,kCAAAA,GAAAA,CAAAA,KAAS,CAACF,KAAKC;QACrC,OACEhB,AAAkB,UAAlBA,QAAQ,KAAK,GACT,QACA;YACE,GAAGA,QAAQ,KAAK;YAChB,KAAKA,QAAQ,KAAK,EAAE,OAAOkB,6BAAAA,IAAS,CAACC,kCAAAA,GAAAA,CAAAA,OAAW,CAAC,gBAAgB;QACnE;IACR;IAEAlB,kCAAAA,QAAAA,CAAAA,MAAe,CAACG,QAAQ,OAAOgB;QAC7B,MAAML,MAAM,IAAIM,IAAID,QAAQ,GAAG;QAC/B,IAAIL,IAAI,IAAI,KAAKV,MAAM;YACrB,MAAMiB,WAAWC,AAAAA,IAAAA,oCAAAA,aAAAA,AAAAA,EAAcR,KAAKP;YACpC,IAAIc,UAAU,OAAOT,YAAYO,SAASE;YAC1C,MAAME,OAAOC,AAAAA,IAAAA,qCAAAA,cAAAA,AAAAA,EAAeV,IAAI,QAAQ,EAAER;YAC1C,IAAIiB,MAAM,OAAOP,kCAAAA,GAAAA,CAAAA,KAAS,CAACS,AAAAA,IAAAA,kCAAAA,aAAAA,AAAAA,EAAcF,MAAM,IAAI;QACrD;QACA,OAAO,IAAIG,SAAS,aAAa;YAAE,QAAQ;QAAI;IACjD;IAEA,OAAO,IAAM1B,kCAAAA,QAAAA,CAAAA,QAAiB,CAACG;AACjC"}

package/dist/index.d.cts

@@ -1,2 +1,33 @@
-export {};
+import { type RemoteCacheOptions } from './remote.cjs';
+export { CACHE_HEADER, type RemoteCacheOptions } from './remote.cjs';
+export { resolveAppFile } from './resolve.cjs';
+export { DEFAULT_HOST, DEFAULT_SCHEME, federationBaseUrl, federationUrl, toAppId, type FederationUrlOptions, } from './url.cjs';
+export interface RegisterSchemeOptions {
+    scheme?: string;
+}
+/**
+ * Registers the federation scheme as privileged (fetch, CORS, ESM, service workers).
+ * Must be called before the `ready` event of `app`.
+ */
+export declare function registerFederationScheme(options?: RegisterSchemeOptions): void;
+export interface ServeFederatedAppsOptions {
+    scheme?: string;
+    host?: string;
+    /**
+     * Map of federation `name` (or app id) to the directory holding its build output,
+     * or the http(s) URL it is deployed to.
+     */
+    apps: Record<string, string>;
+    /**
+     * Offline cache for apps served from a URL. Pass `false` to proxy them without caching.
+     * By default responses are cached in `<sessionData>/module-federation`.
+     */
+    cache?: false | Partial<RemoteCacheOptions>;
+}
+/**
+ * Serves each app on `<scheme>://<host>/<appId>/`, from its build directory or from the
+ * URL it is deployed to. Call after `app.whenReady()`. Returns a function that unregisters
+ * the handler.
+ */
+export declare function serveFederatedApps(options: ServeFederatedAppsOptions): () => void;
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAIL,KAAK,kBAAkB,EACxB,MAAM,aAAa,CAAC;AAIrB,OAAO,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EACL,YAAY,EACZ,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,OAAO,EACP,KAAK,oBAAoB,GAC1B,MAAM,UAAU,CAAC;AAElB,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,GAAE,qBAA0B,GAAG,IAAI,CAclF;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAC7C;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,MAAM,IAAI,CA+BjF"}

package/dist/index.d.ts

@@ -1,2 +1,33 @@
-export {};
+import { type RemoteCacheOptions } from './remote.js';
+export { CACHE_HEADER, type RemoteCacheOptions } from './remote.js';
+export { resolveAppFile } from './resolve.js';
+export { DEFAULT_HOST, DEFAULT_SCHEME, federationBaseUrl, federationUrl, toAppId, type FederationUrlOptions, } from './url.js';
+export interface RegisterSchemeOptions {
+    scheme?: string;
+}
+/**
+ * Registers the federation scheme as privileged (fetch, CORS, ESM, service workers).
+ * Must be called before the `ready` event of `app`.
+ */
+export declare function registerFederationScheme(options?: RegisterSchemeOptions): void;
+export interface ServeFederatedAppsOptions {
+    scheme?: string;
+    host?: string;
+    /**
+     * Map of federation `name` (or app id) to the directory holding its build output,
+     * or the http(s) URL it is deployed to.
+     */
+    apps: Record<string, string>;
+    /**
+     * Offline cache for apps served from a URL. Pass `false` to proxy them without caching.
+     * By default responses are cached in `<sessionData>/module-federation`.
+     */
+    cache?: false | Partial<RemoteCacheOptions>;
+}
+/**
+ * Serves each app on `<scheme>://<host>/<appId>/`, from its build directory or from the
+ * URL it is deployed to. Call after `app.whenReady()`. Returns a function that unregisters
+ * the handler.
+ */
+export declare function serveFederatedApps(options: ServeFederatedAppsOptions): () => void;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAIL,KAAK,kBAAkB,EACxB,MAAM,aAAa,CAAC;AAIrB,OAAO,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EACL,YAAY,EACZ,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,OAAO,EACP,KAAK,oBAAoB,GAC1B,MAAM,UAAU,CAAC;AAElB,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,GAAE,qBAA0B,GAAG,IAAI,CAclF;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAC7C;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,MAAM,IAAI,CA+BjF"}

package/dist/index.js

@@ -1 +1,51 @@
-export { };
+import node_path from "node:path";
+import { pathToFileURL } from "node:url";
+import { app, net, protocol } from "electron";
+import { CACHE_HEADER, createRemoteHandler, isRemoteLocation, resolveAppUrl } from "./remote.js";
+import { resolveAppFile } from "./resolve.js";
+import { DEFAULT_HOST, DEFAULT_SCHEME, federationBaseUrl, federationUrl, toAppId } from "./url.js";
+function registerFederationScheme(options = {}) {
+    protocol.registerSchemesAsPrivileged([
+        {
+            scheme: options.scheme ?? DEFAULT_SCHEME,
+            privileges: {
+                standard: true,
+                secure: true,
+                supportFetchAPI: true,
+                corsEnabled: true,
+                stream: true,
+                codeCache: true
+            }
+        }
+    ]);
+}
+function serveFederatedApps(options) {
+    const scheme = options.scheme ?? DEFAULT_SCHEME;
+    const host = options.host ?? DEFAULT_HOST;
+    const dirs = {};
+    const urls = {};
+    for (const [name, location] of Object.entries(options.apps))(isRemoteLocation(location) ? urls : dirs)[toAppId(name)] = location;
+    const fetchRemote = createRemoteHandler({
+        fetch: (url, init)=>net.fetch(url, init),
+        cache: false === options.cache ? false : {
+            ...options.cache,
+            dir: options.cache?.dir ?? node_path.join(app.getPath('sessionData'), 'module-federation')
+        }
+    });
+    protocol.handle(scheme, async (request)=>{
+        const url = new URL(request.url);
+        if (url.host === host) {
+            const upstream = resolveAppUrl(url, urls);
+            if (upstream) return fetchRemote(request, upstream);
+            const file = resolveAppFile(url.pathname, dirs);
+            if (file) return net.fetch(pathToFileURL(file).href);
+        }
+        return new Response('Not found', {
+            status: 404
+        });
+    });
+    return ()=>protocol.unhandle(scheme);
+}
+export { CACHE_HEADER, DEFAULT_HOST, DEFAULT_SCHEME, federationBaseUrl, federationUrl, registerFederationScheme, resolveAppFile, serveFederatedApps, toAppId };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["/**\n * Electron main-process integration. Build configs should import the URL helpers\n * from `@module-federation/electron/rsbuild` or `/vite` instead: this entry imports `electron`.\n */\nimport path from 'node:path';\nimport { pathToFileURL } from 'node:url';\nimport { app, net, protocol } from 'electron';\nimport {\n  createRemoteHandler,\n  isRemoteLocation,\n  resolveAppUrl,\n  type RemoteCacheOptions,\n} from './remote.ts';\nimport { resolveAppFile } from './resolve.ts';\nimport { DEFAULT_HOST, DEFAULT_SCHEME, toAppId } from './url.ts';\n\nexport { CACHE_HEADER, type RemoteCacheOptions } from './remote.ts';\nexport { resolveAppFile } from './resolve.ts';\nexport {\n  DEFAULT_HOST,\n  DEFAULT_SCHEME,\n  federationBaseUrl,\n  federationUrl,\n  toAppId,\n  type FederationUrlOptions,\n} from './url.ts';\n\nexport interface RegisterSchemeOptions {\n  scheme?: string;\n}\n\n/**\n * Registers the federation scheme as privileged (fetch, CORS, ESM, service workers).\n * Must be called before the `ready` event of `app`.\n */\nexport function registerFederationScheme(options: RegisterSchemeOptions = {}): void {\n  protocol.registerSchemesAsPrivileged([\n    {\n      scheme: options.scheme ?? DEFAULT_SCHEME,\n      privileges: {\n        standard: true,\n        secure: true,\n        supportFetchAPI: true,\n        corsEnabled: true,\n        stream: true,\n        codeCache: true,\n      },\n    },\n  ]);\n}\n\nexport interface ServeFederatedAppsOptions {\n  scheme?: string;\n  host?: string;\n  /**\n   * Map of federation `name` (or app id) to the directory holding its build output,\n   * or the http(s) URL it is deployed to.\n   */\n  apps: Record<string, string>;\n  /**\n   * Offline cache for apps served from a URL. Pass `false` to proxy them without caching.\n   * By default responses are cached in `<sessionData>/module-federation`.\n   */\n  cache?: false | Partial<RemoteCacheOptions>;\n}\n\n/**\n * Serves each app on `<scheme>://<host>/<appId>/`, from its build directory or from the\n * URL it is deployed to. Call after `app.whenReady()`. Returns a function that unregisters\n * the handler.\n */\nexport function serveFederatedApps(options: ServeFederatedAppsOptions): () => void {\n  const scheme = options.scheme ?? DEFAULT_SCHEME;\n  const host = options.host ?? DEFAULT_HOST;\n  const dirs: Record<string, string> = {};\n  const urls: Record<string, string> = {};\n  for (const [name, location] of Object.entries(options.apps)) {\n    (isRemoteLocation(location) ? urls : dirs)[toAppId(name)] = location;\n  }\n  const fetchRemote = createRemoteHandler({\n    fetch: (url, init) => net.fetch(url, init),\n    cache:\n      options.cache === false\n        ? false\n        : {\n            ...options.cache,\n            dir: options.cache?.dir ?? path.join(app.getPath('sessionData'), 'module-federation'),\n          },\n  });\n\n  protocol.handle(scheme, async (request) => {\n    const url = new URL(request.url);\n    if (url.host === host) {\n      const upstream = resolveAppUrl(url, urls);\n      if (upstream) return fetchRemote(request, upstream);\n      const file = resolveAppFile(url.pathname, dirs);\n      if (file) return net.fetch(pathToFileURL(file).href);\n    }\n    return new Response('Not found', { status: 404 });\n  });\n\n  return () => protocol.unhandle(scheme);\n}\n"],"names":["registerFederationScheme","options","protocol","DEFAULT_SCHEME","serveFederatedApps","scheme","host","DEFAULT_HOST","dirs","urls","name","location","Object","isRemoteLocation","toAppId","fetchRemote","createRemoteHandler","url","init","net","path","app","request","URL","upstream","resolveAppUrl","file","resolveAppFile","pathToFileURL","Response"],"mappings":";;;;;;AAmCO,SAASA,yBAAyBC,UAAiC,CAAC,CAAC;IAC1EC,SAAS,2BAA2B,CAAC;QACnC;YACE,QAAQD,QAAQ,MAAM,IAAIE;YAC1B,YAAY;gBACV,UAAU;gBACV,QAAQ;gBACR,iBAAiB;gBACjB,aAAa;gBACb,QAAQ;gBACR,WAAW;YACb;QACF;KACD;AACH;AAsBO,SAASC,mBAAmBH,OAAkC;IACnE,MAAMI,SAASJ,QAAQ,MAAM,IAAIE;IACjC,MAAMG,OAAOL,QAAQ,IAAI,IAAIM;IAC7B,MAAMC,OAA+B,CAAC;IACtC,MAAMC,OAA+B,CAAC;IACtC,KAAK,MAAM,CAACC,MAAMC,SAAS,IAAIC,OAAO,OAAO,CAACX,QAAQ,IAAI,EACvDY,AAAAA,CAAAA,iBAAiBF,YAAYF,OAAOD,IAAG,CAAE,CAACM,QAAQJ,MAAM,GAAGC;IAE9D,MAAMI,cAAcC,oBAAoB;QACtC,OAAO,CAACC,KAAKC,OAASC,IAAI,KAAK,CAACF,KAAKC;QACrC,OACEjB,AAAkB,UAAlBA,QAAQ,KAAK,GACT,QACA;YACE,GAAGA,QAAQ,KAAK;YAChB,KAAKA,QAAQ,KAAK,EAAE,OAAOmB,UAAAA,IAAS,CAACC,IAAI,OAAO,CAAC,gBAAgB;QACnE;IACR;IAEAnB,SAAS,MAAM,CAACG,QAAQ,OAAOiB;QAC7B,MAAML,MAAM,IAAIM,IAAID,QAAQ,GAAG;QAC/B,IAAIL,IAAI,IAAI,KAAKX,MAAM;YACrB,MAAMkB,WAAWC,cAAcR,KAAKR;YACpC,IAAIe,UAAU,OAAOT,YAAYO,SAASE;YAC1C,MAAME,OAAOC,eAAeV,IAAI,QAAQ,EAAET;YAC1C,IAAIkB,MAAM,OAAOP,IAAI,KAAK,CAACS,cAAcF,MAAM,IAAI;QACrD;QACA,OAAO,IAAIG,SAAS,aAAa;YAAE,QAAQ;QAAI;IACjD;IAEA,OAAO,IAAM3B,SAAS,QAAQ,CAACG;AACjC"}