@module-federation/nextjs-mf 8.7.3 → 8.7.5

package/README.md

@@ -1,380 +1,5 @@
-<div align="center">
-	<!--  for version -->
-  <img src="https://img.shields.io/npm/v/@module-federation/nextjs-mf" alt="version" >
-	<img src="https://img.shields.io/npm/l/@module-federation/nextjs-mf.svg?" alt="license" >
-  <!-- for downloads -->
-  <img src="https://img.shields.io/npm/dt/@module-federation/nextjs-mf" alt="downloads">
- </div>
+# Next.js Support is in maintenance mode
 
-# Module Federation For Next.js
+Read about it [here](https://github.com/module-federation/core/issues/3153)
 
-This plugin enables Module Federation on Next.js
-
-## Supports
-
-- next ^14 || ^13 || ^12
-- SSR included!
-
-I highly recommend referencing this application which takes advantage of the best capabilities:
-https://github.com/module-federation/module-federation-examples
-
-## This project supports federated SSR
-
-# We are building a micro-frontend ecosystem!
-
-While NextFederationPlugin "works", Next.js is staunchly opposed to the technology and Next is very difficult to support.
-
-This plugin attempts to make the experience as seamless as possible, but it is not perfect.
-
-We are building a micro-frontend ecosystem that is much more powerful than Next.js, built to support micro-frontends from the ground up.
-
-**If Federation is a big enabler for your teams and projects, please consider using our ecosystem thats designed for it**
-
-|    [Rspack](https://github.com/web-infra-dev/rspack)    |  <a href="https://github.com/web-infra-dev/rspack" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/Rspack-1850.png" width="400" /></a>   |
-| :-----------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
-| [Modern.js](https://github.com/web-infra-dev/modern.js) | <a href="https://github.com/web-infra-dev/modern.js" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/Modern-0550.png" width="400" /></a> |
-|   [Garfish](https://github.com/web-infra-dev/garfish)   | <a href="https://github.com/web-infra-dev/garfish" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/Garfish-1630.png" width="400" /></a>  |
-|       [Oxc](https://github.com/web-infra-dev/oxc)       |     <a href="https://github.com/web-infra-dev/oxc" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/Oxc-0724.png" width="400" /></a>      |
-
-## Whats shared by default?
-
-Under the hood we share some next internals automatically
-You do not need to share these packages, sharing next internals yourself will cause errors.
-
-<details>
-<summary> See DEFAULT_SHARE_SCOPE:</summary>
-
-```ts
-export const DEFAULT_SHARE_SCOPE: SharedObject = {
-  'next/dynamic': {
-    requiredVersion: undefined,
-    singleton: true,
-    import: undefined,
-  },
-  'next/head': {
-    requiredVersion: undefined,
-    singleton: true,
-    import: undefined,
-  },
-  'next/link': {
-    requiredVersion: undefined,
-    singleton: true,
-    import: undefined,
-  },
-  'next/router': {
-    requiredVersion: false,
-    singleton: true,
-    import: undefined,
-  },
-  'next/image': {
-    requiredVersion: undefined,
-    singleton: true,
-    import: undefined,
-  },
-  'next/script': {
-    requiredVersion: undefined,
-    singleton: true,
-    import: undefined,
-  },
-  react: {
-    singleton: true,
-    requiredVersion: false,
-    import: false,
-  },
-  'react/': {
-    singleton: true,
-    requiredVersion: false,
-    import: false,
-  },
-  'react-dom/': {
-    singleton: true,
-    requiredVersion: false,
-    import: false,
-  },
-  'react-dom': {
-    singleton: true,
-    requiredVersion: false,
-    import: false,
-  },
-  'react/jsx-dev-runtime': {
-    singleton: true,
-    requiredVersion: false,
-  },
-  'react/jsx-runtime': {
-    singleton: true,
-    requiredVersion: false,
-  },
-  'styled-jsx': {
-    singleton: true,
-    import: undefined,
-    version: require('styled-jsx/package.json').version,
-    requiredVersion: '^' + require('styled-jsx/package.json').version,
-  },
-  'styled-jsx/style': {
-    singleton: true,
-    import: false,
-    version: require('styled-jsx/package.json').version,
-    requiredVersion: '^' + require('styled-jsx/package.json').version,
-  },
-  'styled-jsx/css': {
-    singleton: true,
-    import: undefined,
-    version: require('styled-jsx/package.json').version,
-    requiredVersion: '^' + require('styled-jsx/package.json').version,
-  },
-};
-```
-
-</details>
-
-## Requirement
-
-I set `process.env.NEXT_PRIVATE_LOCAL_WEBPACK = 'true'` inside this plugin, but its best if its set in env or command line export.
-
-"Local Webpack" means you must have webpack installed as a dependency, and next will not use its bundled copy of webpack which cannot be used as i need access to all of webpack internals
-
-- `cross-env NEXT_PRIVATE_LOCAL_WEBPACK=true next dev` or `next build`
-- `npm install webpack`
-
-## Usage
-
-```js
-import React, { lazy } from 'react';
-const SampleComponent = lazy(() => import('next2/sampleComponent'));
-```
-
-To avoid hydration errors, use `React.lazy` instead of `next/dynamic` for lazy loading federated components.
-
-#### See the implementation here: https://github.com/module-federation/module-federation-examples/tree/master/nextjs-v13/home/pages
-
-With async boundary installed at the page level. You can then do the following
-
-```js
-const SomeHook = require('next2/someHook');
-import SomeComponent from 'next2/someComponent';
-```
-
-## Demo
-
-You can see it in action here: https://github.com/module-federation/module-federation-examples/tree/master/nextjs-ssr
-
-## Options
-
-This plugin works exactly like ModuleFederationPlugin, use it as you'd normally.
-Note that we already share react and next stuff for you automatically.
-
-Also NextFederationPlugin has own optional argument `extraOptions` where you can unlock additional features of this plugin:
-
-```js
-new NextFederationPlugin({
-  name: '',
-  filename: '',
-  remotes: {},
-  exposes: {},
-  shared: {},
-  extraOptions: {
-    debug: boolean, // `false` by default
-    exposePages: boolean, // `false` by default
-  },
-});
-```
-
-- `debug` – enables debug mode. It will print additional information about what is going on under the hood.
-- `exposePages` – exposes automatically all nextjs pages for you and theirs `./pages-map`.
-
-## Demo
-
-You can see it in action here: https://github.com/module-federation/module-federation-examples/pull/2147
-
-## Implementing the Plugin
-
-1. Use `NextFederationPlugin` in your `next.config.js` of the app that you wish to expose modules from. We'll call this "next2".
-
-```js
-// next.config.js
-// either from default
-const NextFederationPlugin = require('@module-federation/nextjs-mf');
-
-module.exports = {
-  webpack(config, options) {
-    const { isServer } = options;
-    config.plugins.push(
-      new NextFederationPlugin({
-        name: 'next2',
-        remotes: {
-          next1: `next1@http://localhost:3001/_next/static/${isServer ? 'ssr' : 'chunks'}/remoteEntry.js`,
-        },
-        filename: 'static/chunks/remoteEntry.js',
-        exposes: {
-          './title': './components/exposedTitle.js',
-          './checkout': './pages/checkout',
-        },
-        shared: {
-          // whatever else
-        },
-      }),
-    );
-
-    return config;
-  },
-};
-```
-
-```js
-// next.config.js
-
-const NextFederationPlugin = require('@module-federation/nextjs-mf');
-
-module.exports = {
-  webpack(config, options) {
-    const { isServer } = options;
-    config.plugins.push(
-      new NextFederationPlugin({
-        name: 'next1',
-        remotes: {
-          next2: `next2@http://localhost:3000/_next/static/${isServer ? 'ssr' : 'chunks'}/remoteEntry.js`,
-        },
-      }),
-    );
-
-    return config;
-  },
-};
-```
-
-4. Use react.lazy, low level api, or require/import from to import remotes.
-
-```js
-import React, { lazy } from 'react';
-
-const SampleComponent = lazy(() =>
-  window.next2.get('./sampleComponent').then((factory) => {
-    return { default: factory() };
-  }),
-);
-
-// or
-
-const SampleComponent = lazy(() => import('next2/sampleComponent'));
-
-//or
-
-import Sample from 'next2/sampleComponent';
-```
-
-## RuntimePlugins
-
-To provide extensibility and "middleware" for federation, you can refer to `@module-federation/runtime`
-
-```js
-// next.config.js
-new NextFederationPlugin({
-  runtimePlugins: [require.resolve('./path/to/myRuntimePlugin.js')],
-});
-```
-
-## Utilities
-
-Ive added a util for dynamic chunk loading, in the event you need to load remote containers dynamically.
-
-```js
-import { loadRemote, init } from '@module-federation/runtime';
-// if i have remotes in my federation plugin, i can pass the name of the remote
-loadRemote('home/exposedModule');
-// if i want to load a custom remote not known at build time.
-init({
-  name: 'hostname',
-  remotes: [
-    {
-      name: 'home',
-      entry: 'http://somthing.com/remoteEntry.js',
-    },
-  ],
-  force: true, // may be needed to sideload remotes after the fact.
-});
-loadRemote('home/exposedModule');
-```
-
-**revalidate**
-
-### Hot Reloading with `revalidate` in Production Environments
-
-In production environments, ensuring that your server can dynamically reload and update without requiring a full restart is crucial for maintaining uptime and providing the latest features to your users without disruption. The `revalidate` utility from `@module-federation/nextjs-mf/utils` facilitates this by enabling hot reloading of the node server (not the client). This section outlines two implementations for integrating `revalidate` into your Next.js application to leverage hot reloading capabilities.
-
-#### Preferred Implementation: Blocking Updates Before Rendering
-
-This implementation is recommended for most use cases as it helps avoid hydration errors by ensuring that the server and client are always in sync. By blocking and checking for updates before rendering, you can guarantee that your application is always up-to-date without negatively impacting the user experience.
-
-**How it Works:**
-
-- **Before rendering the page**, the server checks if there are any updates available.
-- **If updates are available**, it proceeds with Hot Module Replacement (HMR) before responding to the client request.
-- **This method ensures** that all users receive the latest version of the application without encountering inconsistencies between the server-rendered and client-rendered content.
-
-**Implementation Example:**
-
-```js
-// __document.js
-
-import { revalidate } from '@module-federation/nextjs-mf/utils';
-import Document, { Html, Head, Main, NextScript } from 'next/document';
-
-class MyDocument extends Document {
-  static async getInitialProps(ctx) {
-    if (ctx?.pathname && !ctx?.pathname?.endsWith('_error')) {
-      await revalidate().then((shouldUpdate) => {
-        if (shouldUpdate) {
-          console.log('Hot Module Replacement (HMR) activated', shouldUpdate);
-        }
-      });
-    }
-
-    const initialProps = await Document.getInitialProps(ctx);
-    return initialProps;
-  }
-
-  render() {
-    return (
-      <Html>
-        <Head />
-        <body>
-          <Main />
-          <NextScript />
-        </body>
-      </Html>
-    );
-  }
-}
-```
-
-#### Stale Method: Post-Response Update Checks
-
-While not recommended due to the potential for hydration errors, this method involves listening for the 'finish' event on the response object and then checking for updates. This could be useful in specific scenarios where updates can be applied less frequently or where immediate consistency between server and client is not as critical.
-
-**How it Works:**
-
-- **After responding to the client**, the server listens for the 'finish' event on the response object.
-- **Once the response has been sent**, it checks for updates.
-- **If updates are found**, it logs or acts upon these updates, although the updates will only apply to subsequent requests.
-
-**Implementation Example:**
-
-```js
-// Included in the `getInitialProps` method as shown in the preferred implementation
-ctx?.res?.on('finish', () => {
-  revalidate().then((shouldUpdate) => {
-    console.log('Response sent, checking for updates:', shouldUpdate);
-  });
-});
-```
-
-## For Express.js
-
-Hot reloading Express.js required additional steps: https://github.com/module-federation/core/blob/main/packages/node/README.md
-
-## Contact
-
-If you have any questions or need to report a bug
-<a href="https://twitter.com/ScriptedAlchemy"> Reach me on Twitter @ScriptedAlchemy</a>
-
-Or join this discussion thread: https://github.com/module-federation/module-federation-examples/discussions/978
+Plugin Documentation: [here](https://module-federation.io/practice/frameworks/next/index.html)

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/nextjs-mf",
-  "version": "8.7.3",
+  "version": "8.7.5",
   "license": "MIT",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -15,6 +15,9 @@
     "dist/",
     "README.md"
   ],
+  "scripts": {
+    "postinstall": "echo \"Deprecation Notice: We intend to deprecate 'nextjs-mf'. Please see https://github.com/module-federation/core/issues/3153 for more details.\""
+  },
   "exports": {
     ".": "./dist/src/index.js",
     "./utils": "./dist/utils/index.js",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/nextjs-mf",
-  "version": "8.7.3",
+  "version": "8.7.5",
   "license": "MIT",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -35,11 +35,11 @@
   },
   "dependencies": {
     "fast-glob": "^3.2.11",
-    "@module-federation/runtime": "0.6.15",
-    "@module-federation/sdk": "0.6.15",
-    "@module-federation/enhanced": "0.6.15",
-    "@module-federation/node": "2.6.3",
-    "@module-federation/webpack-bundler-runtime": "0.6.15"
+    "@module-federation/runtime": "0.7.0",
+    "@module-federation/sdk": "0.7.0",
+    "@module-federation/enhanced": "0.7.0",
+    "@module-federation/node": "2.6.5",
+    "@module-federation/webpack-bundler-runtime": "0.7.0"
   },
   "peerDependencies": {
     "webpack": "^5.40.0",
@@ -52,5 +52,8 @@
     "styled-jsx": {
       "optional": true
     }
+  },
+  "scripts": {
+    "postinstall": "echo \"Deprecation Notice: We intend to deprecate 'nextjs-mf'. Please see https://github.com/module-federation/core/issues/3153 for more details.\""
   }
 }