@module-federation/data-prefetch 2.0.1 → 2.2.0

package/dist/babel.d.cts

@@ -0,0 +1 @@
+export * from './cli/babel';

package/dist/cli/babel.d.cts

@@ -0,0 +1,37 @@
+import type { moduleFederationPlugin } from '@module-federation/sdk';
+interface BabelPluginOptions {
+    hook_id: string;
+    import_pkg: string;
+    attribute: string;
+    name: string;
+    exposes: moduleFederationPlugin.ModuleFederationPluginOptions['exposes'];
+}
+declare const _default: (babel: {
+    types: any;
+}, options: BabelPluginOptions) => {
+    visitor?: undefined;
+} | {
+    visitor: {
+        ImportDeclaration(nodePath: {
+            node: {
+                source: {
+                    value: any;
+                };
+                specifiers: any;
+            };
+        }, state: {
+            file: {
+                opts: {
+                    filename: any;
+                };
+            };
+        }): void;
+        CallExpression(nodePath: {
+            node: {
+                callee: any;
+                arguments: string | any[];
+            };
+        }): void;
+    };
+};
+export default _default;

package/dist/cli/index.cjs

@@ -84,6 +84,7 @@ const external_constant_cjs_namespaceObject = require("../constant.cjs");
 
 
 
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 const { RuntimeGlobals, Template } = require((0,normalize_webpack_path_namespaceObject.normalizeWebpackPath)('webpack'));
 const createBundlerLogger = typeof sdk_namespaceObject.createInfrastructureLogger === 'function' ? sdk_namespaceObject.createInfrastructureLogger : sdk_namespaceObject.createLogger;
 const logger = createBundlerLogger('[ Module Federation Data Prefetch Plugin ]');
@@ -106,7 +107,11 @@ class PrefetchPlugin {
         if (!Array.isArray(runtimePlugins)) {
             this.options.runtimePlugins = [];
         }
-        const runtimePath = external_path_default().resolve(__dirname, './plugin.esm.js');
+        const runtimePluginFile = process.env.IS_ESM_BUILD === 'true' ? '../plugin.js' : '../plugin.cjs';
+        const runtimePath = external_path_default().resolve(__dirname, runtimePluginFile);
+        if (!external_fs_extra_default().existsSync(runtimePath)) {
+            throw new Error(`[Module Federation Data Prefetch]: Unable to resolve runtime plugin file at ${runtimePath}.`);
+        }
         if (!((_this_options_runtimePlugins = this.options.runtimePlugins) === null || _this_options_runtimePlugins === void 0 ? void 0 : _this_options_runtimePlugins.includes(runtimePath))) {
             this.options.runtimePlugins.push(runtimePath);
         }
@@ -119,6 +124,7 @@ class PrefetchPlugin {
         if (external_fs_extra_default().existsSync(asyncEntryPath)) {
             external_fs_extra_default().unlinkSync(asyncEntryPath);
         }
+        // @ts-ignore
         if (!this.options.dataPrefetch) {
             return;
         }

package/dist/cli/index.d.cts

@@ -0,0 +1,16 @@
+import { moduleFederationPlugin } from '@module-federation/sdk';
+import type { Compiler, WebpackPluginInstance } from 'webpack';
+declare const RuntimeGlobals: typeof import("webpack").RuntimeGlobals;
+export declare function getFederationGlobalScope(runtimeGlobals: typeof RuntimeGlobals): string;
+export declare class PrefetchPlugin implements WebpackPluginInstance {
+    options: moduleFederationPlugin.ModuleFederationPluginOptions;
+    private _reWriteExports;
+    constructor(options: moduleFederationPlugin.ModuleFederationPluginOptions);
+    apply(compiler: Compiler): void;
+    static addRuntime(compiler: Compiler, options: {
+        name: string;
+    }): string;
+    static setRemoteIdentifier(): string;
+    static removeRemoteIdentifier(): string;
+}
+export {};

package/dist/cli/index.js

@@ -32,6 +32,7 @@ import { SHARED_STRATEGY } from "../constant.js";
 
 
 
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 const { RuntimeGlobals, Template } = require(normalizeWebpackPath('webpack'));
 const createBundlerLogger = typeof createInfrastructureLogger === 'function' ? createInfrastructureLogger : createLogger;
 const logger = createBundlerLogger('[ Module Federation Data Prefetch Plugin ]');
@@ -54,7 +55,11 @@ class PrefetchPlugin {
         if (!Array.isArray(runtimePlugins)) {
             this.options.runtimePlugins = [];
         }
-        const runtimePath = path.resolve(__dirname, './plugin.esm.js');
+        const runtimePluginFile = process.env.IS_ESM_BUILD === 'true' ? '../plugin.js' : '../plugin.cjs';
+        const runtimePath = path.resolve(__dirname, runtimePluginFile);
+        if (!fs_extra.existsSync(runtimePath)) {
+            throw new Error(`[Module Federation Data Prefetch]: Unable to resolve runtime plugin file at ${runtimePath}.`);
+        }
         if (!((_this_options_runtimePlugins = this.options.runtimePlugins) === null || _this_options_runtimePlugins === void 0 ? void 0 : _this_options_runtimePlugins.includes(runtimePath))) {
             this.options.runtimePlugins.push(runtimePath);
         }
@@ -67,6 +72,7 @@ class PrefetchPlugin {
         if (fs_extra.existsSync(asyncEntryPath)) {
             fs_extra.unlinkSync(asyncEntryPath);
         }
+        // @ts-ignore
         if (!this.options.dataPrefetch) {
             return;
         }

package/dist/cli.d.cts

@@ -0,0 +1 @@
+export * from './cli/index';

package/dist/common/constant.d.cts

@@ -0,0 +1 @@
+export declare const TEMP_DIR = ".mf";

package/dist/common/index.d.cts

@@ -0,0 +1 @@
+export * from './constant';

package/dist/common/node-utils.d.cts

@@ -0,0 +1,2 @@
+export declare const fileExistsWithCaseSync: (filepath: string) => boolean;
+export declare const fixPrefetchPath: (exposePath: string) => Array<string>;

package/dist/common/runtime-utils.d.cts

@@ -0,0 +1,5 @@
+import { ModuleInfo } from '@module-federation/sdk';
+export declare const getScope: () => string;
+export declare const getPrefetchId: (id: string) => string;
+export declare const compatGetPrefetchId: (id: string) => string;
+export declare const getSignalFromManifest: (remoteSnapshot: ModuleInfo) => boolean;

package/dist/constant.d.cts

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

package/dist/index.d.cts

@@ -0,0 +1,2 @@
+export * from './prefetch';
+export * from './plugin';

package/dist/logger/index.d.cts

@@ -0,0 +1,2 @@
+declare const logger: import("@module-federation/sdk").Logger;
+export default logger;

package/dist/plugin.d.cts

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

package/dist/prefetch.d.cts

@@ -0,0 +1,42 @@
+import { ModuleFederation } from '@module-federation/runtime';
+import { ModuleInfo } from '@module-federation/sdk';
+import { Remote } from '@module-federation/runtime/types';
+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 {
+    name: string;
+    remote?: Remote;
+    origin?: ModuleFederation;
+    remoteSnapshot?: ModuleInfo;
+}
+export interface prefetchOptions {
+    id: string;
+    functionId?: string;
+    cacheStrategy?: () => boolean;
+    refetchParams?: any;
+}
+export declare class MFDataPrefetch {
+    prefetchMemory: Map<string, Promise<any>>;
+    recordOutdate: Record<string, Record<string, boolean>>;
+    private _exports;
+    private _options;
+    constructor(options: DataPrefetchOptions);
+    get global(): FederationWithPrefetch['__PREFETCH__'];
+    static getInstance(id: string): MFDataPrefetch | undefined;
+    loadEntry(entry: string | undefined): Promise<any>;
+    getProjectExports(): Promise<void> | Record<string, any>;
+    memorizeExports(exports: Record<string, any>): void;
+    getExposeExports(id: string): PrefetchExports;
+    prefetch(prefetchOptions: prefetchOptions): any;
+    memorize(id: string, value: any): void;
+    markOutdate(markOptions: Omit<prefetchOptions, 'cacheStrategy'>, isOutdate: boolean): void;
+    checkOutdate(outdateOptions: prefetchOptions): boolean;
+}
+export {};

package/dist/react/hooks.d.cts

@@ -0,0 +1,11 @@
+import { type prefetchOptions } from '../prefetch';
+type refetchParams = any;
+type prefetchReturnType<T> = [
+    Promise<T>,
+    (refetchParams?: refetchParams) => void
+];
+type UsePrefetchOptions = prefetchOptions & {
+    deferId?: string;
+};
+export declare const usePrefetch: <T>(options: UsePrefetchOptions) => prefetchReturnType<T>;
+export {};

package/dist/react/index.d.cts

@@ -0,0 +1 @@
+export * from './hooks';

package/dist/react/utils.d.cts

@@ -0,0 +1 @@
+export declare const useFirstMounted: () => boolean;

package/dist/react.d.cts

@@ -0,0 +1 @@
+export * from './react/index';

package/dist/universal/index.d.cts

@@ -0,0 +1,2 @@
+import { type prefetchOptions } from '../prefetch';
+export declare function prefetch(options: prefetchOptions): Promise<any>;

package/dist/universal.d.cts

@@ -0,0 +1 @@
+export * from './universal/index';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@module-federation/data-prefetch",
   "description": "Module Federation Data Prefetch",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "type": "module",
   "author": "nieyan <nyqykk@foxmail.com>",
   "homepage": "https://github.com/module-federation/core",
@@ -26,7 +26,7 @@
         "default": "./dist/index.js"
       },
       "require": {
-        "types": "./dist/index.d.ts",
+        "types": "./dist/index.d.cts",
         "default": "./dist/index.cjs"
       }
     },
@@ -36,7 +36,7 @@
         "default": "./dist/react.js"
       },
       "require": {
-        "types": "./dist/react.d.ts",
+        "types": "./dist/react.d.cts",
         "default": "./dist/react.cjs"
       }
     },
@@ -46,7 +46,7 @@
         "default": "./dist/cli.js"
       },
       "require": {
-        "types": "./dist/cli.d.ts",
+        "types": "./dist/cli.d.cts",
         "default": "./dist/cli.cjs"
       }
     },
@@ -56,7 +56,7 @@
         "default": "./dist/babel.js"
       },
       "require": {
-        "types": "./dist/babel.d.ts",
+        "types": "./dist/babel.d.cts",
         "default": "./dist/babel.cjs"
       }
     },
@@ -66,7 +66,7 @@
         "default": "./dist/universal.js"
       },
       "require": {
-        "types": "./dist/universal.d.ts",
+        "types": "./dist/universal.d.cts",
         "default": "./dist/universal.cjs"
       }
     }
@@ -123,10 +123,14 @@
   },
   "dependencies": {
     "fs-extra": "9.1.0",
-    "@module-federation/runtime": "2.0.1",
-    "@module-federation/sdk": "2.0.1"
+    "@module-federation/runtime": "2.2.0",
+    "@module-federation/sdk": "2.2.0"
   },
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "build": "rslib build",
+    "test:ci": "pnpm exec jest --config jest.config.cjs --passWithNoTests --ci --coverage",
+    "lint": "ESLINT_USE_FLAT_CONFIG=false pnpm exec eslint --ignore-pattern node_modules \"**/*.ts\" \"package.json\"",
+    "pre-release": "pnpm run test && pnpm run build"
   }
 }