@module-federation/data-prefetch 0.0.0-next-20241009075733 → 0.0.0-next-20241009081924

package/CHANGELOG.md

@@ -1,15 +1,12 @@
 # @module-federation/data-prefetch
 
-## 0.0.0-next-20241009075733
+## 0.0.0-next-20241009081924
 
 ### Patch Changes
 
-- 5364c07: fix(data-prefetch): apply DataPrefetchPlugin on demand
-- 026c308: fix(data-prefetch): set sharedStrategy in build options instead of using runtime plugin
 - Updated dependencies [b704f30]
-- Updated dependencies [5364c07]
-  - @module-federation/runtime@0.0.0-next-20241009075733
-  - @module-federation/sdk@0.0.0-next-20241009075733
+  - @module-federation/runtime@0.0.0-next-20241009081924
+  - @module-federation/sdk@0.0.0-next-20241009081924
 
 ## 0.6.9
 

package/dist/cli.cjs.js

@@ -5,7 +5,6 @@ var fs = require('fs-extra');
 var sdk = require('@module-federation/sdk');
 var normalizeWebpackPath = require('@module-federation/sdk/normalize-webpack-path');
 var runtimeUtils = require('./runtime-utils.cjs.js');
-var constant = require('./constant.cjs.js');
 require('@module-federation/runtime');
 
 const TEMP_DIR = '.mf';
@@ -41,7 +40,7 @@ function getFederationGlobalScope(runtimeGlobals) {
 class PrefetchPlugin {
     // eslint-disable-next-line max-lines-per-function
     apply(compiler) {
-        var _this_options_runtimePlugins;
+        var _this_options_runtimePlugins, _this_options_runtimePlugins1;
         const { name, exposes } = this.options;
         if (!exposes) {
             return;
@@ -54,12 +53,12 @@ class PrefetchPlugin {
             this.options.runtimePlugins = [];
         }
         const runtimePath = path.resolve(__dirname, './plugin.esm.js');
+        const sharedPath = path.resolve(__dirname, './shared.esm.js');
         if (!((_this_options_runtimePlugins = this.options.runtimePlugins) == null ? void 0 : _this_options_runtimePlugins.includes(runtimePath))) {
             this.options.runtimePlugins.push(runtimePath);
         }
-        if (this.options.shareStrategy !== constant.SHARED_STRATEGY) {
-            this.options.shareStrategy = constant.SHARED_STRATEGY;
-            console.warn(`[Module Federation Data Prefetch]: Your shared strategy is set to '${constant.SHARED_STRATEGY}', this is a necessary condition for data prefetch`);
+        if (!((_this_options_runtimePlugins1 = this.options.runtimePlugins) == null ? void 0 : _this_options_runtimePlugins1.includes(sharedPath))) {
+            this.options.runtimePlugins.push(sharedPath);
         }
         const encodedName = sdk.encodeName(name);
         const asyncEntryPath = path.resolve(compiler.options.context, `node_modules/${TEMP_DIR}/${encodedName}/bootstrap.js`);

package/dist/cli.esm.js

@@ -3,7 +3,6 @@ import fs from 'fs-extra';
 import { encodeName, MFPrefetchCommon } from '@module-federation/sdk';
 import { normalizeWebpackPath } from '@module-federation/sdk/normalize-webpack-path';
 import { b as getPrefetchId } from './runtime-utils.esm.js';
-import { S as SHARED_STRATEGY } from './constant.esm.js';
 import '@module-federation/runtime';
 
 const TEMP_DIR = '.mf';
@@ -39,7 +38,7 @@ function getFederationGlobalScope(runtimeGlobals) {
 class PrefetchPlugin {
     // eslint-disable-next-line max-lines-per-function
     apply(compiler) {
-        var _this_options_runtimePlugins;
+        var _this_options_runtimePlugins, _this_options_runtimePlugins1;
         const { name, exposes } = this.options;
         if (!exposes) {
             return;
@@ -52,12 +51,12 @@ class PrefetchPlugin {
             this.options.runtimePlugins = [];
         }
         const runtimePath = path.resolve(__dirname, './plugin.esm.js');
+        const sharedPath = path.resolve(__dirname, './shared.esm.js');
         if (!((_this_options_runtimePlugins = this.options.runtimePlugins) == null ? void 0 : _this_options_runtimePlugins.includes(runtimePath))) {
             this.options.runtimePlugins.push(runtimePath);
         }
-        if (this.options.shareStrategy !== SHARED_STRATEGY) {
-            this.options.shareStrategy = SHARED_STRATEGY;
-            console.warn(`[Module Federation Data Prefetch]: Your shared strategy is set to '${SHARED_STRATEGY}', this is a necessary condition for data prefetch`);
+        if (!((_this_options_runtimePlugins1 = this.options.runtimePlugins) == null ? void 0 : _this_options_runtimePlugins1.includes(sharedPath))) {
+            this.options.runtimePlugins.push(sharedPath);
         }
         const encodedName = encodeName(name);
         const asyncEntryPath = path.resolve(compiler.options.context, `node_modules/${TEMP_DIR}/${encodedName}/bootstrap.js`);

package/dist/index.cjs.js

@@ -6,7 +6,6 @@ require('@module-federation/runtime');
 require('@module-federation/sdk');
 require('./runtime-utils.cjs.js');
 require('./index.cjs2.js');
-require('./constant.cjs.js');
 
 
 

package/dist/index.esm.js

@@ -4,4 +4,3 @@ import '@module-federation/runtime';
 import '@module-federation/sdk';
 import './runtime-utils.esm.js';
 import './index.esm2.js';
-import './constant.esm.js';

package/dist/package.json

@@ -6,6 +6,8 @@
   "homepage": "https://github.com/module-federation/core",
   "license": "MIT",
   "scripts": {
+    "dev": "cross-env WATCH=true tsup",
+    "build": "rm -rf dist && tsup",
     "test": "jest"
   },
   "publishConfig": {
@@ -36,6 +38,11 @@
       "import": "./dist/universal.esm.js",
       "require": "./dist/universal.cjs.js",
       "types": "./dist/universal.cjs.d.ts"
+    },
+    "./shared": {
+      "import": "./dist/shared.esm.js",
+      "require": "./dist/shared.cjs.js",
+      "types": "./dist/shared/.cjs.d.ts"
     }
   },
   "typesVersions": {
@@ -52,6 +59,9 @@
       "universal": [
         "./dist/universal.cjs.d.ts"
       ],
+      "shared": [
+        "./dist/shared.cjs.d.ts"
+      ],
       "babel-plugin": [
         "./dist/babel.cjs.d.ts"
       ]
@@ -69,6 +79,7 @@
     "@types/jest": "^29.5.11",
     "@types/node": "^17.0.45",
     "@types/react": "~18.0.38",
+    "esbuild-plugin-replace": "^1.4.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "minimist": "^1.2.8",
@@ -77,6 +88,7 @@
     "react-router": "^6.21.3",
     "react-test-renderer": "^18.2.0",
     "ts-jest": "29.0.1",
+    "tsup": "6.2.0",
     "webpack": "5.75.0"
   },
   "dependencies": {

package/dist/plugin.cjs.js

@@ -6,11 +6,11 @@ var sdk = require('@module-federation/sdk');
 var runtimeUtils = require('./runtime-utils.cjs.js');
 var prefetch = require('./prefetch.cjs.js');
 var index = require('./index.cjs2.js');
-var constant = require('./constant.cjs.js');
 require('@module-federation/runtime');
 
 const loadingArray = [];
-let sharedFlag = constant.SHARED_STRATEGY;
+const strategy = 'loaded-first';
+let sharedFlag = strategy;
 // eslint-disable-next-line max-lines-per-function
 const prefetchPlugin = ()=>({
         name: 'data-prefetch-runtime-plugin',
@@ -28,7 +28,7 @@ const prefetchPlugin = ()=>({
             if (!signal) {
                 return options;
             }
-            if (sharedFlag !== constant.SHARED_STRATEGY) {
+            if (sharedFlag !== strategy) {
                 throw new Error(`[Module Federation Data Prefetch]: If you want to use data prefetch, the shared strategy must be 'loaded-first'`);
             }
             const instance = prefetch.MFDataPrefetch.getInstance(name) || new prefetch.MFDataPrefetch(prefetchOptions);
@@ -88,7 +88,7 @@ const prefetchPlugin = ()=>({
             if (!inited) {
                 return options;
             }
-            if (sharedFlag !== constant.SHARED_STRATEGY) {
+            if (sharedFlag !== strategy) {
                 throw new Error(`[Module Federation Data Prefetch]: If you want to use data prefetch, the shared strategy must be 'loaded-first'`);
             }
             const instance = prefetch.MFDataPrefetch.getInstance(name) || new prefetch.MFDataPrefetch(prefetchOptions);

package/dist/plugin.esm.js

@@ -2,11 +2,11 @@ import { getResourceUrl } from '@module-federation/sdk';
 import { a as getSignalFromManifest } from './runtime-utils.esm.js';
 import { M as MFDataPrefetch } from './prefetch.esm.js';
 import { l as logger } from './index.esm2.js';
-import { S as SHARED_STRATEGY } from './constant.esm.js';
 import '@module-federation/runtime';
 
 const loadingArray = [];
-let sharedFlag = SHARED_STRATEGY;
+const strategy = 'loaded-first';
+let sharedFlag = strategy;
 // eslint-disable-next-line max-lines-per-function
 const prefetchPlugin = ()=>({
         name: 'data-prefetch-runtime-plugin',
@@ -24,7 +24,7 @@ const prefetchPlugin = ()=>({
             if (!signal) {
                 return options;
             }
-            if (sharedFlag !== SHARED_STRATEGY) {
+            if (sharedFlag !== strategy) {
                 throw new Error(`[Module Federation Data Prefetch]: If you want to use data prefetch, the shared strategy must be 'loaded-first'`);
             }
             const instance = MFDataPrefetch.getInstance(name) || new MFDataPrefetch(prefetchOptions);
@@ -84,7 +84,7 @@ const prefetchPlugin = ()=>({
             if (!inited) {
                 return options;
             }
-            if (sharedFlag !== SHARED_STRATEGY) {
+            if (sharedFlag !== strategy) {
                 throw new Error(`[Module Federation Data Prefetch]: If you want to use data prefetch, the shared strategy must be 'loaded-first'`);
             }
             const instance = MFDataPrefetch.getInstance(name) || new MFDataPrefetch(prefetchOptions);

package/dist/shared.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./src/shared/index";
+export { default } from "./src/shared/index";

package/dist/shared.cjs.js

@@ -0,0 +1,24 @@
+'use strict';
+
+const sharedStrategy = ()=>({
+        name: 'shared-strategy',
+        beforeInit (args) {
+            const { userOptions } = args;
+            const shared = userOptions.shared;
+            if (shared) {
+                Object.keys(shared).forEach((sharedKey)=>{
+                    const sharedConfigs = shared[sharedKey];
+                    const arraySharedConfigs = Array.isArray(sharedConfigs) ? sharedConfigs : [
+                        sharedConfigs
+                    ];
+                    arraySharedConfigs.forEach((s)=>{
+                        s.strategy = 'loaded-first';
+                    });
+                });
+                console.warn(`[Module Federation Data Prefetch]: Your shared strategy is set to 'loaded-first', this is a necessary condition for data prefetch`);
+            }
+            return args;
+        }
+    });
+
+module.exports = sharedStrategy;

package/dist/shared.esm.d.ts

@@ -0,0 +1,2 @@
+export * from "./src/shared/index";
+export { default } from "./src/shared/index";

package/dist/shared.esm.js

@@ -0,0 +1,22 @@
+const sharedStrategy = ()=>({
+        name: 'shared-strategy',
+        beforeInit (args) {
+            const { userOptions } = args;
+            const shared = userOptions.shared;
+            if (shared) {
+                Object.keys(shared).forEach((sharedKey)=>{
+                    const sharedConfigs = shared[sharedKey];
+                    const arraySharedConfigs = Array.isArray(sharedConfigs) ? sharedConfigs : [
+                        sharedConfigs
+                    ];
+                    arraySharedConfigs.forEach((s)=>{
+                        s.strategy = 'loaded-first';
+                    });
+                });
+                console.warn(`[Module Federation Data Prefetch]: Your shared strategy is set to 'loaded-first', this is a necessary condition for data prefetch`);
+            }
+            return args;
+        }
+    });
+
+export { sharedStrategy as default };

package/dist/src/shared/index.d.ts

@@ -0,0 +1,3 @@
+import type { FederationRuntimePlugin } from '@module-federation/runtime';
+declare const sharedStrategy: () => FederationRuntimePlugin;
+export default sharedStrategy;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@module-federation/data-prefetch",
   "description": "Module Federation Data Prefetch",
-  "version": "0.0.0-next-20241009075733",
+  "version": "0.0.0-next-20241009081924",
   "author": "nieyan <nyqykk@foxmail.com>",
   "homepage": "https://github.com/module-federation/core",
   "license": "MIT",
@@ -33,6 +33,11 @@
       "import": "./dist/universal.esm.js",
       "require": "./dist/universal.cjs.js",
       "types": "./dist/universal.cjs.d.ts"
+    },
+    "./shared": {
+      "import": "./dist/shared.esm.js",
+      "require": "./dist/shared.cjs.js",
+      "types": "./dist/shared/.cjs.d.ts"
     }
   },
   "typesVersions": {
@@ -49,6 +54,9 @@
       "universal": [
         "./dist/universal.cjs.d.ts"
       ],
+      "shared": [
+        "./dist/shared.cjs.d.ts"
+      ],
       "babel-plugin": [
         "./dist/babel.cjs.d.ts"
       ]
@@ -66,6 +74,7 @@
     "@types/jest": "^29.5.11",
     "@types/node": "^17.0.45",
     "@types/react": "~18.0.38",
+    "esbuild-plugin-replace": "^1.4.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "minimist": "^1.2.8",
@@ -74,14 +83,17 @@
     "react-router": "^6.21.3",
     "react-test-renderer": "^18.2.0",
     "ts-jest": "29.0.1",
+    "tsup": "6.2.0",
     "webpack": "5.75.0"
   },
   "dependencies": {
     "fs-extra": "9.1.0",
-    "@module-federation/runtime": "0.0.0-next-20241009075733",
-    "@module-federation/sdk": "0.0.0-next-20241009075733"
+    "@module-federation/runtime": "0.0.0-next-20241009081924",
+    "@module-federation/sdk": "0.0.0-next-20241009081924"
   },
   "scripts": {
+    "dev": "cross-env WATCH=true tsup",
+    "build": "rm -rf dist && tsup",
     "test": "jest"
   }
 }

package/rollup.config.js

@@ -18,6 +18,7 @@ module.exports = (rollupConfig, _projectOptions) => {
     babel: 'packages/data-prefetch/src/cli/babel.ts',
     universal: 'packages/data-prefetch/src/universal/index.ts',
     plugin: 'packages/data-prefetch/src/plugin.ts',
+    shared: 'packages/data-prefetch/src/shared/index.ts',
   };
 
   if (Array.isArray(rollupConfig.output)) {

package/src/cli/index.ts

@@ -12,7 +12,6 @@ import type { Compiler, WebpackPluginInstance } from 'webpack';
 import { TEMP_DIR } from '../common/constant';
 import { fileExistsWithCaseSync, fixPrefetchPath } from '../common/node-utils';
 import { getPrefetchId } from '../common/runtime-utils';
-import { SHARED_STRATEGY } from '../constant';
 
 const { RuntimeGlobals, Template } = require(
   normalizeWebpackPath('webpack'),
@@ -49,14 +48,12 @@ export class PrefetchPlugin implements WebpackPluginInstance {
     }
 
     const runtimePath = path.resolve(__dirname, './plugin.esm.js');
+    const sharedPath = path.resolve(__dirname, './shared.esm.js');
     if (!this.options.runtimePlugins?.includes(runtimePath)) {
       this.options.runtimePlugins!.push(runtimePath);
     }
-    if (this.options.shareStrategy !== SHARED_STRATEGY) {
-      this.options.shareStrategy = SHARED_STRATEGY;
-      console.warn(
-        `[Module Federation Data Prefetch]: Your shared strategy is set to '${SHARED_STRATEGY}', this is a necessary condition for data prefetch`,
-      );
+    if (!this.options.runtimePlugins?.includes(sharedPath)) {
+      this.options.runtimePlugins!.push(sharedPath);
     }
 
     const encodedName = encodeName(name as string);

package/src/plugin.ts

@@ -4,7 +4,6 @@ import { ModuleInfo, getResourceUrl } from '@module-federation/sdk';
 import { getSignalFromManifest } from './common/runtime-utils';
 import { MFDataPrefetch } from './prefetch';
 import logger from './logger';
-import { SHARED_STRATEGY } from './constant';
 
 interface Loading {
   id: string;
@@ -16,7 +15,8 @@ interface Loading {
   >;
 }
 const loadingArray: Array<Loading> = [];
-let sharedFlag = SHARED_STRATEGY;
+const strategy = 'loaded-first';
+let sharedFlag = strategy;
 // eslint-disable-next-line max-lines-per-function
 export const prefetchPlugin = (): FederationRuntimePlugin => ({
   name: 'data-prefetch-runtime-plugin',
@@ -35,7 +35,7 @@ export const prefetchPlugin = (): FederationRuntimePlugin => ({
     if (!signal) {
       return options;
     }
-    if (sharedFlag !== SHARED_STRATEGY) {
+    if (sharedFlag !== strategy) {
       throw new Error(
         `[Module Federation Data Prefetch]: If you want to use data prefetch, the shared strategy must be 'loaded-first'`,
       );
@@ -109,7 +109,7 @@ export const prefetchPlugin = (): FederationRuntimePlugin => ({
       return options;
     }
 
-    if (sharedFlag !== SHARED_STRATEGY) {
+    if (sharedFlag !== strategy) {
       throw new Error(
         `[Module Federation Data Prefetch]: If you want to use data prefetch, the shared strategy must be 'loaded-first'`,
       );

package/src/shared/index.ts

@@ -0,0 +1,26 @@
+import type { FederationRuntimePlugin } from '@module-federation/runtime';
+
+const sharedStrategy: () => FederationRuntimePlugin = () => ({
+  name: 'shared-strategy',
+  beforeInit(args) {
+    const { userOptions } = args;
+    const shared = userOptions.shared;
+    if (shared) {
+      Object.keys(shared).forEach((sharedKey) => {
+        const sharedConfigs = shared[sharedKey];
+        const arraySharedConfigs = Array.isArray(sharedConfigs)
+          ? sharedConfigs
+          : [sharedConfigs];
+        arraySharedConfigs.forEach((s) => {
+          s.strategy = 'loaded-first';
+        });
+      });
+      console.warn(
+        `[Module Federation Data Prefetch]: Your shared strategy is set to 'loaded-first', this is a necessary condition for data prefetch`,
+      );
+    }
+    return args;
+  },
+});
+
+export default sharedStrategy;

package/tsup.config.ts

@@ -0,0 +1,35 @@
+import { replace } from 'esbuild-plugin-replace';
+import minimist from 'minimist';
+import type { Options } from 'tsup';
+
+import pkg from './package.json';
+
+const args = minimist(process.argv.slice(2));
+const watch = process.env.WATCH;
+const sourceMap = args.sourcemap || args.s;
+
+export const tsup: Options = {
+  entry: [
+    'src/index.ts',
+    'src/react/index.ts',
+    'src/cli/index.ts',
+    'src/cli/babel.ts',
+    'src/universal/index.ts',
+    'src/plugin.ts',
+    'src/shared/index.ts',
+  ],
+  sourcemap: sourceMap,
+  clean: true,
+  dts: true,
+  watch: watch ? 'src/' : false,
+  format: ['esm', 'cjs'],
+  legacyOutput: true,
+  esbuildPlugins: [
+    replace({
+      __VERSION__: `'${pkg.version}'`,
+      __DEV__:
+        '(typeof process !== "undefined" && process.env && process.env.NODE_ENV ? (process.env.NODE_ENV !== "production") : false)',
+      __TEST__: 'false',
+    }),
+  ],
+};

package/dist/constant.cjs.js

@@ -1,5 +0,0 @@
-'use strict';
-
-const SHARED_STRATEGY = 'loaded-first';
-
-exports.SHARED_STRATEGY = SHARED_STRATEGY;

package/dist/constant.esm.js

@@ -1,3 +0,0 @@
-const SHARED_STRATEGY = 'loaded-first';
-
-export { SHARED_STRATEGY as S };

package/dist/src/constant.d.ts

@@ -1 +0,0 @@
-export declare const SHARED_STRATEGY = "loaded-first";

package/src/constant.ts

@@ -1 +0,0 @@
-export const SHARED_STRATEGY = 'loaded-first';