remote-components 0.1.0 → 0.2.0

package/dist/react/index.d.ts

@@ -1,123 +0,0 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { R as ResolveClientUrl } from '../proxy-through-host-a676a522.js';
-export { p as proxyClientRequestsThroughHost } from '../proxy-through-host-a676a522.js';
-import { L as LoadRemoteComponentProps, O as OnRequestHook, a as OnResponseHook } from '../component-loader-76eb1b8b.js';
-export { H as HookOptions } from '../component-loader-76eb1b8b.js';
-import 'react';
-
-/**
- * Client-side context provider for passing `resolveClientUrl` to all nested
- * `<RemoteComponent>` instances. Since `resolveClientUrl` is a function, it
- * can't be passed as a prop through Server Components — this provider should
- * wrap the tree in a Client Component boundary so the callback is available
- * on the client where asset fetches happen.
- */
-declare function RemoteComponentsProvider({ resolveClientUrl, children, }: {
-    resolveClientUrl?: ResolveClientUrl;
-    children: React.ReactNode;
-}): react_jsx_runtime.JSX.Element;
-
-declare module 'react/jsx-runtime' {
-    namespace JSX {
-        interface IntrinsicElements {
-            template: {
-                shadowrootmode?: 'open' | 'closed';
-                id?: string;
-                ref?: React.Ref<HTMLTemplateElement>;
-                dangerouslySetInnerHTML?: {
-                    __html: string;
-                };
-                children?: React.ReactNode;
-            };
-        }
-    }
-}
-interface RemoteComponentProps {
-    /** The source URL of the remote component. */
-    src?: string | URL;
-    /** Whether to isolate the remote component using a Shadow DOM wrapper. */
-    isolate?: boolean;
-    /** The shadow DOM mode to use when isolating the remote component. */
-    mode?: 'open' | 'closed';
-    /** Whether to include a CSS reset style in the shadow DOM. Defaults to `false`. */
-    reset?: boolean;
-    /** The credentials to use for the fetch request. Defaults to `same-origin`. */
-    credentials?: RequestCredentials;
-    name?: string;
-    /** Shared modules to include in the remote component's context. */
-    shared?: LoadRemoteComponentProps['shared'];
-    /** The children to use as a loading fallback until the remote component is loaded. */
-    children?: React.ReactNode;
-    /** Called right before a new remote component load starts. */
-    onBeforeLoad?: (src: string | URL) => void;
-    /** Called when the remote component has been successfully loaded and mounted. */
-    onLoad?: (src: string | URL) => void;
-    /** Called when an error occurs while loading or mounting the remote component. */
-    onError?: (error: unknown) => void;
-    /** Called when a different remote component is loaded into the same wrapper. */
-    onChange?: (info: {
-        previousSrc: string | URL | null;
-        nextSrc: string | URL | null;
-        previousName: string | undefined;
-        nextName: string | undefined;
-    }) => void;
-    /**
-     * Called when a fetch request is made to retrieve the remote component payload.
-     * Can be used to intercept requests, modify headers, or provide a custom response.
-     */
-    onRequest?: OnRequestHook;
-    /**
-     * Called after a fetch completes to retrieve the remote component payload.
-     * Can be used to inspect the response (e.g., check for redirects) or transform it.
-     */
-    onResponse?: OnResponseHook;
-    /**
-     * Called before each client-side asset (script, stylesheet, chunk, module, image) is fetched.
-     * Return a new URL string to redirect the request (e.g., through a proxy),
-     * or `undefined` to use the original URL.
-     *
-     * Pass `proxyClientRequestsThroughHost` to proxy cross-origin assets through
-     * the host on Vercel preview deployments. Requires `withRemoteComponentsHost`
-     * middleware on the host to handle the proxied requests.
-     */
-    resolveClientUrl?: ResolveClientUrl;
-}
-/**
- * RemoteComponent is a React component that fetches and renders a remote component.
- * It supports SSR and can isolate the remote component in a shadow DOM.
- *
- * @param props - The properties for the remote component.
- * @returns A React component that renders the remote component.
- *
- * @example
- *
- * Use the `<RemoteComponent>` in your React application to consume a remote component from a remote application:
- *
- * ```tsx
- * import { RemoteComponent } from 'remote-components/react';
- *
- * export default function App() {
- *  return (
- *    <>
- *      <h1>Welcome to My App</h1>
- *      <p>This page consumes a remote component from another application.</p>
- *      <RemoteComponent src="/nextjs-app-remote/components/header" />
- *    </>
- *  );
- * }
- * ```
- *
- * To share modules, you can provide a shared module map with references to the shared modules:
- *
- * ```tsx
- * <RemoteComponent
- *   src="/nextjs-app-remote/components/header"
- *   shared={{
- *     '@/components/provider': () => import('@/components/host-provider')
- *   }}
- * />
- * ```
- */
-declare function RemoteComponent({ src, isolate, mode, reset, credentials, name: nameProp, shared, children, onBeforeLoad, onLoad, onError, onChange, onRequest, onResponse, resolveClientUrl: _resolveClientUrl, }: RemoteComponentProps): react_jsx_runtime.JSX.Element;
-
-export { OnRequestHook, OnResponseHook, RemoteComponent, RemoteComponentProps, RemoteComponentsProvider, ResolveClientUrl };