@module-federation/bridge-react 0.0.0-next-20250707074728 → 0.0.0-next-20250708033956

package/dist/index.d.ts

@@ -1,11 +1,98 @@
 import { default as default_2 } from 'react';
+import { FederationRuntimePlugin } from '@module-federation/runtime';
+import { getInstance } from '@module-federation/runtime';
+import { JSX as JSX_2 } from 'react';
+import { Key } from 'react';
 import * as React_2 from 'react';
+import { ReactNode } from 'react';
+
+export declare const autoFetchDataPlugin: () => FederationRuntimePlugin;
+
+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;
+    customKey?: <Args extends any[]>(options: {
+        params: Args;
+        fn: (...args: Args) => any;
+        generatedKey: string;
+    }) => string | symbol;
+    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;
+    cacheData?: boolean;
+};
+
+export declare function createRemoteAppComponent<T = Record<string, unknown>, E extends keyof T = keyof T>(info: LazyRemoteComponentInfo<T, E>): default_2.ForwardRefExoticComponent<Omit<RemoteComponentProps<Record<string, unknown>>, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
+
+/**
+ * @deprecated createRemoteAppComponent is deprecated, please use createRemoteAppComponent instead!
+ */
 export declare function createRemoteComponent<T = Record<string, unknown>, E extends keyof T = keyof T>(info: LazyRemoteComponentInfo<T, E>): default_2.ForwardRefExoticComponent<Omit<RemoteComponentProps<Record<string, unknown>>, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
 
 export declare interface CreateRootOptions {
@@ -22,6 +109,13 @@ declare interface CreateRootOptions_2 {
     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
  */
@@ -30,8 +124,39 @@ export declare interface DestroyParams {
     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;
+
 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
  */
@@ -65,6 +190,10 @@ export declare interface ProviderParams {
     className?: string;
 }
 
+declare type ReactKey = {
+    key?: default_2.Key | null;
+};
+
 /**
  * Parameters for the remote component loader
  */
@@ -113,6 +242,8 @@ export declare interface RenderParams {
     [key: string]: unknown;
 }
 
+export declare function revalidateTag(tag: string): void;
+
 export declare interface Root {
     render(children: React.ReactNode): void;
     unmount(): void;
@@ -131,4 +262,16 @@ declare interface Root_2 {
  */
 export declare type RootType = HTMLElement | Root_2;
 
+export declare function setSSREnv({ fetchServerQuery, }: {
+    fetchServerQuery?: Record<string, unknown>;
+}): void;
+
+export declare function wrapNoSSR<T, E extends keyof T>(createLazyComponentFn: typeof createLazyComponent<T, E>): (options: Omit<CreateLazyComponentOptions<T, E>, "noSSR">) => (props: T[E] extends (...args: any) => any ? Parameters<T[E]>[0] extends undefined ? {
+    key?: Key | null;
+} : Parameters<T[E]>[0] & {
+    key?: Key | null;
+} : {
+    key?: Key | null;
+}) => JSX_2.Element;
+
 export { }