@module-federation/data-prefetch 0.0.0-next-20240924022552 → 0.0.0-next-20240927010732

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@module-federation/data-prefetch",
   "description": "Module Federation Data Prefetch",
-  "version": "0.0.0-next-20240924022552",
+  "version": "0.0.0-next-20240927010732",
   "author": "nieyan <nyqykk@foxmail.com>",
   "homepage": "https://github.com/module-federation/core",
   "license": "MIT",
@@ -10,57 +10,60 @@
   },
   "exports": {
     ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.cjs.d.ts"
     },
     "./react": {
-      "import": "./dist/esm/react/index.js",
-      "require": "./dist/react/index.js",
-      "types": "./dist/react/index.d.ts"
+      "import": "./dist/react.esm.js",
+      "require": "./dist/react.cjs.js",
+      "types": "./dist/react.cjs.d.ts"
     },
     "./cli": {
-      "import": "./dist/esm/cli/index.js",
-      "require": "./dist/cli/index.js",
-      "types": "./dist/cli/index.d.ts"
+      "import": "./dist/cli.esm.js",
+      "require": "./dist/cli.cjs.js",
+      "types": "./dist/cli.cjs.d.ts"
     },
     "./babel-plugin": {
-      "import": "./dist/esm/cli/babel.js",
-      "require": "./dist/cli/babel.js",
-      "types": "./dist/cli/babel.d.ts"
+      "import": "./dist/babel.esm.js",
+      "require": "./dist/babel.cjs.js",
+      "types": "./dist/babel.cjs.d.ts"
     },
     "./universal": {
-      "import": "./dist/esm/universal/index.js",
-      "require": "./dist/universal/index.js",
-      "types": "./dist/universal/index.d.ts"
+      "import": "./dist/universal.esm.js",
+      "require": "./dist/universal.cjs.js",
+      "types": "./dist/universal.cjs.d.ts"
     },
     "./shared": {
-      "import": "./dist/esm/shared/index.js",
-      "require": "./dist/shared/index.js",
-      "types": "./dist/shared/index.d.ts"
+      "import": "./dist/shared.esm.js",
+      "require": "./dist/shared.cjs.js",
+      "types": "./dist/shared/.cjs.d.ts"
     }
   },
   "typesVersions": {
     "*": {
       ".": [
-        "./dist/index.d.ts"
+        "./dist/index.cjs.d.ts"
       ],
       "react": [
-        "./dist/react/index.d.ts"
+        "./dist/react.cjs.d.ts"
       ],
       "cli": [
-        "./dist/cli/index.d.ts"
+        "./dist/cli.cjs.d.ts"
       ],
       "universal": [
-        "./dist/universal/index.d.ts"
+        "./dist/universal.cjs.d.ts"
       ],
       "shared": [
-        "./dist/shared/index.d.ts"
+        "./dist/shared.cjs.d.ts"
+      ],
+      "babel-plugin": [
+        "./dist/babel.cjs.d.ts"
       ]
     }
   },
-  "main": "dist/index.js",
-  "module": "dist/esm/index.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.esm.js",
   "peerDependencies": {
     "react": ">=16.9.0",
     "react-dom": ">=16.9.0"
@@ -85,8 +88,8 @@
   },
   "dependencies": {
     "fs-extra": "9.1.0",
-    "@module-federation/sdk": "0.0.0-next-20240924022552",
-    "@module-federation/runtime": "0.0.0-next-20240924022552"
+    "@module-federation/sdk": "0.0.0-next-20240927010732",
+    "@module-federation/runtime": "0.0.0-next-20240927010732"
   },
   "scripts": {
     "dev": "cross-env WATCH=true tsup",

package/project.json

@@ -1,19 +1,61 @@
 {
-  "name": "module-federation/data-prefetch",
+  "name": "data-prefetch",
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
   "sourceRoot": "packages/data-prefetch/src",
   "projectType": "library",
   "targets": {
     "build": {
-      "executor": "nx:run-commands",
+      "executor": "@nx/rollup:rollup",
+      "outputs": ["{options.outputPath}"],
       "options": {
-        "commands": ["npm run build --prefix packages/data-prefetch"]
+        "outputPath": "packages/data-prefetch/dist",
+        "main": "packages/data-prefetch/src/index.ts",
+        "tsConfig": "packages/data-prefetch/tsconfig.lib.json",
+        "assets": [],
+        "project": "packages/data-prefetch/package.json",
+        "rollupConfig": "packages/data-prefetch/rollup.config.js",
+        "compiler": "swc",
+        "format": ["cjs", "esm"]
       }
     },
     "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "packages/data-prefetch/jest.config.js",
+        "passWithNoTests": true
+      },
+      "configurations": {
+        "ci": {
+          "ci": true,
+          "codeCoverage": true
+        }
+      }
+    },
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": [
+          "packages/data-prefetch/**/*.ts",
+          "packages/data-prefetch/package.json"
+        ]
+      }
+    },
+    "pre-release": {
       "executor": "nx:run-commands",
       "options": {
-        "commands": ["npm run test --prefix packages/data-prefetch"]
+        "parallel": false,
+        "commands": [
+          {
+            "command": "nx run data-prefetch:test",
+            "forwardAllArgs": false
+          },
+          {
+            "command": "nx run data-prefetch:build",
+            "forwardAllArgs": false
+          }
+        ]
       }
     }
   },

package/rollup.config.js

@@ -0,0 +1,25 @@
+const copy = require('rollup-plugin-copy');
+
+module.exports = (rollupConfig, _projectOptions) => {
+  rollupConfig.plugins.push(
+    copy({
+      targets: [
+        {
+          src: 'packages/data-prefetch/LICENSE',
+          dest: 'packages/data-prefetch/dist',
+        },
+      ],
+    }),
+  );
+  rollupConfig.input = {
+    index: 'packages/data-prefetch/src/index.ts',
+    react: 'packages/data-prefetch/src/react/index.ts',
+    cli: 'packages/data-prefetch/src/cli/index.ts',
+    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',
+  };
+  rollupConfig.external = [/@module-federation/];
+  return rollupConfig;
+};

package/src/cli/index.ts

@@ -47,8 +47,8 @@ export class PrefetchPlugin implements WebpackPluginInstance {
       this.options.runtimePlugins = [];
     }
 
-    const runtimePath = path.resolve(__dirname, '../esm/plugin.js');
-    const sharedPath = path.resolve(__dirname, '../esm/shared/index.js');
+    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);
     }

package/src/prefetch.ts

@@ -94,8 +94,12 @@ export class MFDataPrefetch {
       return this._exports;
     }
     const { name } = this._options;
+    const exportsPromiseFn =
+      globalThis.__FEDERATION__.__PREFETCH__.__PREFETCH_EXPORTS__?.[name];
     const exportsPromise =
-      globalThis.__FEDERATION__.__PREFETCH__.__PREFETCH_EXPORTS__?.[name]?.();
+      typeof exportsPromiseFn === 'function'
+        ? exportsPromiseFn()
+        : Promise.resolve({});
     const resolve = exportsPromise.then(
       (exports: Record<string, Record<string, any>> = {}) => {
         // Match prefetch based on the function name suffix so that other capabilities can be expanded later.

package/tsconfig.json

@@ -22,6 +22,6 @@
       "@src/*": ["./src/*"]
     }
   },
-  "include": ["src", "../../global.d.ts", "__tests__/**/*", "tsup.config.ts"],
+  "include": ["src", "../../global.d.ts", "__tests__/**/*"],
   "exclude": ["node_modules/**/*", "../node_modules"]
 }

package/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}

package/dist/cli/babel.js

@@ -1,84 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/cli/babel.ts
-var babel_exports = {};
-__export(babel_exports, {
-  default: () => babel_default
-});
-module.exports = __toCommonJS(babel_exports);
-var import_path = __toESM(require("path"));
-var attribute = "id";
-var hookId = "usePrefetch";
-var importPackage = "@module-federation/data-prefetch/react";
-var babel_default = (babel, options) => {
-  const t = babel.types;
-  let shouldHandle = false;
-  let scope = "";
-  const { name, exposes } = options;
-  if (!exposes) {
-    return {};
-  }
-  const exposesKey = Object.keys(exposes);
-  const processedExposes = exposesKey.map((expose) => ({
-    key: expose.replace(".", ""),
-    value: import_path.default.resolve(
-      typeof exposes[expose] === "string" ? exposes[expose] : exposes[expose].import
-    )
-  }));
-  return {
-    visitor: {
-      ImportDeclaration(nodePath, state) {
-        const source = nodePath.node.source.value;
-        const { specifiers } = nodePath.node;
-        const { filename } = state.file.opts;
-        if (source === importPackage) {
-          shouldHandle = specifiers.some(
-            (specifier) => specifier.imported && specifier.imported.name === hookId && processedExposes.find(
-              (expose) => expose.value === filename && (scope = expose.key)
-            )
-          );
-        }
-      },
-      CallExpression(nodePath) {
-        if (shouldHandle && t.isIdentifier(nodePath.node.callee, { name: hookId }) && nodePath.node.arguments.length > 0) {
-          const objectExpression = nodePath.node.arguments[0];
-          if (objectExpression && t.isObjectExpression(objectExpression) && !objectExpression.properties.find(
-            (p) => p.key.name === attribute
-          )) {
-            objectExpression.properties.push(
-              t.objectProperty(
-                t.identifier(attribute),
-                t.stringLiteral(name + scope)
-              )
-            );
-          }
-        }
-      }
-    }
-  };
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {});

package/dist/cli/index.js

@@ -1,207 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/cli/index.ts
-var cli_exports = {};
-__export(cli_exports, {
-  PrefetchPlugin: () => PrefetchPlugin,
-  getFederationGlobalScope: () => getFederationGlobalScope
-});
-module.exports = __toCommonJS(cli_exports);
-var import_path2 = __toESM(require("path"));
-var import_fs_extra2 = __toESM(require("fs-extra"));
-var import_sdk2 = require("@module-federation/sdk");
-var import_normalize_webpack_path = require("@module-federation/sdk/normalize-webpack-path");
-
-// src/common/constant.ts
-var TEMP_DIR = ".mf";
-
-// src/common/node-utils.ts
-var import_path = __toESM(require("path"));
-var import_fs_extra = __toESM(require("fs-extra"));
-var fileExistsWithCaseSync = (filepath) => {
-  const dir = import_path.default.dirname(filepath);
-  if (filepath === "/" || filepath === ".") {
-    return true;
-  }
-  const filenames = import_fs_extra.default.readdirSync(dir);
-  if (filenames.indexOf(import_path.default.basename(filepath)) === -1) {
-    return false;
-  }
-  return fileExistsWithCaseSync(dir);
-};
-var fixPrefetchPath = (exposePath) => {
-  const pathExt = [".js", ".ts"];
-  const extReg = /\.(ts|js|tsx|jsx)$/;
-  if (extReg.test(exposePath)) {
-    return pathExt.map((ext) => exposePath.replace(extReg, `.prefetch${ext}`));
-  } else {
-    return pathExt.map((ext) => exposePath + `.prefetch${ext}`);
-  }
-};
-
-// src/common/runtime-utils.ts
-var import_runtime = require("@module-federation/runtime");
-var import_sdk = require("@module-federation/sdk");
-var getPrefetchId = (id) => (0, import_sdk.encodeName)(`${id}/${import_sdk.MFPrefetchCommon.identifier}`);
-
-// src/cli/index.ts
-var { RuntimeGlobals, Template } = require((0, import_normalize_webpack_path.normalizeWebpackPath)("webpack"));
-function getFederationGlobalScope(runtimeGlobals) {
-  return `${runtimeGlobals.require || "__webpack_require__"}.federation`;
-}
-var PrefetchPlugin = class {
-  constructor(options) {
-    this.options = options;
-    this._reWriteExports = "";
-  }
-  apply(compiler) {
-    var _a, _b;
-    const { name, exposes } = this.options;
-    if (!exposes) {
-      return;
-    }
-    if (!compiler.options.context) {
-      throw new Error("compiler.options.context is not defined");
-    }
-    const { runtimePlugins } = this.options;
-    if (!Array.isArray(runtimePlugins)) {
-      this.options.runtimePlugins = [];
-    }
-    const runtimePath = import_path2.default.resolve(__dirname, "../esm/plugin.js");
-    const sharedPath = import_path2.default.resolve(__dirname, "../esm/shared/index.js");
-    if (!((_a = this.options.runtimePlugins) == null ? void 0 : _a.includes(runtimePath))) {
-      this.options.runtimePlugins.push(runtimePath);
-    }
-    if (!((_b = this.options.runtimePlugins) == null ? void 0 : _b.includes(sharedPath))) {
-      this.options.runtimePlugins.push(sharedPath);
-    }
-    const encodedName = (0, import_sdk2.encodeName)(name);
-    const asyncEntryPath = import_path2.default.resolve(
-      compiler.options.context,
-      `node_modules/${TEMP_DIR}/${encodedName}/bootstrap.js`
-    );
-    if (import_fs_extra2.default.existsSync(asyncEntryPath)) {
-      import_fs_extra2.default.unlinkSync(asyncEntryPath);
-    }
-    if (!this.options.dataPrefetch) {
-      return;
-    }
-    const prefetchs = [];
-    const exposeAlias = Object.keys(exposes);
-    exposeAlias.forEach((alias) => {
-      let exposePath;
-      const exposeValue = exposes[alias];
-      if (typeof exposeValue === "string") {
-        exposePath = exposeValue;
-      } else {
-        exposePath = exposeValue.import[0];
-      }
-      const targetPaths = fixPrefetchPath(exposePath);
-      for (const pathItem of targetPaths) {
-        const absolutePath = import_path2.default.resolve(compiler.options.context, pathItem);
-        if (fileExistsWithCaseSync(absolutePath)) {
-          prefetchs.push(pathItem);
-          const absoluteAlias = alias.replace(".", "");
-          this._reWriteExports += `export * as ${getPrefetchId(
-            `${name}${absoluteAlias}`
-          )} from '${absolutePath}';
-`;
-          break;
-        }
-      }
-    });
-    if (!this._reWriteExports) {
-      return;
-    }
-    const tempDirRealPath = import_path2.default.resolve(
-      compiler.options.context,
-      "node_modules",
-      TEMP_DIR
-    );
-    if (!import_fs_extra2.default.existsSync(tempDirRealPath)) {
-      import_fs_extra2.default.mkdirSync(tempDirRealPath);
-    }
-    if (!import_fs_extra2.default.existsSync(`${tempDirRealPath}/${encodedName}`)) {
-      import_fs_extra2.default.mkdirSync(`${tempDirRealPath}/${encodedName}`);
-    }
-    import_fs_extra2.default.writeFileSync(asyncEntryPath, this._reWriteExports);
-    new compiler.webpack.DefinePlugin({
-      FederationDataPrefetch: JSON.stringify(asyncEntryPath)
-    }).apply(compiler);
-  }
-  static addRuntime(compiler, options) {
-    const encodedName = (0, import_sdk2.encodeName)(options.name);
-    if (!compiler.options.context) {
-      throw new Error("compiler.options.context is not defined");
-    }
-    const prefetchEntry = import_path2.default.resolve(
-      compiler.options.context,
-      `node_modules/.mf/${encodedName}/bootstrap.js`
-    );
-    const federationGlobal = getFederationGlobalScope(
-      RuntimeGlobals || {}
-    );
-    return Template.asString([
-      import_fs_extra2.default.existsSync(prefetchEntry) ? Template.indent([
-        "function injectPrefetch() {",
-        Template.indent([
-          `globalThis.__FEDERATION__ = globalThis.__FEDERATION__ || {};`,
-          `globalThis.__FEDERATION__['${import_sdk2.MFPrefetchCommon.globalKey}'] = globalThis.__FEDERATION__['${import_sdk2.MFPrefetchCommon.globalKey}'] || {`,
-          `entryLoading: {},`,
-          `instance: new Map(),`,
-          `__PREFETCH_EXPORTS__: {},`,
-          `};`,
-          `globalThis.__FEDERATION__['${import_sdk2.MFPrefetchCommon.globalKey}']['${import_sdk2.MFPrefetchCommon.exportsKey}'] = globalThis.__FEDERATION__['${import_sdk2.MFPrefetchCommon.globalKey}']['${import_sdk2.MFPrefetchCommon.exportsKey}'] || {};`,
-          `globalThis.__FEDERATION__['${import_sdk2.MFPrefetchCommon.globalKey}']['${import_sdk2.MFPrefetchCommon.exportsKey}']['${options.name}'] = function(){ return import('${prefetchEntry}');}`
-        ]),
-        "}",
-        `${federationGlobal}.prefetch = injectPrefetch`
-      ]) : "",
-      Template.indent([
-        `if(!${federationGlobal}.isMFRemote && ${federationGlobal}.prefetch){`,
-        `${federationGlobal}.prefetch()`,
-        "}"
-      ])
-    ]);
-  }
-  static setRemoteIdentifier() {
-    const federationGlobal = getFederationGlobalScope(
-      RuntimeGlobals || {}
-    );
-    return Template.indent([`${federationGlobal}.isMFRemote = true;`]);
-  }
-  static removeRemoteIdentifier() {
-    const federationGlobal = getFederationGlobalScope(
-      RuntimeGlobals || {}
-    );
-    return Template.indent([`${federationGlobal}.isMFRemote = false;`]);
-  }
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  PrefetchPlugin,
-  getFederationGlobalScope
-});

package/dist/esm/chunk-AJPO2B2T.js

@@ -1,30 +0,0 @@
-// src/common/runtime-utils.ts
-import { getInstance } from "@module-federation/runtime";
-import {
-  encodeName,
-  MFPrefetchCommon
-} from "@module-federation/sdk";
-var getScope = () => {
-  return getInstance().options.name;
-};
-var getPrefetchId = (id) => encodeName(`${id}/${MFPrefetchCommon.identifier}`);
-var compatGetPrefetchId = (id) => encodeName(`${id}/VmokPrefetch`);
-var getSignalFromManifest = (remoteSnapshot) => {
-  if (!remoteSnapshot) {
-    return false;
-  }
-  if (!("prefetchEntry" in remoteSnapshot) && !("prefetchInterface" in remoteSnapshot)) {
-    return false;
-  }
-  if (!remoteSnapshot.prefetchEntry && !remoteSnapshot.prefetchInterface) {
-    return false;
-  }
-  return true;
-};
-
-export {
-  getScope,
-  getPrefetchId,
-  compatGetPrefetchId,
-  getSignalFromManifest
-};