@module-federation/data-prefetch 0.0.0-next-20241230094715 → 0.0.0-next-20250103032148

package/dist/src/prefetch.d.ts

@@ -1,14 +1,13 @@
 import { FederationHost } from '@module-federation/runtime';
 import { ModuleInfo } from '@module-federation/sdk';
 import { Remote } from '@module-federation/runtime/types';
-declare module '@module-federation/runtime' {
-    interface Federation {
-        __PREFETCH__: {
-            entryLoading: Record<string, undefined | Promise<void>>;
-            instance: Map<string, MFDataPrefetch>;
-            __PREFETCH_EXPORTS__: Record<string, () => Promise<Record<string, any>>>;
-        };
-    }
+import type { Federation } from '@module-federation/runtime';
+interface FederationWithPrefetch extends Federation {
+    __PREFETCH__: {
+        entryLoading: Record<string, undefined | Promise<void>>;
+        instance: Map<string, MFDataPrefetch>;
+        __PREFETCH_EXPORTS__: Record<string, () => Promise<Record<string, any>>>;
+    };
 }
 type PrefetchExports = Record<string, any>;
 export interface DataPrefetchOptions {
@@ -29,7 +28,7 @@ export declare class MFDataPrefetch {
     private _exports;
     private _options;
     constructor(options: DataPrefetchOptions);
-    get global(): Record<string, any>;
+    get global(): FederationWithPrefetch['__PREFETCH__'];
     static getInstance(id: string): MFDataPrefetch | undefined;
     loadEntry(entry: string | undefined): Promise<any>;
     getProjectExports(): Promise<void> | Record<string, any>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@module-federation/data-prefetch",
   "description": "Module Federation Data Prefetch",
-  "version": "0.0.0-next-20241230094715",
+  "version": "0.0.0-next-20250103032148",
   "author": "nieyan <nyqykk@foxmail.com>",
   "homepage": "https://github.com/module-federation/core",
   "license": "MIT",
@@ -13,31 +13,36 @@
   "publishConfig": {
     "access": "public"
   },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "exports": {
     ".": {
+      "types": "./dist/index.cjs.d.ts",
       "import": "./dist/index.esm.mjs",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.cjs.d.ts"
+      "require": "./dist/index.cjs.js"
     },
     "./react": {
+      "types": "./dist/react.cjs.d.ts",
       "import": "./dist/react.esm.mjs",
-      "require": "./dist/react.cjs.js",
-      "types": "./dist/react.cjs.d.ts"
+      "require": "./dist/react.cjs.js"
     },
     "./cli": {
+      "types": "./dist/cli.cjs.d.ts",
       "import": "./dist/cli.esm.mjs",
-      "require": "./dist/cli.cjs.js",
-      "types": "./dist/cli.cjs.d.ts"
+      "require": "./dist/cli.cjs.js"
     },
     "./babel-plugin": {
+      "types": "./dist/babel.cjs.d.ts",
       "import": "./dist/babel.esm.mjs",
-      "require": "./dist/babel.cjs.js",
-      "types": "./dist/babel.cjs.d.ts"
+      "require": "./dist/babel.cjs.js"
     },
     "./universal": {
+      "types": "./dist/universal.cjs.d.ts",
       "import": "./dist/universal.esm.mjs",
-      "require": "./dist/universal.cjs.js",
-      "types": "./dist/universal.cjs.d.ts"
+      "require": "./dist/universal.cjs.js"
     }
   },
   "typesVersions": {
@@ -59,7 +64,7 @@
       ]
     }
   },
-  "main": "dist/index.cjs",
+  "main": "dist/index.cjs.js",
   "module": "dist/index.esm.mjs",
   "peerDependencies": {
     "react": ">=16.9.0",
@@ -83,8 +88,8 @@
   },
   "dependencies": {
     "fs-extra": "9.1.0",
-    "@module-federation/runtime": "0.0.0-next-20241230094715",
-    "@module-federation/sdk": "0.0.0-next-20241230094715"
+    "@module-federation/runtime": "0.0.0-next-20250103032148",
+    "@module-federation/sdk": "0.0.0-next-20250103032148"
   },
   "scripts": {
     "test": "jest"

package/.swcrc

@@ -1,29 +0,0 @@
-{
-  "jsc": {
-    "target": "es2017",
-    "parser": {
-      "syntax": "typescript",
-      "decorators": true,
-      "dynamicImport": true
-    },
-    "transform": {
-      "decoratorMetadata": true,
-      "legacyDecorator": true
-    },
-    "keepClassNames": true,
-    "externalHelpers": true,
-    "loose": true
-  },
-  "module": {
-    "type": "es6"
-  },
-  "sourceMaps": true,
-  "exclude": [
-    "jest.config.ts",
-    ".*\\.spec.tsx?$",
-    ".*\\.test.tsx?$",
-    "./src/jest-setup.ts$",
-    "./**/jest-setup.ts$",
-    ".*.js$"
-  ]
-}

package/CHANGELOG.md

@@ -1,238 +0,0 @@
-# @module-federation/data-prefetch
-
-## 0.0.0-next-20241230094715
-
-### Patch Changes
-
-- Updated dependencies [835b09c]
-- Updated dependencies [336f3d8]
-- Updated dependencies [4fd33fb]
-  - @module-federation/sdk@0.0.0-next-20241230094715
-  - @module-federation/runtime@0.0.0-next-20241230094715
-
-## 0.8.6
-
-### Patch Changes
-
-- @module-federation/runtime@0.8.6
-- @module-federation/sdk@0.8.6
-
-## 0.8.5
-
-### Patch Changes
-
-- @module-federation/runtime@0.8.5
-- @module-federation/sdk@0.8.5
-
-## 0.8.4
-
-### Patch Changes
-
-- @module-federation/runtime@0.8.4
-- @module-federation/sdk@0.8.4
-
-## 0.8.3
-
-### Patch Changes
-
-- 5b637c3: fix(data-prefetch): the prefetch exports type is promise or function
-- Updated dependencies [f817674]
-- Updated dependencies [8e172c8]
-  - @module-federation/runtime@0.8.3
-  - @module-federation/sdk@0.8.3
-
-## 0.8.2
-
-### Patch Changes
-
-- Updated dependencies [fa7a0bd]
-  - @module-federation/runtime@0.8.2
-  - @module-federation/sdk@0.8.2
-
-## 0.8.1
-
-### Patch Changes
-
-- @module-federation/runtime@0.8.1
-- @module-federation/sdk@0.8.1
-
-## 0.8.0
-
-### Patch Changes
-
-- @module-federation/runtime@0.8.0
-- @module-federation/sdk@0.8.0
-
-## 0.7.7
-
-### Patch Changes
-
-- Updated dependencies [a960c88]
-- Updated dependencies [e26d107]
-  - @module-federation/runtime@0.7.7
-  - @module-federation/sdk@0.7.7
-
-## 0.7.6
-
-### Patch Changes
-
-- @module-federation/runtime@0.7.6
-- @module-federation/sdk@0.7.6
-
-## 0.7.5
-
-### Patch Changes
-
-- @module-federation/runtime@0.7.5
-- @module-federation/sdk@0.7.5
-
-## 0.7.4
-
-### Patch Changes
-
-- Updated dependencies [ff8ce29]
-  - @module-federation/runtime@0.7.4
-  - @module-federation/sdk@0.7.4
-
-## 0.7.3
-
-### Patch Changes
-
-- 4ab9295: disable package json generation during build
-- Updated dependencies [4ab9295]
-- Updated dependencies [c2b1efa]
-  - @module-federation/runtime@0.7.3
-  - @module-federation/sdk@0.7.3
-
-## 0.7.2
-
-### Patch Changes
-
-- @module-federation/runtime@0.7.2
-- @module-federation/sdk@0.7.2
-
-## 0.7.1
-
-### Patch Changes
-
-- Updated dependencies [66ba7b1]
-- Updated dependencies [8712967]
-- Updated dependencies [6db4c5f]
-  - @module-federation/runtime@0.7.1
-  - @module-federation/sdk@0.7.1
-
-## 0.7.0
-
-### Minor Changes
-
-- 206b56d: disable hoistTransitiveImports for better tree shake
-- Updated dependencies [752537b]
-- Updated dependencies [54bfd1c]
-- Updated dependencies [879ad87]
-- Updated dependencies [4eb09e7]
-- Updated dependencies [206b56d]
-  - @module-federation/runtime@0.7.0
-  - @module-federation/sdk@0.7.0
-
-## 0.6.16
-
-### Patch Changes
-
-- 024df60: disable hoistTransitiveImports for better tree shake
-- Updated dependencies [f779188]
-- Updated dependencies [024df60]
-  - @module-federation/sdk@0.6.16
-  - @module-federation/runtime@0.6.16
-
-## 0.6.15
-
-### Patch Changes
-
-- Updated dependencies [ec31539]
-  - @module-federation/runtime@0.6.15
-  - @module-federation/sdk@0.6.15
-
-## 0.6.14
-
-### Patch Changes
-
-- ad605d2: chore: unified logger
-- Updated dependencies [ad605d2]
-  - @module-federation/runtime@0.6.14
-  - @module-federation/sdk@0.6.14
-
-## 0.6.13
-
-### Patch Changes
-
-- @module-federation/runtime@0.6.13
-- @module-federation/sdk@0.6.13
-
-## 0.6.12
-
-### Patch Changes
-
-- @module-federation/runtime@0.6.12
-- @module-federation/sdk@0.6.12
-
-## 0.6.11
-
-### Patch Changes
-
-- Updated dependencies [ea6d417]
-- Updated dependencies [d5a3072]
-  - @module-federation/runtime@0.6.11
-  - @module-federation/sdk@0.6.11
-
-## 0.6.10
-
-### Patch Changes
-
-- 22a3b83: fix(data-prefetch): apply DataPrefetchPlugin on demand
-- 22a3b83: fix(data-prefetch): set sharedStrategy in build options instead of using runtime plugin
-- Updated dependencies [b704f30]
-- Updated dependencies [22a3b83]
-  - @module-federation/runtime@0.6.10
-  - @module-federation/sdk@0.6.10
-
-## 0.6.9
-
-### Patch Changes
-
-- @module-federation/runtime@0.6.9
-- @module-federation/sdk@0.6.9
-
-## 0.6.8
-
-### Patch Changes
-
-- Updated dependencies [32db0ac]
-- Updated dependencies [32db0ac]
-- Updated dependencies [6c5f444]
-- Updated dependencies [fac6ecf]
-  - @module-federation/sdk@0.6.8
-  - @module-federation/runtime@0.6.8
-
-## 0.6.7
-
-### Patch Changes
-
-- 9e32644: Refactored the way prefetch entries are imported for improved dynamic loading handling.
-
-  - Changed the import of prefetch entries to use a function wrapper for more dynamic control.
-  - Updated data types to ensure consistency with the new function-based import approach.
-  - Modified the `injectPrefetch` function structure to incorporate the new import method.
-  - Modified the `MFDataPrefetch` class to handle the new import function when resolving exports.
-
-- Updated dependencies [9e32644]
-- Updated dependencies [9e32644]
-- Updated dependencies [9e32644]
-  - @module-federation/runtime@0.6.7
-  - @module-federation/sdk@0.6.7
-
-## 0.6.6
-
-### Patch Changes
-
-- @module-federation/runtime@0.6.6
-- @module-federation/sdk@0.6.6

package/__tests__/babel.spec.ts

@@ -1,75 +0,0 @@
-/// <reference types="jest" />
-
-import path from 'path';
-import fs from 'fs';
-import { BabelFileResult, transformFileSync } from '@babel/core';
-// @ts-ignore no use
-import type from '@types/jest';
-
-import babelPlugin from '../src/cli/babel';
-
-const emptyRegexp = /\s+/g;
-describe('Babel Plugin Test', () => {
-  const options = {
-    name: '@mf/test',
-    exposes: { './expose': path.resolve(__dirname, 'test') },
-  };
-
-  const testFilePath = path.join(__dirname, './test');
-
-  beforeEach(() => {
-    fs.mkdirSync(path.dirname(testFilePath), { recursive: true });
-    fs.closeSync(fs.openSync(testFilePath, 'w'));
-  });
-
-  afterEach(() => {
-    fs.unlinkSync(testFilePath);
-  });
-
-  // Check if the plugin will add the id parameter when it is not present
-  test('it adds id argument to usePrefetch call when it is absent', () => {
-    const input = `
-      import { usePrefetch } from "@module-federation/data-prefetch/react";
-      usePrefetch({});
-    `;
-
-    const expected = `
-      import { usePrefetch } from "@module-federation/data-prefetch/react";
-      usePrefetch({ id: "@mf/test/expose" });
-    `;
-
-    fs.writeFileSync(testFilePath, input);
-    const { code } = transformFileSync(testFilePath, {
-      plugins: [[babelPlugin, options]],
-      configFile: false,
-    }) as BabelFileResult;
-
-    expect(code?.replace(emptyRegexp, '')).toBe(
-      expected.replace(emptyRegexp, ''),
-    );
-  });
-
-  // The plugin should retain the existing id parameter in the usePrefetch call
-  test('it does not overwrite existing id argument in usePrefetch call', () => {
-    const input = `
-      import { usePrefetch } from "@module-federation/data-prefetch/react";
-      usePrefetch({ id: "existingId" });
-    `;
-
-    const expected = `
-      import { usePrefetch } from "@module-federation/data-prefetch/react";
-      usePrefetch({ id: "existingId" });
-    `;
-
-    fs.writeFileSync(testFilePath, input);
-    const { code } = transformFileSync(testFilePath, {
-      plugins: [[babelPlugin, options]],
-      configFile: false,
-      babelrc: false,
-    }) as BabelFileResult;
-
-    expect(code?.replace(emptyRegexp, '')).toBe(
-      expected.replace(emptyRegexp, ''),
-    );
-  });
-});

package/__tests__/prefetch.spec.ts

@@ -1,139 +0,0 @@
-// Import the necessary modules and functions
-import { MFDataPrefetch } from '../src/prefetch';
-import {
-  loadScript,
-  MFPrefetchCommon,
-  encodeName,
-} from '@module-federation/sdk';
-
-// Mock loadScript function from SDK
-jest.mock('@module-federation/sdk', () => {
-  const originalModule = jest.requireActual('@module-federation/sdk');
-  return {
-    ...originalModule,
-    loadScript: jest.fn(() => Promise.resolve()),
-  };
-});
-
-describe('MF Data Prefetch', () => {
-  let prefetch: MFDataPrefetch;
-
-  const options = {
-    name: '@mf/test',
-    remoteSnapshot: {
-      buildVersion: '1.0.0',
-      globalName: 'TestGlobalName',
-    },
-  };
-  const exposeId = `${options.name}/button/${MFPrefetchCommon.identifier}`;
-
-  beforeEach(() => {
-    globalThis.__FEDERATION__.__PREFETCH__ = {
-      entryLoading: {},
-      instance: new Map(),
-      __PREFETCH_EXPORTS__: {},
-    };
-    // @ts-ignore
-    prefetch = new MFDataPrefetch(options);
-  });
-  afterAll(() => {
-    // @ts-ignore
-    delete globalThis.__FEDERATION__;
-  });
-
-  // Instance gets added to global memory on creation
-  it('adds itself to global instances on creation', () => {
-    expect(prefetch.global.instance.get(options.name)).toBe(prefetch);
-  });
-
-  // Loads entry script using loadScript from sdk
-  it('loads entry script using loadScript from sdk', async () => {
-    const url = 'testUrl'; // Url of the script to be loaded
-
-    await prefetch.loadEntry(url); // Call `loadEntry` function
-
-    // Expect that the loadScript function is called with the correct url
-    expect(loadScript).toHaveBeenCalledWith(url, expect.any(Object));
-  });
-
-  // Retrieves project exports
-  it('gets project exports', async () => {
-    const exposeExport = {
-      nyPrefetch: () => {},
-    };
-    const projectExport = {
-      [encodeName(exposeId)]: exposeExport,
-    };
-    globalThis.__FEDERATION__.__PREFETCH__.__PREFETCH_EXPORTS__[options.name] =
-      () => Promise.resolve(projectExport);
-
-    await prefetch.getProjectExports();
-    expect(prefetch.getExposeExports(`${options.name}/button`)).toEqual(
-      exposeExport,
-    );
-  });
-
-  // Prefetching with memory and executing prefetch function
-  it('executes prefetch using prefetch function with and without memory', async () => {
-    const id = options.name;
-    const functionId = 'nyPrefetch';
-    const refetchParams = 'testParams';
-    const prefetchOptions = { id: `${id}/button`, functionId, refetchParams };
-
-    // Creating a mock prefetch function
-    const executePrefetch = jest.fn(() => 'Expected Result');
-    const prefetchExports = { [functionId]: executePrefetch };
-
-    // Mock Project Exports
-    globalThis.__FEDERATION__.__PREFETCH__.__PREFETCH_EXPORTS__[id] = () =>
-      Promise.resolve({
-        [encodeName(exposeId)]: prefetchExports,
-      });
-
-    await prefetch.getProjectExports();
-    // Call the prefetch function first time
-    let result = await prefetch.prefetch(prefetchOptions);
-
-    // Verify that executePrefetch function is correctly executed
-    expect(executePrefetch).toHaveBeenCalled();
-
-    // Clear mock function calls data
-    executePrefetch.mockClear();
-
-    // Call the prefetch function again
-    result = await prefetch.prefetch(prefetchOptions);
-
-    // Verify that executePrefetch function is NOT called this time (since the result should come from memory)
-    expect(executePrefetch).not.toHaveBeenCalled();
-
-    // Clear mock function calls data
-    executePrefetch.mockClear();
-
-    prefetch.markOutdate(prefetchOptions, true);
-
-    // Call the prefetch function first time
-    result = await prefetch.prefetch(prefetchOptions);
-
-    // Verify that executePrefetch function is correctly executed
-    expect(executePrefetch).toHaveBeenCalled();
-  });
-
-  // Checking outdate marking
-  it('checks outdate marking', () => {
-    const markOptions = { id: 'testId', functionId: 'testFunction' };
-
-    // Mark the function as outdated
-    prefetch.markOutdate(markOptions, true);
-
-    // Verify that the function is marked as outdated
-    let isOutdated = prefetch.checkOutdate(markOptions);
-    expect(isOutdated).toBe(true);
-
-    // Mark the function as up-to-date
-    prefetch.markOutdate(markOptions, false);
-
-    // Verify that the function is marked as up-to-date
-    isOutdated = prefetch.checkOutdate(markOptions);
-    expect(isOutdated).toBe(false);
-  });
-});

package/__tests__/react.spec.ts

@@ -1,119 +0,0 @@
-import { FederationHost, init } from '@module-federation/runtime';
-import { renderHook, act } from '@testing-library/react-hooks';
-import * as ModuleFederationSDK from '@module-federation/sdk';
-import { usePrefetch } from '../src/react';
-import { MFDataPrefetch } from '../src/prefetch';
-
-const mockLoadScript = jest.spyOn(ModuleFederationSDK, 'loadScript');
-mockLoadScript.mockImplementation(() => Promise.resolve());
-
-describe('usePrefetch', () => {
-  // Mock prefetch function
-  global.fetch = jest.fn(() =>
-    Promise.resolve({
-      ok: true,
-      status: 200,
-      statusText: 'OK',
-      redirected: false,
-      type: 'basic',
-      url: '',
-      clone: jest.fn(),
-      headers: new Headers(),
-      body: null,
-      bodyUsed: false,
-      text: () => Promise.resolve(JSON.stringify({ data: 'testData' })),
-      json: () => Promise.resolve({ data: 'testData' }),
-      formData: () => Promise.resolve(new FormData()),
-      arrayBuffer: () => Promise.resolve(new ArrayBuffer(0)),
-      blob: () => Promise.resolve(new Blob()),
-    }),
-  );
-
-  let prefetch: MFDataPrefetch;
-
-  const options = {
-    // Options that will be passed to the `MFDataPrefetch` constructor
-    name: '@mf/test',
-    remoteSnapshot: {
-      buildVersion: '1.0.0',
-      globalName: 'TestGlobalName',
-    },
-  };
-  const testData = 'testData';
-  const newTestData = 'newTestData';
-  const functionId = 'testPrefetch';
-  const executePrefetch = jest.fn((params: string) =>
-    Promise.resolve(params ? params : testData),
-  );
-
-  new FederationHost({
-    name: options.name,
-    remotes: [],
-  });
-  init({
-    name: options.name,
-    remotes: [],
-  });
-  beforeEach(() => {
-    globalThis.__FEDERATION__.__PREFETCH__ = {
-      entryLoading: {},
-      instance: new Map(),
-      __PREFETCH_EXPORTS__: {},
-    };
-    // @ts-ignore
-    prefetch = new MFDataPrefetch(options); // Create a new instance of `MFDataPrefetch` class before each test
-
-    const exposeExport = {
-      [functionId]: executePrefetch,
-    };
-    const exposeId = `${options.name}/button/${ModuleFederationSDK.MFPrefetchCommon.identifier}`;
-    const projectExport = {
-      [ModuleFederationSDK.encodeName(exposeId)]: exposeExport,
-    };
-    globalThis.__FEDERATION__.__PREFETCH__.__PREFETCH_EXPORTS__[options.name] =
-      () => Promise.resolve(projectExport);
-  });
-
-  afterEach(() => {
-    executePrefetch.mockClear();
-    mockLoadScript.mockRestore();
-  });
-
-  afterAll(() => {
-    // @ts-ignore
-    delete globalThis.__FEDERATION__;
-  });
-
-  it('should prefetch data on first mount', async () => {
-    const { result } = renderHook(() =>
-      usePrefetch({ id: `${options.name}/button`, functionId }),
-    );
-    await result.current[0];
-    expect(executePrefetch).toHaveBeenCalled();
-    // Verify the prefechState
-    expect(result.current[0]).resolves.toEqual(testData);
-  });
-
-  it('should refetch data when refreshExecutor is called', async () => {
-    const { result } = renderHook(() =>
-      usePrefetch({ id: `${options.name}/button`, functionId }),
-    );
-
-    await result.current[0];
-    expect(executePrefetch).toHaveBeenCalled();
-    executePrefetch.mockClear();
-    const { result: newCallResult } = renderHook(() =>
-      usePrefetch({ id: `${options.name}/button`, functionId }),
-    );
-    await newCallResult.current[0];
-    expect(executePrefetch).not.toHaveBeenCalled();
-    // Call refreshExecutor
-    act(() => {
-      result.current[1](newTestData);
-    });
-
-    expect(executePrefetch).toHaveBeenCalled();
-    // // Verify the prefetchState after refetch
-    expect(result.current[0]).resolves.toEqual(newTestData);
-  });
-});