@module-federation/bridge-react 0.21.6 → 0.22.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @module-federation/bridge-react
 
+## 0.22.0
+
+### Patch Changes
+
+- @module-federation/sdk@0.22.0
+- @module-federation/bridge-shared@0.22.0
+
 ## 0.21.6
 
 ### Patch Changes

package/dist/base.cjs.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const createHelpers = require("./createHelpers-B_L612IN.js");
+const lazyLoadComponentPlugin = require("./lazy-load-component-plugin-Bt990iJq.js");
+const lazyUtils = require("./utils-tM9yE73c.js");
+const dataFetchUtils = require("./data-fetch-utils.cjs.js");
+const prefetch = require("./prefetch-D-d4LlJ3.js");
+const createRemoteAppComponent = createHelpers.createRemoteAppComponentFactory(createHelpers.RemoteAppWrapper);
+const createRemoteComponent = createHelpers.createDeprecatedRemoteComponentFactory(
+  createRemoteAppComponent
+);
+exports.createBridgeComponent = createHelpers.createBridgeComponent;
+exports.autoFetchDataPlugin = lazyLoadComponentPlugin.autoFetchData;
+exports.collectSSRAssets = lazyLoadComponentPlugin.collectSSRAssets;
+exports.createLazyComponent = lazyLoadComponentPlugin.createLazyComponent;
+exports.lazyLoadComponentPlugin = lazyLoadComponentPlugin.lazyLoadComponentPlugin;
+exports.CacheSize = lazyUtils.CacheSize;
+exports.CacheTime = lazyUtils.CacheTime;
+exports.ERROR_TYPE = lazyUtils.ERROR_TYPE;
+exports.cache = lazyUtils.cache;
+exports.clearStore = lazyUtils.clearStore;
+exports.configureCache = lazyUtils.configureCache;
+exports.generateKey = lazyUtils.generateKey;
+exports.revalidateTag = lazyUtils.revalidateTag;
+exports.setSSREnv = lazyUtils.setSSREnv;
+exports.callDataFetch = dataFetchUtils.callDataFetch;
+exports.prefetch = prefetch.prefetch;
+exports.createRemoteAppComponent = createRemoteAppComponent;
+exports.createRemoteComponent = createRemoteComponent;

package/dist/base.d.ts

@@ -0,0 +1,311 @@
+import { default as default_2 } from 'react';
+import { ForwardRefExoticComponent } from 'react';
+import { getInstance } from '@module-federation/runtime';
+import { ModuleFederationRuntimePlugin } from '@module-federation/runtime';
+import * as React_2 from 'react';
+import { ReactNode } from 'react';
+import { RefAttributes } from 'react';
+
+export declare const autoFetchDataPlugin: () => ModuleFederationRuntimePlugin;
+
+export declare function cache<T>(fn: DataFetch<T>, options?: CacheOptions): DataFetch<T>;
+
+declare interface CacheConfig {
+    maxSize?: number;
+    unstable_shouldDisable?: ({ request, }: {
+        request: Request;
+    }) => boolean | Promise<boolean>;
+}
+
+declare interface CacheOptions {
+    tag?: string | string[];
+    maxAge?: number;
+    revalidate?: number;
+    getKey?: <Args extends any[]>(...args: Args) => string;
+    onCache?: (info: CacheStatsInfo) => boolean;
+}
+
+export declare const CacheSize: {
+    readonly KB: 1024;
+    readonly MB: number;
+    readonly GB: number;
+};
+
+export declare interface CacheStatsInfo {
+    status: CacheStatus;
+    key: string | symbol;
+    params: DataFetchParams;
+    result: any;
+}
+
+export declare type CacheStatus = 'hit' | 'stale' | 'miss';
+
+export declare const CacheTime: {
+    readonly SECOND: 1000;
+    readonly MINUTE: number;
+    readonly HOUR: number;
+    readonly DAY: number;
+    readonly WEEK: number;
+    readonly MONTH: number;
+};
+
+export declare function callDataFetch(): Promise<void>;
+
+export declare function clearStore(): void;
+
+export declare function collectSSRAssets(options: CollectSSRAssetsOptions): default_2.ReactNode[];
+
+export declare type CollectSSRAssetsOptions = {
+    id: string;
+    instance: ReturnType<typeof getInstance>;
+    injectScript?: boolean;
+    injectLink?: boolean;
+};
+
+export declare function configureCache(config: CacheConfig): void;
+
+export declare function createBridgeComponent<T = any>(bridgeInfo: Omit<ProviderFnParams<T>, 'createRoot'>): () => {
+    render(info: RenderParams): Promise<void>;
+    destroy(info: DestroyParams): void;
+};
+
+export declare function createLazyComponent<T, E extends keyof T>(options: CreateLazyComponentOptions<T, E>): (props: T[E] extends (...args: any) => any ? Parameters<T[E]>[0] extends undefined ? ReactKey : Parameters<T[E]>[0] & ReactKey : ReactKey) => default_2.JSX.Element;
+
+export declare type CreateLazyComponentOptions<T, E extends keyof T> = {
+    loader: () => Promise<T>;
+    instance: ReturnType<typeof getInstance>;
+    loading: default_2.ReactNode;
+    delayLoading?: number;
+    fallback: ReactNode | ((errorInfo: ErrorInfo) => ReactNode);
+    export?: E;
+    dataFetchParams?: DataFetchParams;
+    noSSR?: boolean;
+    injectScript?: boolean;
+    injectLink?: boolean;
+};
+
+export declare const createRemoteAppComponent: <T = Record<string, unknown>, E extends keyof T = keyof T>(info: LazyRemoteComponentInfo<T, E>) => ForwardRefExoticComponent<Omit<RemoteComponentProps_2<Record<string, unknown>>, "ref"> & RefAttributes<HTMLDivElement>>;
+
+/**
+ * @deprecated createRemoteComponent is deprecated, please use createRemoteAppComponent instead!
+ */
+export declare const createRemoteComponent: <T = Record<string, unknown>, E extends keyof T = keyof T>(info: LazyRemoteComponentInfo<T, E>) => any;
+
+export declare interface CreateRootOptions {
+    identifierPrefix?: string;
+    onRecoverableError?: (error: unknown, errorInfo: unknown) => void;
+}
+
+/**
+ * Options for creating a React root
+ */
+declare interface CreateRootOptions_2 {
+    identifierPrefix?: string;
+    onRecoverableError?: (error: unknown) => void;
+    transitionCallbacks?: unknown;
+}
+
+declare type DataFetch<T> = (params: DataFetchParams) => Promise<T>;
+
+export declare type DataFetchParams = {
+    isDowngrade: boolean;
+    _id?: string;
+} & Record<string, unknown>;
+
+/**
+ * Parameters for the destroy function
+ */
+export declare interface DestroyParams {
+    moduleName: string;
+    dom: HTMLElement;
+}
+
+export declare const ERROR_TYPE: {
+    DATA_FETCH: number;
+    LOAD_REMOTE: number;
+    UNKNOWN: number;
+};
+
+declare type ErrorInfo = {
+    error: Error;
+    errorType: number;
+    dataFetchMapKey?: string;
+};
+
+export declare function generateKey(dataFetchOptions: DataFetchParams): string;
+
+export declare function lazyLoadComponentPlugin(): ModuleFederationRuntimePlugin;
+
+export declare type LazyRemoteComponentInfo<T, _E extends keyof T> = RemoteComponentParams<T>;
+
+export declare type NoSSRRemoteInfo = {
+    name: string;
+    version: string;
+    ssrPublicPath: string;
+    ssrRemoteEntry: string;
+    globalName: string;
+};
+
+export declare function prefetch(options: PrefetchOptions): Promise<void>;
+
+declare type PrefetchOptions = {
+    id: string;
+    instance: ReturnType<typeof getInstance>;
+    dataFetchParams?: DataFetchParams;
+    preloadComponentResource?: boolean;
+};
+
+/**
+ * Parameters for the provider function
+ */
+export declare interface ProviderFnParams<T> {
+    rootComponent: React_2.ComponentType<T>;
+    render?: (App: React_2.ReactElement, id?: HTMLElement | string) => RootType | Promise<RootType>;
+    createRoot?: (container: Element | DocumentFragment, options?: CreateRootOptions_2) => Root_2;
+    /**
+     * Default options to pass to createRoot for React 18 and 19
+     * These options will be used when creating a root unless overridden by rootOptions in render params
+     * @example
+     * {
+     *   identifierPrefix: 'app-',
+     *   onRecoverableError: (err) => console.error(err)
+     * }
+     */
+    defaultRootOptions?: CreateRootOptions_2;
+}
+
+/**
+ * Parameters for the provider function
+ */
+export declare interface ProviderParams {
+    moduleName?: string;
+    basename?: string;
+    memoryRoute?: {
+        entryPath: string;
+        initialState?: Record<string, unknown>;
+    };
+    style?: React_2.CSSProperties;
+    className?: string;
+}
+
+declare type ReactKey = {
+    key?: default_2.Key | null;
+};
+
+/**
+ * Parameters for the remote component loader
+ */
+export declare interface RemoteComponentParams<T = Record<string, unknown>, E extends keyof T = keyof T> {
+    loader: () => Promise<T>;
+    loading: React_2.ReactNode;
+    fallback: React_2.ComponentType<{
+        error: Error;
+    }>;
+    export?: E;
+    props?: T;
+}
+
+/**
+ * Parameters for the remote component
+ */
+export declare interface RemoteComponentProps<T = Record<string, unknown>> {
+    props?: T;
+    fallback?: React_2.ComponentType<{
+        error: Error;
+    }>;
+    loading?: React_2.ReactNode;
+    [key: string]: unknown;
+}
+
+/**
+ * Parameters for the remote component
+ */
+declare interface RemoteComponentProps_2<T = Record<string, unknown>> {
+    props?: T;
+    fallback?: React_2.ComponentType<{
+        error: Error;
+    }>;
+    loading?: React_2.ReactNode;
+    [key: string]: unknown;
+}
+
+/**
+ * Interface for a remote module provider
+ */
+export declare interface RemoteModule {
+    provider: () => {
+        render: (info: RenderFnParams) => void;
+        destroy: (info: {
+            dom: any;
+        }) => void;
+    };
+}
+
+/**
+ * Parameters for the render function, extending ProviderParams
+ */
+export declare interface RenderFnParams extends ProviderParams {
+    dom: HTMLElement;
+    fallback?: React_2.ComponentType<{
+        error: Error;
+    }>;
+    [key: string]: unknown;
+}
+
+/**
+ * Parameters for the render function
+ */
+export declare interface RenderParams {
+    moduleName?: string;
+    basename?: string;
+    memoryRoute?: {
+        entryPath: string;
+        initialState?: Record<string, unknown>;
+    };
+    dom: HTMLElement;
+    /**
+     * Options to pass to createRoot for React 18 and 19
+     * @example
+     * {
+     *   identifierPrefix: 'app-',
+     *   onRecoverableError: (err) => console.error(err)
+     * }
+     */
+    rootOptions?: CreateRootOptions_2;
+    [key: string]: unknown;
+}
+
+export declare function revalidateTag(tag: string): void;
+
+export declare interface Root {
+    render(children: React.ReactNode): void;
+    unmount(): void;
+}
+
+/**
+ * Interface for a React root object
+ */
+declare interface Root_2 {
+    render(children: React_2.ReactNode): void;
+    unmount(): void;
+}
+
+/**
+ * Type for a root element, which can be either an HTMLElement or a React root
+ */
+export declare type RootType = HTMLElement | Root_2;
+
+export declare function setSSREnv({ fetchServerQuery, }: {
+    fetchServerQuery?: Record<string, unknown>;
+}): void;
+
+export { }
+
+
+declare module '@module-federation/runtime-core' {
+    interface ModuleFederation {
+        createLazyComponent<T, E extends keyof T>(options: Omit<CreateLazyComponentOptions<T, E>, 'instance'>): ReturnType<typeof createLazyComponent<T, E>>;
+        prefetch(options: Omit<PrefetchOptions, 'instance'>): ReturnType<typeof prefetch>;
+        collectSSRAssets(options: Omit<Parameters<typeof collectSSRAssets>[0], 'instance'>): ReturnType<typeof collectSSRAssets>;
+    }
+}

package/dist/base.es.js

@@ -0,0 +1,30 @@
+import { c as createDeprecatedRemoteComponentFactory, a as createRemoteAppComponentFactory, R as RemoteAppWrapper } from "./createHelpers-Ui5pt7je.mjs";
+import { b } from "./createHelpers-Ui5pt7je.mjs";
+import { b as b2, a, c, l } from "./lazy-load-component-plugin-BkcO9pUC.mjs";
+import { C, a as a2, E, b as b3, d, c as c2, g, r, s } from "./utils-dUgb9Jkm.mjs";
+import { callDataFetch } from "./data-fetch-utils.es.js";
+import { p } from "./prefetch-DAwiqbcO.mjs";
+const createRemoteAppComponent = createRemoteAppComponentFactory(RemoteAppWrapper);
+const createRemoteComponent = createDeprecatedRemoteComponentFactory(
+  createRemoteAppComponent
+);
+export {
+  C as CacheSize,
+  a2 as CacheTime,
+  E as ERROR_TYPE,
+  b2 as autoFetchDataPlugin,
+  b3 as cache,
+  callDataFetch,
+  d as clearStore,
+  a as collectSSRAssets,
+  c2 as configureCache,
+  b as createBridgeComponent,
+  c as createLazyComponent,
+  createRemoteAppComponent,
+  createRemoteComponent,
+  g as generateKey,
+  l as lazyLoadComponentPlugin,
+  p as prefetch,
+  r as revalidateTag,
+  s as setSSREnv
+};

package/dist/createHelpers-B_L612IN.js

@@ -0,0 +1,190 @@
+"use strict";
+const bridgeBase = require("./bridge-base-RStDxH71.js");
+const ReactDOM = require("react-dom");
+const index = require("./index-DRSBaSu3.js");
+const React = require("react");
+const plugin = require("./plugin.cjs.js");
+function createReact16Or17Root(container) {
+  return {
+    render(children) {
+      const reactVersion = ReactDOM.version || "";
+      const isReact18 = reactVersion.startsWith("18");
+      const isReact19 = reactVersion.startsWith("19");
+      if (isReact19) {
+        throw new Error(
+          `React 19 detected in legacy mode. This is not supported. Please use the version-specific import: import { createBridgeComponent } from '@module-federation/bridge-react/v19'`
+        );
+      }
+      if (isReact18) {
+        index.LoggerInstance.warn(
+          `[Bridge-React] React 18 detected in legacy mode. For better compatibility, please use the version-specific import: import { createBridgeComponent } from '@module-federation/bridge-react/v18'`
+        );
+      }
+      ReactDOM.render(children, container);
+    },
+    unmount() {
+      ReactDOM.unmountComponentAtNode(container);
+    }
+  };
+}
+function createBridgeComponent(bridgeInfo) {
+  const fullBridgeInfo = {
+    createRoot: createReact16Or17Root,
+    ...bridgeInfo
+  };
+  return bridgeBase.createBaseBridgeComponent(fullBridgeInfo);
+}
+const RemoteAppWrapper = React.forwardRef(function(props, ref) {
+  const {
+    moduleName,
+    memoryRoute,
+    basename,
+    providerInfo,
+    className,
+    style,
+    fallback,
+    loading,
+    ...resProps
+  } = props;
+  const instance = plugin.federationRuntime.instance;
+  const rootRef = ref && "current" in ref ? ref : React.useRef(null);
+  const renderDom = React.useRef(null);
+  const providerInfoRef = React.useRef(null);
+  const [initialized, setInitialized] = React.useState(false);
+  index.LoggerInstance.debug(`RemoteAppWrapper instance from props >>>`, instance);
+  React.useEffect(() => {
+    if (initialized) return;
+    const providerReturn = providerInfo();
+    providerInfoRef.current = providerReturn;
+    setInitialized(true);
+    return () => {
+      var _a, _b, _c, _d, _e, _f, _g, _h;
+      if ((_a = providerInfoRef.current) == null ? void 0 : _a.destroy) {
+        index.LoggerInstance.debug(
+          `createRemoteAppComponent LazyComponent destroy >>>`,
+          { moduleName, basename, dom: renderDom.current }
+        );
+        (_d = (_c = (_b = instance == null ? void 0 : instance.bridgeHook) == null ? void 0 : _b.lifecycle) == null ? void 0 : _c.beforeBridgeDestroy) == null ? void 0 : _d.emit({
+          moduleName,
+          dom: renderDom.current,
+          basename,
+          memoryRoute,
+          fallback,
+          ...resProps
+        });
+        (_e = providerInfoRef.current) == null ? void 0 : _e.destroy({
+          moduleName,
+          dom: renderDom.current
+        });
+        (_h = (_g = (_f = instance == null ? void 0 : instance.bridgeHook) == null ? void 0 : _f.lifecycle) == null ? void 0 : _g.afterBridgeDestroy) == null ? void 0 : _h.emit({
+          moduleName,
+          dom: renderDom.current,
+          basename,
+          memoryRoute,
+          fallback,
+          ...resProps
+        });
+      }
+    };
+  }, [moduleName]);
+  React.useEffect(() => {
+    var _a, _b, _c, _d, _e, _f;
+    if (!initialized || !providerInfoRef.current) return;
+    let renderProps = {
+      moduleName,
+      dom: rootRef.current,
+      basename,
+      memoryRoute,
+      fallback,
+      ...resProps
+    };
+    renderDom.current = rootRef.current;
+    const beforeBridgeRenderRes = ((_c = (_b = (_a = instance == null ? void 0 : instance.bridgeHook) == null ? void 0 : _a.lifecycle) == null ? void 0 : _b.beforeBridgeRender) == null ? void 0 : _c.emit(renderProps)) || {};
+    renderProps = { ...renderProps, ...beforeBridgeRenderRes.extraProps };
+    providerInfoRef.current.render(renderProps);
+    (_f = (_e = (_d = instance == null ? void 0 : instance.bridgeHook) == null ? void 0 : _d.lifecycle) == null ? void 0 : _e.afterBridgeRender) == null ? void 0 : _f.emit(renderProps);
+  }, [initialized, ...Object.values(props)]);
+  const rootComponentClassName = `${index.getRootDomDefaultClassName(moduleName)} ${className || ""}`;
+  return /* @__PURE__ */ React.createElement("div", { className: rootComponentClassName, style, ref: rootRef }, loading);
+});
+function createLazyRemoteComponentFactory(RemoteApp) {
+  return function createLazyRemoteComponent(info) {
+    const exportName = (info == null ? void 0 : info.export) || "default";
+    return React.lazy(async () => {
+      index.LoggerInstance.debug(
+        `createRemoteAppComponent LazyComponent create >>>`,
+        {
+          lazyComponent: info.loader,
+          exportName
+        }
+      );
+      try {
+        const m = await info.loader();
+        const moduleName = m && m[Symbol.for("mf_module_id")];
+        index.LoggerInstance.debug(
+          `createRemoteAppComponent LazyComponent loadRemote info >>>`,
+          { name: moduleName, module: m, exportName }
+        );
+        const exportFn = m[exportName];
+        if (exportName in m && typeof exportFn === "function") {
+          const RemoteAppComponent = React.forwardRef((props, ref) => {
+            return /* @__PURE__ */ React.createElement(
+              RemoteApp,
+              {
+                moduleName,
+                providerInfo: exportFn,
+                exportName: info.export || "default",
+                fallback: info.fallback,
+                loading: info.loading,
+                ref,
+                ...props
+              }
+            );
+          });
+          return {
+            default: RemoteAppComponent
+          };
+        } else {
+          index.LoggerInstance.debug(
+            `createRemoteAppComponent LazyComponent module not found >>>`,
+            { name: moduleName, module: m, exportName }
+          );
+          throw Error(
+            `Make sure that ${moduleName} has the correct export when export is ${String(
+              exportName
+            )}`
+          );
+        }
+      } catch (error) {
+        throw error;
+      }
+    });
+  };
+}
+function createRemoteAppComponentFactory(RemoteApp) {
+  const createLazyRemoteComponent = createLazyRemoteComponentFactory(RemoteApp);
+  return function createRemoteAppComponent(info) {
+    const LazyComponent = createLazyRemoteComponent(info);
+    return React.forwardRef((props, ref) => {
+      return /* @__PURE__ */ React.createElement(
+        bridgeBase.ErrorBoundary,
+        {
+          FallbackComponent: info.fallback
+        },
+        /* @__PURE__ */ React.createElement(React.Suspense, { fallback: info.loading }, /* @__PURE__ */ React.createElement(LazyComponent, { ...props, ref }))
+      );
+    });
+  };
+}
+function createDeprecatedRemoteComponentFactory(createFn) {
+  return function createRemoteComponent(info) {
+    index.LoggerInstance.warn(
+      `createRemoteComponent is deprecated, please use createRemoteAppComponent instead!`
+    );
+    return createFn(info);
+  };
+}
+exports.RemoteAppWrapper = RemoteAppWrapper;
+exports.createBridgeComponent = createBridgeComponent;
+exports.createDeprecatedRemoteComponentFactory = createDeprecatedRemoteComponentFactory;
+exports.createRemoteAppComponentFactory = createRemoteAppComponentFactory;