@module-federation/vite 1.19.0 → 1.20.0

package/README.md

@@ -70,6 +70,10 @@ With **@module-federation/vite**, the process becomes delightfully simple, you w
 > This example is with [Vue.js](https://vuejs.org/)</br>
 > The @module-federation/vite configuration remains the same for different frameworks.
 
+## Migrating from OriginJS
+
+Migrating from `@originjs/vite-plugin-federation` requires an explicit remote-entry format and runtime review, particularly for dynamic remotes, shared dependencies, and mixed bundlers. See the [OriginJS migration guide](./docs/MIGRATING_FROM_ORIGINJS.md) for step-by-step migration and incremental deployment guidance.
+
 ## Dedicated configuration file
 
 You can keep Module Federation options in `module-federation.config.ts`.
@@ -291,6 +295,46 @@ After creating the secondary artifact, the deployment service must publish it to
 
 This deployment step is separate from the local Vite build; the plugin only emits the metadata and runtime support needed by the service. If the Snapshot is not updated, the artifact cannot be fetched, the versions do not match, or the artifact does not provide all required exports, the runtime ignores the optimized artifact and safely loads the complete shared dependency instead.
 
+## External runtime (`experiments`)
+
+Share one `@module-federation/runtime-core` instance from a pure consumer host so remotes do not bundle their own copy. Pair the flags — remotes with `externalRuntime` require a host that provides the global.
+
+**Host (pure consumer, no `exposes`):**
+
+```ts
+federation({
+  name: "host",
+  remotes: {
+    remote: {
+      type: "module",
+      name: "remote",
+      entry: "http://localhost:5176/remoteEntry.js",
+    },
+  },
+  experiments: {
+    provideExternalRuntime: true,
+  },
+});
+```
+
+**Remote:**
+
+```ts
+federation({
+  name: "remote",
+  filename: "remoteEntry.js",
+  exposes: {
+    "./App": "./src/App.tsx",
+  },
+  experiments: {
+    externalRuntime: true,
+  },
+});
+```
+
+`provideExternalRuntime` injects a local runtime plugin that publishes `runtime-core` on `globalThis._FEDERATION_RUNTIME_CORE`. `externalRuntime` rewrites imports of `@module-federation/runtime-core` to read that global. Using `provideExternalRuntime` together with `exposes` throws — only pure consumers may provide the runtime.
+The `externalRuntime` rewrite applies to the browser remote graph; SSR remote entries continue to resolve `@module-federation/runtime-core` from Node so they do not depend on the browser global.
+
 ## ⚠️ `codeSplitting` settings are controlled by the plugin
 
 Do not set either `build.rollupOptions.output.codeSplitting` or

package/lib/index.d.ts

@@ -123,7 +123,28 @@ type ModuleFederationOptions = {
    * add any other Node-only packages that should not be bundled into the SSR entry.
    */
   ssrExternals?: string[];
+  /**
+   * Experimental Module Federation capabilities.
+   *
+   * @see https://module-federation.io/configure/experiments
+   */
+  experiments?: PluginExperimentsOptions;
 };
+interface PluginExperimentsOptions {
+  /**
+   * Treat `@module-federation/runtime-core` as an external that reads
+   * `globalThis._FEDERATION_RUNTIME_CORE` at runtime. Pair with a host that
+   * sets `provideExternalRuntime: true`.
+   */
+  externalRuntime?: boolean;
+  /**
+   * Pure-consumer only (no `exposes`). Injects a local runtime plugin that
+   * publishes `runtime-core` on `globalThis._FEDERATION_RUNTIME_CORE`.
+   */
+  provideExternalRuntime?: boolean;
+  /** Generate the React SSR/hydration island capability for eligible exposes. */
+  ssrMode?: 'ISLAND';
+}
 type HostInitInjectLocationOptions = 'entry' | 'html';
 interface PluginDevOptions {
   disableLiveReload?: boolean;
@@ -203,4 +224,4 @@ interface DtsHostOptions {
 declare function federation(mfUserOptions: ModuleFederationOptions): any[];
 declare function createModuleFederationConfig<T extends ModuleFederationOptions>(options: T): T;
 //#endregion
-export { type ModuleFederationOptions, type PluginManifestOptions, type TreeShakingConfig, createModuleFederationConfig, federation };
+export { type ModuleFederationOptions, type PluginExperimentsOptions, type PluginManifestOptions, type TreeShakingConfig, createModuleFederationConfig, federation };