chore: rename FederationHost to ModuleFederation

Author: 2heal1

.changeset/poor-pillows-study.md

@@ -0,0 +1,11 @@
+---
+'@module-federation/webpack-bundler-runtime': patch
+'@module-federation/bridge-react': patch
+'@module-federation/data-prefetch': patch
+'@module-federation/runtime-core': patch
+'@module-federation/modern-js': patch
+'@module-federation/runtime': patch
+'@module-federation/node': patch
+---
+
+chore: rename FederationHost to ModuleFederation

apps/website-new/docs/en/guide/basic/runtime/runtime-api.mdx

@@ -416,26 +416,26 @@ registerPlugins([
 ]);
 ```
 
-## FederationConstructor
+## ModuleFederation
 
-In addition to exposing APIs,  the Federation Runtime also provides a FederationConstructor class, which you can use to create Federation instance.
+In addition to exposing APIs,  the Runtime also provides the ModuleFederation class, which you can use to create ModuleFederation instance.
 
-* What is a `Federation` instance?
+* What is a `ModuleFederation` instance?
 
-A `Federation` instance is an instance of the `FederationConstructor` class, which contains all the functionality of the `Federation` runtime.
+A `ModuleFederation` instance is an instance of the `ModuleFederation` class, which contains all the functionality of the `ModuleFederation` runtime.
 
 > You can enter `__FEDERATION__.__INSTANCES__` in the console to view the created instances.
 
-* When to use `FederationConstructor`?
+* When to use `ModuleFederation` class?
 
-To ensure the uniqueness of the FederationHost instance, after the build plugin creates an instance, it will be stored in memory. The exported APIs all first obtain the FederationHost instance from memory and then call the APIs of the FederationHost instance. This is also why APIs like loadRemote can be used directly from the `module-federation/runtime` package and inherently understand what application container they are attached to.
+To ensure the uniqueness of the ModuleFederation instance, after the build plugin creates an instance, it will be stored in memory. The exported APIs all first obtain the ModuleFederation instance from memory and then call the APIs of the ModuleFederation instance. This is also why APIs like loadRemote can be used directly from the `module-federation/runtime` package and inherently understand what application container they are attached to.
 
-However, this singleton pattern also limits the ability to create multiple instances, as it assumes that there is only one instance per bundle. Therefore, if you need to create a new instance , you can use the FederationHost class to create a new one.
+However, this singleton pattern also limits the ability to create multiple instances, as it assumes that there is only one instance per bundle. Therefore, if you need to create a new instance , you can use the ModuleFederation class to create a new one.
 
 ```ts
-import { FederationConstructor } from '@vmok/kit/runtime';
+import { ModuleFederation } from '@module-federation/enhanced/runtime';
 
-const host = new FederationConstructor({
+const mf = new ModuleFederation({
   name: '@demo/host',
   remotes: [
     {
@@ -445,5 +445,5 @@ const host = new FederationConstructor({
   ]
 });
 
-host.loadRemote('@demo/sub1/util').then((m) => m.add(1, 2, 3));
+mf.loadRemote('@demo/sub1/util').then((m) => m.add(1, 2, 3));
 ```

apps/website-new/docs/en/guide/basic/runtime/runtime-hooks.mdx

@@ -13,12 +13,12 @@ function beforeInit(args: BeforeInitOptions): BeforeInitOptions
 
 type BeforeInitOptions ={
     userOptions: UserOptions;
-    options: FederationRuntimeOptions;
-    origin: FederationHost;
+    options: ModuleFederationRuntimeOptions;
+    origin: ModuleFederation;
     shareInfo: ShareInfos;
 }
 
-interface FederationRuntimeOptions {
+interface ModuleFederationRuntimeOptions {
   id?: string;
   name: string;
   version?: string;
@@ -41,8 +41,8 @@ Called after the MF instance is initialized.
 function init(args: InitOptions): void
 
 type InitOptions ={
-  options: FederationRuntimeOptions;
-  origin: FederationHost;
+  options: ModuleFederationRuntimeOptions;
+  origin: ModuleFederation;
 }
 ```
 
@@ -59,8 +59,8 @@ async function beforeRequest(args: BeforeRequestOptions): Promise<BeforeRequestO
 
 type BeforeRequestOptions ={
   id: string;
-  options: FederationRuntimeOptions;
-  origin: FederationHost;
+  options: ModuleFederationRuntimeOptions;
+  origin: ModuleFederation;
 }
 ```
 
@@ -80,8 +80,8 @@ type AfterResolveOptions ={
   pkgNameOrAlias: string;
   expose: string;
   remote: Remote;
-  options: FederationRuntimeOptions;
-  origin: FederationHost;
+  options: ModuleFederationRuntimeOptions;
+  origin: ModuleFederation;
   remoteInfo: RemoteInfo;
   remoteSnapshot?: ModuleInfo;
 }
@@ -104,15 +104,15 @@ type OnLoadOptions ={
   pkgNameOrAlias: string;
   remote: Remote;
   options: ModuleOptions;
-  origin: FederationHost;
+  origin: ModuleFederation;
   exposeModule: any;
   exposeModuleFactory: any;
   moduleInstance: Module;
 }
 
 type ModuleOptions = {
     remoteInfo: RemoteInfo;
-    host: FederationHost;
+    host: ModuleFederation;
 }
 
 interface RemoteInfo {
@@ -160,7 +160,7 @@ type ErrorLoadRemoteOptions ={
   id: string;
   error: unknown;
   from: 'build' | 'runtime';
-  origin: FederationHost;
+  origin: ModuleFederation;
 }
 ```
 * example
@@ -214,7 +214,7 @@ type BeforeLoadShareOptions ={
   pkgName: string;
   shareInfo?: Shared;
   shared: Options['shared'];
-  origin: FederationHost;
+  origin: ModuleFederation;
 }
 ```
 
@@ -306,7 +306,7 @@ async function beforePreloadRemote(args: BeforePreloadRemoteOptions): BeforePrel
 type BeforePreloadRemoteOptions ={
   preloadOps: Array<PreloadRemoteArgs>;
   options: Options;
-  origin: FederationHost;
+  origin: ModuleFederation;
 }
 ```
 
@@ -322,7 +322,7 @@ Used to control the generation of resources that need to be preloaded.
 async function generatePreloadAssets(args: GeneratePreloadAssetsOptions): Promise<PreloadAssets>
 
 type GeneratePreloadAssetsOptions ={
-  origin: FederationHost;
+  origin: ModuleFederation;
   preloadOptions: PreloadOptions[number];
   remote: Remote;
   remoteInfo: RemoteInfo;

apps/website-new/docs/en/plugin/dev/index.mdx

@@ -118,12 +118,12 @@ function beforeInit(args: BeforeInitOptions): BeforeInitOptions;
 
 type BeforeInitOptions = {
   userOptions: UserOptions;
-  options: FederationRuntimeOptions;
-  origin: FederationHost;
+  options: ModuleFederationRuntimeOptions;
+  origin: ModuleFederation;
   shareInfo: ShareInfos;
 };
 
-interface FederationRuntimeOptions {
+interface ModuleFederationRuntimeOptions {
   id?: string;
   name: string;
   version?: string;
@@ -146,8 +146,8 @@ Called during the initialization of the remote container.
 function init(args: InitOptions): void;
 
 type InitOptions = {
-  options: FederationRuntimeOptions;
-  origin: FederationHost;
+  options: ModuleFederationRuntimeOptions;
+  origin: ModuleFederation;
 };
 ```
 
@@ -166,8 +166,8 @@ async function beforeRequest(
 
 type BeforeRequestOptions = {
   id: string;
-  options: FederationRuntimeOptions;
-  origin: FederationHost;
+  options: ModuleFederationRuntimeOptions;
+  origin: ModuleFederation;
 };
 ```
 
@@ -189,8 +189,8 @@ type AfterResolveOptions = {
   pkgNameOrAlias: string;
   expose: string;
   remote: Remote;
-  options: FederationRuntimeOptions;
-  origin: FederationHost;
+  options: ModuleFederationRuntimeOptions;
+  origin: ModuleFederation;
   remoteInfo: RemoteInfo;
   remoteSnapshot?: ModuleInfo;
 };
@@ -213,15 +213,15 @@ type OnLoadOptions = {
   pkgNameOrAlias: string;
   remote: Remote;
   options: ModuleOptions;
-  origin: FederationHost;
+  origin: ModuleFederation;
   exposeModule: any;
   exposeModuleFactory: any;
   moduleInstance: Module;
 };
 
 type ModuleOptions = {
   remoteInfo: RemoteInfo;
-  host: FederationHost;
+  host: ModuleFederation;
 };
 
 interface RemoteInfo {
@@ -278,7 +278,7 @@ type ErrorLoadRemoteOptions = {
   options?: any;
   from: 'build' | 'runtime';
   lifecycle: 'onLoad' | 'beforeRequest';
-  origin: FederationHost;
+  origin: ModuleFederation;
 };
 ```
 
@@ -337,7 +337,7 @@ type BeforeLoadShareOptions = {
   pkgName: string;
   shareInfo?: Shared;
   shared: Options['shared'];
-  origin: FederationHost;
+  origin: ModuleFederation;
 };
 ```
 
@@ -440,7 +440,7 @@ async function beforePreloadRemote(
 type BeforePreloadRemoteOptions = {
   preloadOps: Array<PreloadRemoteArgs>;
   options: Options;
-  origin: FederationHost;
+  origin: ModuleFederation;
 };
 ```
 
@@ -458,7 +458,7 @@ async function generatePreloadAssets(
 ): Promise<PreloadAssets>;
 
 type GeneratePreloadAssetsOptions = {
-  origin: FederationHost;
+  origin: ModuleFederation;
   preloadOptions: PreloadOptions[number];
   remote: Remote;
   remoteInfo: RemoteInfo;

apps/website-new/docs/zh/guide/basic/runtime/runtime-api.mdx

@@ -416,26 +416,26 @@ registerPlugins([
 ]);
 ```
 
-## FederationConstructor
+## ModuleFederation
 
-`Federation Runtime` 除了暴露出 API 外，还提供了 `FederationConstructor` 类，你可以使用它来创建一个 `Federation` 实例。
+`Runtime` 除了暴露出 API 外，还提供了 `ModuleFederation` 类，你可以使用它来创建一个 `ModuleFederation` 实例。
 
-* 什么是 `Federation` 实例 ？
+* 什么是 `ModuleFederation` 实例 ？
 
-`Federation` 实例是 `FederationConstructor` 类的实例，它包含了 `Federation` 运行时的所有功能。
+`ModuleFederation` 实例是 `ModuleFederation` 类的实例，它包含了 `ModuleFederation` 运行时的所有功能。
 
 > 你可以在控制台输入 `__FEDERATION__.__INSTANCES__` 来查看已经创建好的实例。
 
-* 什么时候使用 `FederationConstructor` ？
+* 什么时候使用 `ModuleFederation` class？
 
-为了保证 `FederationConstructor` 实例的唯一性，我们在构建插件创建实例后，会将其存储到内存中，导出的 API 都是先从内存中获取 `FederationConstructor` 实例，然后再调用 `FederationConstructor` 实例的 API。这也是为什么 `loadRemote` 等 API 可以直接使用的原因。
+为了保证 `ModuleFederation` 实例的唯一性，我们在构建插件创建实例后，会将其存储到内存中，导出的 API 都是先从内存中获取 `ModuleFederation` 实例，然后再调用 `ModuleFederation` 实例的 API。这也是为什么 `loadRemote` 等 API 可以直接使用的原因。
 
-但是这种单例模式同时也限制无法创建多份实例，因此如果你需要**创建新的 FederationConstructor 实例**，那么你可以使用 `FederationConstructor` 类来创建一个新的实例。
+但是这种单例模式同时也限制无法创建多份实例，因此如果你需要**创建新的 ModuleFederation 实例**，那么你可以使用 `ModuleFederation` 类来创建一个新的实例。
 
 ```ts
-import { FederationConstructor } from '@module-federation/enhanced/runtime';
+import { ModuleFederation } from '@module-federation/enhanced/runtime';
 
-const host = new FederationConstructor({
+const mf = new ModuleFederation({
   name: 'host',
   remotes: [
     {

apps/website-new/docs/zh/guide/basic/runtime/runtime-hooks.mdx

@@ -13,12 +13,12 @@ function beforeInit(args: BeforeInitOptions): BeforeInitOptions
 
 type BeforeInitOptions ={
     userOptions: UserOptions;
-    options: FederationRuntimeOptions;
-    origin: FederationHost;
+    options: ModuleFederationRuntimeOptions;
+    origin: ModuleFederation;
     shareInfo: ShareInfos;
 }
 
-interface FederationRuntimeOptions {
+interface ModuleFederationRuntimeOptions {
   id?: string;
   name: string;
   version?: string;
@@ -41,8 +41,8 @@ interface FederationRuntimeOptions {
 function init(args: InitOptions): void
 
 type InitOptions ={
-  options: FederationRuntimeOptions;
-  origin: FederationHost;
+  options: ModuleFederationRuntimeOptions;
+  origin: ModuleFederation;
 }
 ```
 
@@ -59,8 +59,8 @@ async function beforeRequest(args: BeforeRequestOptions): Promise<BeforeRequestO
 
 type BeforeRequestOptions ={
   id: string;
-  options: FederationRuntimeOptions;
-  origin: FederationHost;
+  options: ModuleFederationRuntimeOptions;
+  origin: ModuleFederation;
 }
 ```
 
@@ -80,8 +80,8 @@ type AfterResolveOptions ={
   pkgNameOrAlias: string;
   expose: string;
   remote: Remote;
-  options: FederationRuntimeOptions;
-  origin: FederationHost;
+  options: ModuleFederationRuntimeOptions;
+  origin: ModuleFederation;
   remoteInfo: RemoteInfo;
   remoteSnapshot?: ModuleInfo;
 }
@@ -106,15 +106,15 @@ type OnLoadOptions ={
   pkgNameOrAlias: string;
   remote: Remote;
   options: ModuleOptions;
-  origin: FederationHost;
+  origin: ModuleFederation;
   exposeModule: any;
   exposeModuleFactory: any;
   moduleInstance: Module;
 }
 
 type ModuleOptions = {
     remoteInfo: RemoteInfo;
-    host: FederationHost;
+    host: ModuleFederation;
 }
 
 interface RemoteInfo {
@@ -162,7 +162,7 @@ type ErrorLoadRemoteOptions ={
   id: string;
   error: unknown;
   from: 'build' | 'runtime';
-  origin: FederationHost;
+  origin: ModuleFederation;
 }
 ```
 * example
@@ -216,7 +216,7 @@ type BeforeLoadShareOptions ={
   pkgName: string;
   shareInfo?: Shared;
   shared: Options['shared'];
-  origin: FederationHost;
+  origin: ModuleFederation;
 }
 ```
 
@@ -308,7 +308,7 @@ async function beforePreloadRemote(args: BeforePreloadRemoteOptions): BeforePrel
 type BeforePreloadRemoteOptions ={
   preloadOps: Array<PreloadRemoteArgs>;
   options: Options;
-  origin: FederationHost;
+  origin: ModuleFederation;
 }
 ```
 
@@ -324,7 +324,7 @@ type BeforePreloadRemoteOptions ={
 async function generatePreloadAssets(args: GeneratePreloadAssetsOptions): Promise<PreloadAssets>
 
 type GeneratePreloadAssetsOptions ={
-  origin: FederationHost;
+  origin: ModuleFederation;
   preloadOptions: PreloadOptions[number];
   remote: Remote;
   remoteInfo: RemoteInfo;