@module-federation/modern-js 0.0.0-next-20240626050252 → 0.0.0-next-20240708090519

package/README.md

@@ -2,259 +2,4 @@
 
 This plugin provides Module Federation supporting functions for Modern.js
 
-## Supports
-
-- modern.js ^2.54.2
-- Server-Side Rendering
-
-We highly recommend referencing this application which takes advantage of the best capabilities:
-[module-federation example](https://github.com/module-federation/core/tree/feat/modernjs-ssr/apps/modernjs-ssr)
-
-## Quick Start
-
-### Installation
-
-You can install the plugin with the following commands:
-
-import { PackageManagerTabs } from '@theme';
-
-<PackageManagerTabs
-  command={{
-    npm: 'npm add @module-federation/modern-js --save',
-    yarn: 'yarn add @module-federation/modern-js --save',
-    pnpm: 'pnpm add @module-federation/modern-js --save',
-    bun: 'bun add @module-federation/modern-js --save',
-  }}
-/>
-
-### Apply Plugin
-
-Apply this plugin in `plugins` of `modern.config.ts`:
-
-```ts title="modern.config.ts"
-import { appTools, defineConfig } from '@modern-js/app-tools';
-import { moduleFederationPlugin } from '@module-federation/modern-js';
-
-export default defineConfig({
-  dev: {
-    port: 3005,
-  },
-  runtime: {
-    router: true,
-  },
-  // moduleFederationPlugin is a plug-in for modern.js, which can make certain modifications to the build/runtime
-  plugins: [appTools(), moduleFederationPlugin()],
-});
-```
-
-Then create the `module-federation.config.ts` file and write the required configuration:
-
-```ts title="module-federation.config.ts"
-import { createModuleFederationConfig } from '@module-federation/modern-js';
-export default createModuleFederationConfig({
-  name: 'host',
-  remotes: {
-    remote: 'remote@http://localhost:3006/mf-manifest.json',
-  },
-  shared: {
-    react: { singleton: true },
-    'react-dom': { singleton: true },
-  },
-});
-```
-
-### Type support
-
-add `/// <reference types='@module-federation/modern-js/types' />` in `modern-app-env.d.ts` to get type support.
-
-```diff title='modern-app-env.d.ts'
-+ /// <reference types='@module-federation/modern-js/types' />
-```
-
-## Server-Side Rendering
-
-:::info
-For a better performance experience, Module Federation X Modern.js SSR only supports stream SSR.
-:::
-
-There is no difference between using Module Federation in SSR scenarios and CSR scenarios. Developers can just keep following the original development behavior.
-
-But for a better user experience, we provide supporting functions/components to help developers better use Module Federation.
-
-### createRemoteSSRComponent
-
-```ts
-declare function createRemoteSSRComponent(
-  props: CreateRemoteSSRComponentOptions
-): (props: ComponentType) => React.JSX.Element;
-
-type CreateRemoteSSRComponentOptions = {
-  loader: () => Promise<T>;
-  loading: React.ReactNode;
-  fallback: ErrorBoundaryPropsWithComponent['FallbackComponent'];
-  injectScript?: boolean;
-  injectLink?: boolean;
-  export?: E;
-};
-
-type ComponentType = T[E] extends (...args: any) => any
-  ? Parameters<T[E]>[0] extends undefined
-    ? Record<string, never>
-    : Parameters<T[E]>[0]
-  : Record<string, never>;
-```
-
-This function will also help inject the corresponding style tag/script while loading the component. This behavior can help avoid the CSS flickering problem caused by streaming rendering and accelerate the PID (first screen interactive time).
-
-#### Example
-
-```tsx
-import React, { FC, memo, useEffect } from 'react';
-import { registerRemotes, createRemoteSSRComponent } from '@modern-js/runtime/mf';
-// The remote declared in the build plug-in can be imported directly at the top level
-import RemoteComp from 'remote/Image';
-
-
-const RemoteSSRComponent = createRemoteSSRComponent({
-  // The remote declared in the build plug-in can also be loaded using this function: loader: () => import('remote/Image'),
-  loader: () => loadRemote('dynamic_remote/Image'),
-  loading: <div>loading...</div>,
-  fallback: ({ error }) => {
-    if (error instanceof Error && error.message.includes('not exist')) {
-      return <div>fallback - not existed id</div>;
-    }
-    return <div>fallback</div>;
-  },
-});
-
-const Product: FC = () => {
-  registerRemotes([
-    {
-      name: 'dynamic_remote',
-      entry: 'http://localhost:3008/mf-manifest.json',
-    },
-  ]);
-
-  const fallback = (err: Error) => {
-    if (err.message.includes('does not exist in container')) {
-      return <div>404</div>;
-    }
-    throw err;
-  };
-
-  return <>
-    <RemoteSSRComponent />
-    <RemoteComp />
-  </>;
-};
-export default Product;
-```
-
-#### loading
-
-- Type:`React.ReactNode`
-- Required: Yes
-- Default value: `undefined`
-
-Set module loading status.
-
-#### fallback
-
-- Type:`((err: Error) => React.ReactElement)`
-- Required: Yes
-- Default value: `undefined`
-
-A fault-tolerant component that is rendered when the component fails to **load** or **render**.
-
-Note: This component only renders this fault-tolerant component on the client side when **rendering** fails.
-
-#### injectLink
-
-- Type:`boolean`
-- Required: No
-- Default value: `true`
-
-Whether to inject the style of the corresponding component.
-
-#### injectScript
-
-- Type:`boolean`
-- Required: No
-- Default value: `true`
-
-Whether to inject the script of the corresponding component.
-
-### collectSSRAssets
-
-```ts
-declare function createRemoteSSRComponent(
-  props: CollectSSRAssetsOptions
-): React.ReactNode[];
-
-type CollectSSRAssetsOptions = {
-  id: string;
-  injectScript?: boolean;
-  injectLink?: boolean;
-};
-```
-
-This function collects producer-related scripts and styles rendered on the server side and returns the script/link tag.
-
-#### Example
-
-```tsx
-import React from 'react';
-import { collectSSRAssets } from '@modern-js/runtime/mf';
-import Comp from 'remote/Image';
-
-export default (): JSX.Element => (
-  <div>
-    {collectSSRAssets({ id: 'remote/Image' })}
-    <Comp />
-  </div>
-);
-```
-
-#### injectLink
-
-- Type:`boolean`
-- Required: No
-- Default value: `true`
-
-Whether to inject the style of the corresponding component.
-
-#### injectScript
-
-- Type:`boolean`
-- Required: No
-- Default value: `true`
-
-Whether to inject the script of the corresponding component.
-
-### SSRLiveReload
-
-:::info
-This component will not take effect in the production environment!
-:::
-
-```ts
-declare function SSRLiveReload(): React.JSX.Element | null;
-```
-
-When remote components are updated, page reloads occur automatically.
-
-#### Example
-
-```tsx
-import { Outlet } from '@modern-js/runtime/router';
-import { SSRLiveReload } from '@modern-js/runtime/mf';
-
-export default function Layout() {
-  return (
-    <div>
-      <SSRLiveReload />
-      <Outlet />
-    </div>
-  );
-}
-```
+See [documentation](https://module-federation.io/guide/framework/modernjs.html) for more details .

package/dist/cjs/runtime/createRemoteSSRComponent.js

@@ -149,9 +149,7 @@ function createRemoteSSRComponent(info) {
         }
         const moduleId = m && m[Symbol.for("mf_module_id")];
         const assets = collectSSRAssets({
-          id: moduleId,
-          injectLink: info.injectLink,
-          injectScript: info.injectScript
+          id: moduleId
         });
         const Com = m[exportName];
         if (exportName in m && typeof Com === "function") {

package/dist/cjs/runtime/index.js

@@ -19,18 +19,13 @@ var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "defau
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var runtime_exports = {};
 __export(runtime_exports, {
-  SSRLiveReload: () => import_SSRLiveReload.SSRLiveReload,
-  collectSSRAssets: () => import_createRemoteSSRComponent.collectSSRAssets,
   createRemoteSSRComponent: () => import_createRemoteSSRComponent.createRemoteSSRComponent
 });
 module.exports = __toCommonJS(runtime_exports);
 __reExport(runtime_exports, require("@module-federation/enhanced/runtime"), module.exports);
 var import_createRemoteSSRComponent = require("./createRemoteSSRComponent");
-var import_SSRLiveReload = require("./SSRLiveReload");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  SSRLiveReload,
-  collectSSRAssets,
   createRemoteSSRComponent,
   ...require("@module-federation/enhanced/runtime")
 });

package/dist/cjs/ssr-runtime/plugin.js

@@ -31,6 +31,9 @@ __export(plugin_exports, {
   mfPluginSSR: () => mfPluginSSR
 });
 module.exports = __toCommonJS(plugin_exports);
+var import_jsx_runtime = require("react/jsx-runtime");
+var import_hoist_non_react_statics = __toESM(require("hoist-non-react-statics"));
+var import_SSRLiveReload = require("./SSRLiveReload");
 const mfPluginSSR = () => ({
   name: "@module-federation/modern-js",
   setup: () => {
@@ -52,6 +55,20 @@ const mfPluginSSR = () => ({
         return next({
           context
         });
+      },
+      hoc({ App, config }, next) {
+        const AppWrapper = (props) => /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_jsx_runtime.Fragment, {
+          children: [
+            /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_SSRLiveReload.SSRLiveReload, {}),
+            /* @__PURE__ */ (0, import_jsx_runtime.jsx)(App, {
+              ...props
+            })
+          ]
+        });
+        return next({
+          App: (0, import_hoist_non_react_statics.default)(AppWrapper, App),
+          config
+        });
       }
     };
   }

package/dist/esm/runtime/createRemoteSSRComponent.js

@@ -121,9 +121,7 @@ function createRemoteSSRComponent(info) {
             }
             moduleId = m && m[Symbol.for("mf_module_id")];
             assets = collectSSRAssets({
-              id: moduleId,
-              injectLink: info.injectLink,
-              injectScript: info.injectScript
+              id: moduleId
             });
             Com = m[exportName];
             if (exportName in m && typeof Com === "function") {

package/dist/esm/runtime/index.js

@@ -1,8 +1,5 @@
 export * from "@module-federation/enhanced/runtime";
-import { createRemoteSSRComponent, collectSSRAssets } from "./createRemoteSSRComponent";
-import { SSRLiveReload } from "./SSRLiveReload";
+import { createRemoteSSRComponent } from "./createRemoteSSRComponent";
 export {
-  SSRLiveReload,
-  collectSSRAssets,
   createRemoteSSRComponent
 };

package/dist/esm/ssr-runtime/plugin.js

@@ -1,5 +1,9 @@
 import { _ as _async_to_generator } from "@swc/helpers/_/_async_to_generator";
+import { _ as _object_spread } from "@swc/helpers/_/_object_spread";
 import { _ as _ts_generator } from "@swc/helpers/_/_ts_generator";
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
+import hoistNonReactStatics from "hoist-non-react-statics";
+import { SSRLiveReload } from "./SSRLiveReload";
 var mfPluginSSR = function() {
   return {
     name: "@module-federation/modern-js",
@@ -57,6 +61,21 @@ var mfPluginSSR = function() {
               }
             });
           })();
+        },
+        hoc: function hoc(param, next) {
+          var App = param.App, config = param.config;
+          var AppWrapper = function(props) {
+            return /* @__PURE__ */ _jsxs(_Fragment, {
+              children: [
+                /* @__PURE__ */ _jsx(SSRLiveReload, {}),
+                /* @__PURE__ */ _jsx(App, _object_spread({}, props))
+              ]
+            });
+          };
+          return next({
+            App: hoistNonReactStatics(AppWrapper, App),
+            config
+          });
         }
       };
     }

package/dist/esm-node/runtime/createRemoteSSRComponent.js

@@ -115,9 +115,7 @@ function createRemoteSSRComponent(info) {
         }
         const moduleId = m && m[Symbol.for("mf_module_id")];
         const assets = collectSSRAssets({
-          id: moduleId,
-          injectLink: info.injectLink,
-          injectScript: info.injectScript
+          id: moduleId
         });
         const Com = m[exportName];
         if (exportName in m && typeof Com === "function") {

package/dist/esm-node/runtime/index.js

@@ -1,8 +1,5 @@
 export * from "@module-federation/enhanced/runtime";
-import { createRemoteSSRComponent, collectSSRAssets } from "./createRemoteSSRComponent";
-import { SSRLiveReload } from "./SSRLiveReload";
+import { createRemoteSSRComponent } from "./createRemoteSSRComponent";
 export {
-  SSRLiveReload,
-  collectSSRAssets,
   createRemoteSSRComponent
 };

package/dist/esm-node/ssr-runtime/plugin.js

@@ -1,3 +1,6 @@
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
+import hoistNonReactStatics from "hoist-non-react-statics";
+import { SSRLiveReload } from "./SSRLiveReload";
 const mfPluginSSR = () => ({
   name: "@module-federation/modern-js",
   setup: () => {
@@ -19,6 +22,20 @@ const mfPluginSSR = () => ({
         return next({
           context
         });
+      },
+      hoc({ App, config }, next) {
+        const AppWrapper = (props) => /* @__PURE__ */ _jsxs(_Fragment, {
+          children: [
+            /* @__PURE__ */ _jsx(SSRLiveReload, {}),
+            /* @__PURE__ */ _jsx(App, {
+              ...props
+            })
+          ]
+        });
+        return next({
+          App: hoistNonReactStatics(AppWrapper, App),
+          config
+        });
       }
     };
   }

package/dist/types/cli/utils.d.ts

@@ -5,39 +5,39 @@ export type ConfigType<T> = T extends 'webpack' ? webpack.Configuration : T exte
 export declare const getMFConfig: (userConfig: PluginOptions) => Promise<moduleFederationPlugin.ModuleFederationPluginOptions>;
 export declare const patchMFConfig: (mfConfig: moduleFederationPlugin.ModuleFederationPluginOptions, isServer: boolean) => {
     runtimePlugins: string[];
-    exposes?: moduleFederationPlugin.Exposes | undefined;
-    filename?: string | undefined;
-    library?: moduleFederationPlugin.LibraryOptions | undefined;
-    name?: string | undefined;
-    remoteType?: moduleFederationPlugin.ExternalsType | undefined;
-    remotes?: moduleFederationPlugin.Remotes | undefined;
-    runtime?: moduleFederationPlugin.EntryRuntime | undefined;
-    shareScope?: string | undefined;
-    shared?: moduleFederationPlugin.Shared | undefined;
-    getPublicPath?: string | undefined;
-    implementation?: string | undefined;
-    manifest?: boolean | moduleFederationPlugin.PluginManifestOptions | undefined;
-    dev?: boolean | moduleFederationPlugin.PluginDevOptions | undefined;
-    dts?: boolean | moduleFederationPlugin.PluginDtsOptions | undefined;
-    async?: boolean | moduleFederationPlugin.AsyncBoundaryOptions | undefined;
+    exposes?: moduleFederationPlugin.Exposes;
+    filename?: string;
+    library?: moduleFederationPlugin.LibraryOptions;
+    name?: string;
+    remoteType?: moduleFederationPlugin.ExternalsType;
+    remotes?: moduleFederationPlugin.Remotes;
+    runtime?: moduleFederationPlugin.EntryRuntime;
+    shareScope?: string;
+    shared?: moduleFederationPlugin.Shared;
+    getPublicPath?: string;
+    implementation?: string;
+    manifest?: boolean | moduleFederationPlugin.PluginManifestOptions;
+    dev?: boolean | moduleFederationPlugin.PluginDevOptions;
+    dts?: boolean | moduleFederationPlugin.PluginDtsOptions;
+    async?: boolean | moduleFederationPlugin.AsyncBoundaryOptions;
 };
 export declare function getTargetEnvConfig(mfConfig: moduleFederationPlugin.ModuleFederationPluginOptions, isServer: boolean): {
     runtimePlugins: string[];
-    exposes?: moduleFederationPlugin.Exposes | undefined;
-    filename?: string | undefined;
-    library?: moduleFederationPlugin.LibraryOptions | undefined;
-    name?: string | undefined;
-    remoteType?: moduleFederationPlugin.ExternalsType | undefined;
-    remotes?: moduleFederationPlugin.Remotes | undefined;
-    runtime?: moduleFederationPlugin.EntryRuntime | undefined;
-    shareScope?: string | undefined;
-    shared?: moduleFederationPlugin.Shared | undefined;
-    getPublicPath?: string | undefined;
-    implementation?: string | undefined;
-    manifest?: boolean | moduleFederationPlugin.PluginManifestOptions | undefined;
-    dev?: boolean | moduleFederationPlugin.PluginDevOptions | undefined;
-    dts?: boolean | moduleFederationPlugin.PluginDtsOptions | undefined;
-    async?: boolean | moduleFederationPlugin.AsyncBoundaryOptions | undefined;
+    exposes?: moduleFederationPlugin.Exposes;
+    filename?: string;
+    library?: moduleFederationPlugin.LibraryOptions;
+    name?: string;
+    remoteType?: moduleFederationPlugin.ExternalsType;
+    remotes?: moduleFederationPlugin.Remotes;
+    runtime?: moduleFederationPlugin.EntryRuntime;
+    shareScope?: string;
+    shared?: moduleFederationPlugin.Shared;
+    getPublicPath?: string;
+    implementation?: string;
+    manifest?: boolean | moduleFederationPlugin.PluginManifestOptions;
+    dev?: boolean | moduleFederationPlugin.PluginDevOptions;
+    dts?: boolean | moduleFederationPlugin.PluginDtsOptions;
+    async?: boolean | moduleFederationPlugin.AsyncBoundaryOptions;
 };
 export declare function patchWebpackConfig<T>(options: {
     bundlerConfig: ConfigType<T>;

package/dist/types/runtime/createRemoteSSRComponent.d.ts

@@ -10,8 +10,6 @@ export declare function createRemoteSSRComponent<T, E extends keyof T>(info: {
     loader: () => Promise<T>;
     loading: React.ReactNode;
     fallback: ErrorBoundaryPropsWithComponent['FallbackComponent'];
-    injectScript?: boolean;
-    injectLink?: boolean;
     export?: E;
 }): (props: T[E] extends (...args: any) => any ? Parameters<T[E]>[0] extends undefined ? Record<string, never> : Parameters<T[E]>[0] : Record<string, never>) => React.JSX.Element;
 export {};

package/dist/types/runtime/index.d.ts

@@ -1,3 +1,2 @@
 export * from '@module-federation/enhanced/runtime';
-export { createRemoteSSRComponent, collectSSRAssets, } from './createRemoteSSRComponent';
-export { SSRLiveReload } from './SSRLiveReload';
+export { createRemoteSSRComponent } from './createRemoteSSRComponent';

package/dist/types/{runtime → ssr-runtime}/SSRLiveReload.d.ts

@@ -1,2 +1 @@
-/// <reference types="react" />
 export declare function SSRLiveReload(): import("react").JSX.Element | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/modern-js",
-  "version": "0.0.0-next-20240626050252",
+  "version": "0.0.0-next-20240708090519",
   "files": [
     "dist/",
     "types.d.ts",
@@ -47,17 +47,19 @@
     "@modern-js/node-bundle-require": "^2.54.2",
     "node-fetch": "~3.3.0",
     "react-error-boundary": "4.0.13",
-    "@module-federation/sdk": "0.0.0-next-20240626050252",
-    "@module-federation/enhanced": "0.0.0-next-20240626050252",
-    "@module-federation/node": "0.0.0-next-20240626050252"
+    "hoist-non-react-statics": "3.3.2",
+    "@module-federation/sdk": "0.0.0-next-20240708090519",
+    "@module-federation/enhanced": "0.0.0-next-20240708090519",
+    "@module-federation/node": "0.0.0-next-20240708090519"
   },
   "devDependencies": {
+    "@types/hoist-non-react-statics": "3.3.2",
     "@modern-js/app-tools": "^2.54.2",
     "@modern-js/core": "^2.54.2",
     "@modern-js/runtime": "^2.54.2",
     "@modern-js/module-tools": "^2.54.2",
     "@modern-js/tsconfig": "^2.54.2",
-    "@module-federation/manifest": "0.0.0-next-20240626050252"
+    "@module-federation/manifest": "0.0.0-next-20240708090519"
   },
   "peerDependencies": {
     "react": ">=17",