@module-federation/data-prefetch 0.0.0-next-20241010084324 → 0.0.0-next-20241011070539

package/dist/react.cjs.js

@@ -0,0 +1,77 @@
+'use strict';
+
+var polyfills = require('./polyfills.cjs.js');
+var react = require('react');
+var index = require('./index.cjs2.js');
+var prefetch = require('./prefetch.cjs.js');
+var universal = require('./universal.cjs.js');
+var runtimeUtils = require('./runtime-utils.cjs.js');
+require('@module-federation/sdk');
+require('@module-federation/runtime');
+
+const useFirstMounted = ()=>{
+    const ref = react.useRef(true);
+    react.useEffect(()=>{
+        ref.current = false;
+    }, []);
+    return ref.current;
+};
+
+const usePrefetch = (options)=>{
+    const isFirstMounted = useFirstMounted();
+    if (isFirstMounted) {
+        const startTiming = performance.now();
+        index.logger.info(`2. Start Get Prefetch Data: ${options.id} - ${options.functionId || 'default'} - ${startTiming}`);
+    }
+    const { id, functionId, deferId } = options;
+    const prefetchInfo = {
+        id,
+        functionId
+    };
+    const mfScope = runtimeUtils.getScope();
+    let state;
+    const prefetchResult = universal.prefetch(options);
+    if (deferId) {
+        if (prefetchResult instanceof Promise) {
+            state = prefetchResult.then((deferredData)=>deferredData.data[deferId]);
+        } else {
+            state = prefetchResult.data[deferId];
+        }
+    } else {
+        state = prefetchResult;
+    }
+    const [prefetchState, setPrefetchState] = react.useState(state);
+    const prefetchInstance = prefetch.MFDataPrefetch.getInstance(mfScope);
+    react.useEffect(()=>{
+        const useEffectTiming = performance.now();
+        index.logger.info(`3. Start Execute UseEffect: ${options.id} - ${options.functionId || 'default'} - ${useEffectTiming}`);
+        return ()=>{
+            prefetchInstance == null ? void 0 : prefetchInstance.markOutdate(prefetchInfo, true);
+        };
+    }, []);
+    const refreshExecutor = (refetchParams)=>{
+        const refetchOptions = polyfills._extends({}, options);
+        if (refetchParams) {
+            refetchOptions.refetchParams = refetchParams;
+        }
+        prefetchInstance == null ? void 0 : prefetchInstance.markOutdate(prefetchInfo, true);
+        const newVal = universal.prefetch(refetchOptions);
+        let newState;
+        if (deferId) {
+            if (newVal instanceof Promise) {
+                newState = newVal.then((deferredData)=>deferredData.data[deferId]);
+            } else {
+                newState = newVal.data[deferId];
+            }
+        } else {
+            newState = newVal;
+        }
+        setPrefetchState(newState);
+    };
+    return [
+        prefetchState,
+        refreshExecutor
+    ];
+};
+
+exports.usePrefetch = usePrefetch;

package/dist/react.esm.d.ts

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

package/dist/react.esm.js

@@ -0,0 +1,75 @@
+import { _ as _extends } from './polyfills.esm.js';
+import { useRef, useEffect, useState } from 'react';
+import { l as logger } from './index.esm2.js';
+import { M as MFDataPrefetch } from './prefetch.esm.js';
+import { prefetch } from './universal.esm.js';
+import { g as getScope } from './runtime-utils.esm.js';
+import '@module-federation/sdk';
+import '@module-federation/runtime';
+
+const useFirstMounted = ()=>{
+    const ref = useRef(true);
+    useEffect(()=>{
+        ref.current = false;
+    }, []);
+    return ref.current;
+};
+
+const usePrefetch = (options)=>{
+    const isFirstMounted = useFirstMounted();
+    if (isFirstMounted) {
+        const startTiming = performance.now();
+        logger.info(`2. Start Get Prefetch Data: ${options.id} - ${options.functionId || 'default'} - ${startTiming}`);
+    }
+    const { id, functionId, deferId } = options;
+    const prefetchInfo = {
+        id,
+        functionId
+    };
+    const mfScope = getScope();
+    let state;
+    const prefetchResult = prefetch(options);
+    if (deferId) {
+        if (prefetchResult instanceof Promise) {
+            state = prefetchResult.then((deferredData)=>deferredData.data[deferId]);
+        } else {
+            state = prefetchResult.data[deferId];
+        }
+    } else {
+        state = prefetchResult;
+    }
+    const [prefetchState, setPrefetchState] = useState(state);
+    const prefetchInstance = MFDataPrefetch.getInstance(mfScope);
+    useEffect(()=>{
+        const useEffectTiming = performance.now();
+        logger.info(`3. Start Execute UseEffect: ${options.id} - ${options.functionId || 'default'} - ${useEffectTiming}`);
+        return ()=>{
+            prefetchInstance == null ? void 0 : prefetchInstance.markOutdate(prefetchInfo, true);
+        };
+    }, []);
+    const refreshExecutor = (refetchParams)=>{
+        const refetchOptions = _extends({}, options);
+        if (refetchParams) {
+            refetchOptions.refetchParams = refetchParams;
+        }
+        prefetchInstance == null ? void 0 : prefetchInstance.markOutdate(prefetchInfo, true);
+        const newVal = prefetch(refetchOptions);
+        let newState;
+        if (deferId) {
+            if (newVal instanceof Promise) {
+                newState = newVal.then((deferredData)=>deferredData.data[deferId]);
+            } else {
+                newState = newVal.data[deferId];
+            }
+        } else {
+            newState = newVal;
+        }
+        setPrefetchState(newState);
+    };
+    return [
+        prefetchState,
+        refreshExecutor
+    ];
+};
+
+export { usePrefetch };

package/dist/runtime-utils.cjs.js

@@ -0,0 +1,27 @@
+'use strict';
+
+var runtime = require('@module-federation/runtime');
+var sdk = require('@module-federation/sdk');
+
+const getScope = ()=>{
+    return runtime.getInstance().options.name;
+};
+const getPrefetchId = (id)=>sdk.encodeName(`${id}/${sdk.MFPrefetchCommon.identifier}`);
+const compatGetPrefetchId = (id)=>sdk.encodeName(`${id}/VmokPrefetch`);
+const getSignalFromManifest = (remoteSnapshot)=>{
+    if (!remoteSnapshot) {
+        return false;
+    }
+    if (!('prefetchEntry' in remoteSnapshot) && !('prefetchInterface' in remoteSnapshot)) {
+        return false;
+    }
+    if (!remoteSnapshot.prefetchEntry && !remoteSnapshot.prefetchInterface) {
+        return false;
+    }
+    return true;
+};
+
+exports.compatGetPrefetchId = compatGetPrefetchId;
+exports.getPrefetchId = getPrefetchId;
+exports.getScope = getScope;
+exports.getSignalFromManifest = getSignalFromManifest;

package/dist/runtime-utils.esm.js

@@ -0,0 +1,22 @@
+import { getInstance } from '@module-federation/runtime';
+import { encodeName, MFPrefetchCommon } from '@module-federation/sdk';
+
+const getScope = ()=>{
+    return getInstance().options.name;
+};
+const getPrefetchId = (id)=>encodeName(`${id}/${MFPrefetchCommon.identifier}`);
+const compatGetPrefetchId = (id)=>encodeName(`${id}/VmokPrefetch`);
+const 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 { getSignalFromManifest as a, getPrefetchId as b, compatGetPrefetchId as c, getScope as g };

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/{cli → src/cli}/babel.d.ts

@@ -1,5 +1,4 @@
-import { moduleFederationPlugin } from '@module-federation/sdk';
-
+import type { moduleFederationPlugin } from '@module-federation/sdk';
 interface BabelPluginOptions {
     hook_id: string;
     import_pkg: string;
@@ -35,5 +34,4 @@ declare const _default: (babel: {
         }): void;
     };
 };
-
-export { _default as default };
+export default _default;

package/dist/{cli → src/cli}/index.d.ts

@@ -1,10 +1,8 @@
-import * as webpack from 'webpack';
-import { WebpackPluginInstance, Compiler } from 'webpack';
 import { moduleFederationPlugin } from '@module-federation/sdk';
-
-declare const RuntimeGlobals: typeof webpack.RuntimeGlobals;
-declare function getFederationGlobalScope(runtimeGlobals: typeof RuntimeGlobals): string;
-declare class PrefetchPlugin implements WebpackPluginInstance {
+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);
@@ -15,5 +13,4 @@ declare class PrefetchPlugin implements WebpackPluginInstance {
     static setRemoteIdentifier(): string;
     static removeRemoteIdentifier(): string;
 }
-
-export { PrefetchPlugin, getFederationGlobalScope };
+export {};

package/dist/src/common/constant.d.ts

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

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

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

package/dist/src/common/node-utils.d.ts

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

package/dist/src/common/runtime-utils.d.ts

@@ -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/src/index.d.ts

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

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

@@ -0,0 +1,3 @@
+import { Logger } from '@module-federation/sdk';
+declare const _default: Logger;
+export default _default;

package/dist/src/plugin.d.ts

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

package/dist/{prefetch-c08be471.d.ts → src/prefetch.d.ts}

@@ -1,7 +1,6 @@
 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__: {
@@ -12,19 +11,19 @@ declare module '@module-federation/runtime' {
     }
 }
 type PrefetchExports = Record<string, any>;
-interface DataPrefetchOptions {
+export interface DataPrefetchOptions {
     name: string;
     remote?: Remote;
     origin?: FederationHost;
     remoteSnapshot?: ModuleInfo;
 }
-interface prefetchOptions {
+export interface prefetchOptions {
     id: string;
     functionId?: string;
     cacheStrategy?: () => boolean;
     refetchParams?: any;
 }
-declare class MFDataPrefetch {
+export declare class MFDataPrefetch {
     prefetchMemory: Map<string, Promise<any>>;
     recordOutdate: Record<string, Record<string, boolean>>;
     private _exports;
@@ -41,5 +40,4 @@ declare class MFDataPrefetch {
     markOutdate(markOptions: Omit<prefetchOptions, 'cacheStrategy'>, isOutdate: boolean): void;
     checkOutdate(outdateOptions: prefetchOptions): boolean;
 }
-
-export { DataPrefetchOptions as D, MFDataPrefetch as M, prefetchOptions as p };
+export {};

package/dist/src/react/hooks.d.ts

@@ -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/src/react/index.d.ts

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

package/dist/src/react/utils.d.ts

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

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/dist/src/universal/index.d.ts

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

package/dist/universal.cjs.d.ts

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

package/dist/universal.cjs.js

@@ -0,0 +1,29 @@
+'use strict';
+
+var prefetch$1 = require('./prefetch.cjs.js');
+var runtimeUtils = require('./runtime-utils.cjs.js');
+require('@module-federation/runtime');
+require('@module-federation/sdk');
+
+function prefetch(options) {
+    const { id, functionId = 'default' } = options;
+    const mfScope = runtimeUtils.getScope();
+    const prefetchInstance = prefetch$1.MFDataPrefetch.getInstance(mfScope) || new prefetch$1.MFDataPrefetch({
+        name: mfScope
+    });
+    const res = prefetchInstance.getProjectExports();
+    if (res instanceof Promise) {
+        const promise = res.then(()=>{
+            const result = prefetchInstance.prefetch(options);
+            prefetchInstance.memorize(id + functionId, result);
+            return result;
+        });
+        return promise;
+    } else {
+        const result = prefetchInstance.prefetch(options);
+        prefetchInstance.memorize(id + functionId, result);
+        return result;
+    }
+}
+
+exports.prefetch = prefetch;

package/dist/universal.esm.d.ts

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

package/dist/universal.esm.js

@@ -0,0 +1,27 @@
+import { M as MFDataPrefetch } from './prefetch.esm.js';
+import { g as getScope } from './runtime-utils.esm.js';
+import '@module-federation/runtime';
+import '@module-federation/sdk';
+
+function prefetch(options) {
+    const { id, functionId = 'default' } = options;
+    const mfScope = getScope();
+    const prefetchInstance = MFDataPrefetch.getInstance(mfScope) || new MFDataPrefetch({
+        name: mfScope
+    });
+    const res = prefetchInstance.getProjectExports();
+    if (res instanceof Promise) {
+        const promise = res.then(()=>{
+            const result = prefetchInstance.prefetch(options);
+            prefetchInstance.memorize(id + functionId, result);
+            return result;
+        });
+        return promise;
+    } else {
+        const result = prefetchInstance.prefetch(options);
+        prefetchInstance.memorize(id + functionId, result);
+        return result;
+    }
+}
+
+export { prefetch };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@module-federation/data-prefetch",
   "description": "Module Federation Data Prefetch",
-  "version": "0.0.0-next-20241010084324",
+  "version": "0.0.0-next-20241011070539",
   "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"
@@ -75,8 +78,8 @@
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "minimist": "^1.2.8",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
     "react-router": "^6.21.3",
     "react-test-renderer": "^18.2.0",
     "ts-jest": "29.0.1",
@@ -85,8 +88,8 @@
   },
   "dependencies": {
     "fs-extra": "9.1.0",
-    "@module-federation/sdk": "0.0.0-next-20241010084324",
-    "@module-federation/runtime": "0.0.0-next-20241010084324"
+    "@module-federation/runtime": "0.0.0-next-20241011070539",
+    "@module-federation/sdk": "0.0.0-next-20241011070539"
   },
   "scripts": {
     "dev": "cross-env WATCH=true tsup",

package/project.json

@@ -1,21 +1,63 @@
 {
-  "name": "module-federation/data-prefetch",
+  "name": "data-prefetch",
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
   "sourceRoot": "packages/data-prefetch/src",
   "projectType": "library",
+  "tags": ["type:pkg"],
   "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
+          }
+        ]
       }
     }
-  },
-  "tags": ["type:pkg"]
+  }
 }