react-router 7.7.1 → 7.8.0-pre.1

package/dist/development/index.d.ts

@@ -1,14 +1,13 @@
-import { d as Router, e as RouteModules, D as DataStrategyFunction, T as To, f as NavigateOptions, B as BlockerFunction, g as Blocker, h as SerializeFrom, i as RelativeRoutingType, a as Location, j as ParamParseKey, k as Path, l as PathPattern, m as PathMatch, U as UIMatch, n as Navigation, A as Action, o as Params, p as RouteObject, I as InitialEntry, H as HydrationState, q as IndexRouteObject, r as LoaderFunction, s as ActionFunction, t as MetaFunction, v as LinksFunction, w as NonIndexRouteObject, x as AppLoadContext, y as unstable_RouterContextProvider, z as MiddlewareEnabled, E as unstable_InitialContext, F as Equal, J as ClientActionFunction, K as ClientLoaderFunction, O as HeadersFunction, Q as ShouldRevalidateFunction, V as RouterInit, W as RouterState, X as PatchRoutesOnNavigationFunction, Y as DataRouteObject } from './routeModules-BR2FO0ix.js';
-export { a7 as ActionFunctionArgs, aG as ClientActionFunctionArgs, aH as ClientLoaderFunctionArgs, aC as DataRouteMatch, a8 as DataStrategyFunctionArgs, a9 as DataStrategyMatch, aa as DataStrategyResult, ac as ErrorResponse, a1 as Fetcher, ad as FormEncType, ae as FormMethod, aM as Future, _ as GetScrollPositionFunction, $ as GetScrollRestorationKeyFunction, af as HTMLFormMethod, aI as HeadersArgs, aL as HtmlLinkDescriptor, as as IDLE_BLOCKER, ar as IDLE_FETCHER, aq as IDLE_NAVIGATION, ag as LazyRouteFunction, L as LinkDescriptor, ah as LoaderFunctionArgs, aJ as MetaArgs, M as MetaDescriptor, a2 as NavigationStates, aD as Navigator, aK as PageLinkDescriptor, aE as PatchRoutesOnNavigationFunctionArgs, aj as PathParam, ak as RedirectFunction, a6 as RevalidationState, aF as RouteMatch, a5 as RouterFetchOptions, a4 as RouterNavigateOptions, a3 as RouterSubscriber, am as ShouldRevalidateFunctionArgs, Z as StaticHandler, a0 as StaticHandlerContext, aS as UNSAFE_DataRouterContext, aT as UNSAFE_DataRouterStateContext, ab as UNSAFE_DataWithResponseInit, aR as UNSAFE_ErrorResponseImpl, aU as UNSAFE_FetchersContext, aV as UNSAFE_LocationContext, aW as UNSAFE_NavigationContext, aX as UNSAFE_RouteContext, aY as UNSAFE_ViewTransitionContext, aO as UNSAFE_createBrowserHistory, aQ as UNSAFE_createRouter, aP as UNSAFE_invariant, ao as createPath, at as data, au as generatePath, av as isRouteErrorResponse, aw as matchPath, ax as matchRoutes, ap as parsePath, ay as redirect, az as redirectDocument, aA as replace, aB as resolvePath, ai as unstable_MiddlewareFunction, al as unstable_RouterContext, aN as unstable_SerializesTo, an as unstable_createContext } from './routeModules-BR2FO0ix.js';
-import { A as AssetsManifest, E as EntryContext, F as FutureConfig, R as RouteComponentType, H as HydrateFallbackType, a as ErrorBoundaryType, S as ServerBuild } from './index-react-server-client-Bi_fx8qz.js';
-export { h as Await, b as AwaitProps, V as BrowserRouter, B as BrowserRouterProps, D as DOMRouterOpts, ar as DiscoverBehavior, y as FetcherFormProps, K as FetcherSubmitFunction, a9 as FetcherSubmitOptions, Q as FetcherWithComponents, _ as Form, z as FormProps, as as HandleDataRequestFunction, at as HandleDocumentRequestFunction, au as HandleErrorFunction, W as HashRouter, t as HashRouterProps, u as HistoryRouterProps, I as IndexRouteProps, L as LayoutRouteProps, X as Link, v as LinkProps, am as Links, i as MemoryRouter, M as MemoryRouterOpts, c as MemoryRouterProps, al as Meta, Z as NavLink, w as NavLinkProps, x as NavLinkRenderProps, j as Navigate, N as NavigateProps, k as Outlet, O as OutletProps, aa as ParamKeyValuePair, P as PathRouteProps, aq as PrefetchBehavior, ao as PrefetchPageLinks, l as Route, d as RouteProps, m as Router, e as RouterProps, n as RouterProvider, f as RouterProviderProps, o as Routes, g as RoutesProps, an as Scripts, ap as ScriptsProps, $ as ScrollRestoration, C as ScrollRestorationProps, av as ServerEntryModule, G as SetURLSearchParams, aj as StaticRouter, af as StaticRouterProps, ak as StaticRouterProvider, ag as StaticRouterProviderProps, J as SubmitFunction, ab as SubmitOptions, ad as SubmitTarget, aE as UNSAFE_FrameworkContext, ay as UNSAFE_WithComponentProps, aC as UNSAFE_WithErrorBoundaryProps, aA as UNSAFE_WithHydrateFallbackProps, aF as UNSAFE_createClientRoutes, aG as UNSAFE_createClientRoutesWithHMRRevalidationOptOut, aw as UNSAFE_hydrationRouteProperties, ax as UNSAFE_mapRouteProperties, aH as UNSAFE_shouldHydrateRouteLoader, aI as UNSAFE_useScrollRestoration, az as UNSAFE_withComponentProps, aD as UNSAFE_withErrorBoundaryProps, aB as UNSAFE_withHydrateFallbackProps, ac as URLSearchParamsInit, T as createBrowserRouter, U as createHashRouter, p as createMemoryRouter, q as createRoutesFromChildren, r as createRoutesFromElements, ae as createSearchParams, ah as createStaticHandler, ai as createStaticRouter, s as renderMatches, Y as unstable_HistoryRouter, a7 as unstable_usePrompt, a6 as useBeforeUnload, a4 as useFetcher, a5 as useFetchers, a3 as useFormAction, a0 as useLinkClickHandler, a1 as useSearchParams, a2 as useSubmit, a8 as useViewTransitionState } from './index-react-server-client-Bi_fx8qz.js';
+import { d as Router, e as RouteModules, D as DataStrategyFunction, T as To, f as NavigateOptions, B as BlockerFunction, g as Blocker, h as SerializeFrom, i as RelativeRoutingType, a as Location, j as ParamParseKey, k as Path, l as PathPattern, m as PathMatch, U as UIMatch, n as Navigation, A as Action, o as Params, p as RouteObject, I as InitialEntry, H as HydrationState, q as IndexRouteObject, r as LoaderFunction, s as ActionFunction, t as MetaFunction, v as LinksFunction, w as NonIndexRouteObject, x as AppLoadContext, y as unstable_RouterContextProvider, z as MiddlewareEnabled, E as Equal, F as ClientActionFunction, J as ClientLoaderFunction, K as HeadersFunction, O as ShouldRevalidateFunction, Q as RouterInit, V as RouterState, W as PatchRoutesOnNavigationFunction, X as DataRouteObject } from './routeModules-qBivMBjd.js';
+export { a6 as ActionFunctionArgs, aF as ClientActionFunctionArgs, aG as ClientLoaderFunctionArgs, aB as DataRouteMatch, a7 as DataStrategyFunctionArgs, a8 as DataStrategyMatch, a9 as DataStrategyResult, ab as ErrorResponse, a0 as Fetcher, ac as FormEncType, ad as FormMethod, aL as Future, Z as GetScrollPositionFunction, _ as GetScrollRestorationKeyFunction, ae as HTMLFormMethod, aH as HeadersArgs, aK as HtmlLinkDescriptor, ar as IDLE_BLOCKER, aq as IDLE_FETCHER, ap as IDLE_NAVIGATION, af as LazyRouteFunction, L as LinkDescriptor, ag as LoaderFunctionArgs, aI as MetaArgs, M as MetaDescriptor, a1 as NavigationStates, aC as Navigator, aJ as PageLinkDescriptor, aD as PatchRoutesOnNavigationFunctionArgs, ai as PathParam, aj as RedirectFunction, a5 as RevalidationState, aE as RouteMatch, a4 as RouterFetchOptions, a3 as RouterNavigateOptions, a2 as RouterSubscriber, al as ShouldRevalidateFunctionArgs, Y as StaticHandler, $ as StaticHandlerContext, aR as UNSAFE_DataRouterContext, aS as UNSAFE_DataRouterStateContext, aa as UNSAFE_DataWithResponseInit, aQ as UNSAFE_ErrorResponseImpl, aT as UNSAFE_FetchersContext, aU as UNSAFE_LocationContext, aV as UNSAFE_NavigationContext, aW as UNSAFE_RouteContext, aX as UNSAFE_ViewTransitionContext, aN as UNSAFE_createBrowserHistory, aP as UNSAFE_createRouter, aO as UNSAFE_invariant, an as createPath, as as data, at as generatePath, au as isRouteErrorResponse, av as matchPath, aw as matchRoutes, ao as parsePath, ax as redirect, ay as redirectDocument, az as replace, aA as resolvePath, ah as unstable_MiddlewareFunction, ak as unstable_RouterContext, aM as unstable_SerializesTo, am as unstable_createContext } from './routeModules-qBivMBjd.js';
+import { A as AssetsManifest, E as EntryContext, F as FutureConfig, R as RouteComponentType, H as HydrateFallbackType, a as ErrorBoundaryType, S as ServerBuild } from './index-react-server-client-BzBbJLAD.js';
+export { h as Await, b as AwaitProps, V as BrowserRouter, B as BrowserRouterProps, D as DOMRouterOpts, as as DiscoverBehavior, y as FetcherFormProps, K as FetcherSubmitFunction, a9 as FetcherSubmitOptions, Q as FetcherWithComponents, _ as Form, z as FormProps, at as HandleDataRequestFunction, au as HandleDocumentRequestFunction, av as HandleErrorFunction, W as HashRouter, t as HashRouterProps, u as HistoryRouterProps, I as IndexRouteProps, L as LayoutRouteProps, X as Link, v as LinkProps, am as Links, ap as LinksProps, i as MemoryRouter, M as MemoryRouterOpts, c as MemoryRouterProps, al as Meta, Z as NavLink, w as NavLinkProps, x as NavLinkRenderProps, j as Navigate, N as NavigateProps, k as Outlet, O as OutletProps, aa as ParamKeyValuePair, P as PathRouteProps, ar as PrefetchBehavior, ao as PrefetchPageLinks, l as Route, d as RouteProps, m as Router, e as RouterProps, n as RouterProvider, f as RouterProviderProps, o as Routes, g as RoutesProps, an as Scripts, aq as ScriptsProps, $ as ScrollRestoration, C as ScrollRestorationProps, aw as ServerEntryModule, G as SetURLSearchParams, aj as StaticRouter, af as StaticRouterProps, ak as StaticRouterProvider, ag as StaticRouterProviderProps, J as SubmitFunction, ab as SubmitOptions, ad as SubmitTarget, aF as UNSAFE_FrameworkContext, az as UNSAFE_WithComponentProps, aD as UNSAFE_WithErrorBoundaryProps, aB as UNSAFE_WithHydrateFallbackProps, aG as UNSAFE_createClientRoutes, aH as UNSAFE_createClientRoutesWithHMRRevalidationOptOut, ax as UNSAFE_hydrationRouteProperties, ay as UNSAFE_mapRouteProperties, aI as UNSAFE_shouldHydrateRouteLoader, aJ as UNSAFE_useScrollRestoration, aA as UNSAFE_withComponentProps, aE as UNSAFE_withErrorBoundaryProps, aC as UNSAFE_withHydrateFallbackProps, ac as URLSearchParamsInit, T as createBrowserRouter, U as createHashRouter, p as createMemoryRouter, q as createRoutesFromChildren, r as createRoutesFromElements, ae as createSearchParams, ah as createStaticHandler, ai as createStaticRouter, s as renderMatches, Y as unstable_HistoryRouter, a7 as unstable_usePrompt, a6 as useBeforeUnload, a4 as useFetcher, a5 as useFetchers, a3 as useFormAction, a0 as useLinkClickHandler, a1 as useSearchParams, a2 as useSubmit, a8 as useViewTransitionState } from './index-react-server-client-BzBbJLAD.js';
 import * as React from 'react';
 import React__default, { ReactElement } from 'react';
 import { ParseOptions, SerializeOptions } from 'cookie';
 export { ParseOptions as CookieParseOptions, SerializeOptions as CookieSerializeOptions } from 'cookie';
 import { P as Pages } from './register-DiOIlEq5.js';
 export { a as Register } from './register-DiOIlEq5.js';
-import { AsyncLocalStorage } from 'node:async_hooks';
 
 declare const SingleFetchRedirectSymbol: unique symbol;
 declare function getTurboStreamSingleFetchDataStrategy(getRouter: () => Router, manifest: AssetsManifest, routeModules: RouteModules, ssr: boolean, basename: string | undefined): DataStrategyFunction;
@@ -93,7 +92,7 @@ declare function useLocation(): Location;
  *
  * @public
  * @category Hooks
- * @returns The current {@link NavigationType} type (`"PUSH"`, `"REPLACE"`, or `"POP"`)
+ * @returns The current {@link NavigationType} (`"POP"`, `"PUSH"`, or `"REPLACE"`)
  */
 declare function useNavigationType(): Action;
 /**
@@ -227,7 +226,7 @@ declare function useNavigate(): NavigateFunction;
  * Often parent routes manage state or other values you want shared with child
  * routes. You can create your own [context provider](https://react.dev/learn/passing-data-deeply-with-context)
  * if you like, but this is such a common situation that it's built-into
- * `<Outlet />`.
+ * {@link Outlet | `<Outlet>`}.
  *
  * ```tsx
  * // Parent route
@@ -239,7 +238,7 @@ declare function useNavigate(): NavigateFunction;
  *
  * ```tsx
  * // Child route
- * import { useOutletContext } from "react-router-dom";
+ * import { useOutletContext } from "react-router";
  *
  * function Child() {
  *   const [count, setCount] = useOutletContext();
@@ -248,21 +247,23 @@ declare function useNavigate(): NavigateFunction;
  * }
  * ```
  *
- * If you're using TypeScript, we recommend the parent component provide a custom
- * hook for accessing the context value. This makes it easier for consumers to
- * get nice typings, control consumers, and know who's consuming the context value.
+ * If you're using TypeScript, we recommend the parent component provide a
+ * custom hook for accessing the context value. This makes it easier for
+ * consumers to get nice typings, control consumers, and know who's consuming
+ * the context value.
  *
  * Here's a more realistic example:
  *
- * ```tsx filename=src/routes/dashboard.tsx lines=[13,19]
- * import * as React from "react";
+ * ```tsx filename=src/routes/dashboard.tsx lines=[14,20]
+ * import { useState } from "react";
+ * import { Outlet, useOutletContext } from "react-router";
+ *
  * import type { User } from "./types";
- * import { Outlet, useOutletContext } from "react-router-dom";
  *
  * type ContextType = { user: User | null };
  *
  * export default function Dashboard() {
- *   const [user, setUser] = React.useState<User | null>(null);
+ *   const [user, setUser] = useState<User | null>(null);
  *
  *   return (
  *     <div>
@@ -722,22 +723,23 @@ declare function useAsyncError(): unknown;
  *   - `blocked` - the blocker has prevented a navigation
  *   - `proceeding` - the blocker is proceeding through from a blocked navigation
  * - **`location`**
- *   - When in a `blocked` state, this represents the {@link Location} to which we
- *     blocked a navigation. When in a `proceeding` state, this is the location
- *     being navigated to after a `blocker.proceed()` call.
+ *   - When in a `blocked` state, this represents the {@link Location} to which
+ *     we blocked a navigation. When in a `proceeding` state, this is the
+ *     location being navigated to after a `blocker.proceed()` call.
  * - **`proceed()`**
- *   - When in a `blocked` state, you may call `blocker.proceed()` to proceed to the
- *     blocked location.
+ *   - When in a `blocked` state, you may call `blocker.proceed()` to proceed to
+ *     the blocked location.
  * - **`reset()`**
- *   - When in a `blocked` state, you may call `blocker.reset()` to return the blocker
- *     back to an `unblocked` state and leave the user at the current location.
+ *   - When in a `blocked` state, you may call `blocker.reset()` to return the
+ *     blocker to an `unblocked` state and leave the user at the current
+ *     location.
  *
  * @example
  * // Boolean version
- * const blocker = useBlocker(value !== "");
+ * let blocker = useBlocker(value !== "");
  *
  * // Function version
- * const blocker = useBlocker(
+ * let blocker = useBlocker(
  *   ({ currentLocation, nextLocation, historyAction }) =>
  *     value !== "" &&
  *     currentLocation.pathname !== nextLocation.pathname
@@ -819,25 +821,37 @@ declare function useAsyncError(): unknown;
  */
 declare function useBlocker(shouldBlock: boolean | BlockerFunction): Blocker;
 
+/**
+ * @category Types
+ */
 interface ServerRouterProps {
+    /**
+     * The entry context containing the manifest, route modules, and other data
+     * needed for rendering.
+     */
     context: EntryContext;
+    /**
+     * The URL of the request being handled.
+     */
     url: string | URL;
+    /**
+     * An optional `nonce` for [Content Security Policy (CSP)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CSP)
+     * compliance, used to allow inline scripts to run safely.
+     */
     nonce?: string;
 }
 /**
- * The server entry point for a React Router app in Framework Mode. This component
- * is used to generate the HTML in the response from the server.
- * See [`entry.server.tsx`](../api/framework-conventions/entry.server.tsx).
+ * The server entry point for a React Router app in Framework Mode. This
+ * component is used to generate the HTML in the response from the server. See
+ * [`entry.server.tsx`](../framework-conventions/entry.server.tsx).
  *
  * @public
  * @category Framework Routers
  * @mode framework
  * @param props Props
- * @param props.context The entry context containing the manifest, route modules,
- * and other data needed for rendering.
- * @param props.url The URL of the request being handled.
- * @param props.nonce An optional nonce for Content Security Policy (CSP) compliance,
- * used to allow inline scripts to run safely.
+ * @param {ServerRouterProps.context} props.context n/a
+ * @param {ServerRouterProps.nonce} props.nonce n/a
+ * @param {ServerRouterProps.url} props.url n/a
  * @returns A React element that represents the server-rendered application.
  */
 declare function ServerRouter({ context, url, nonce, }: ServerRouterProps): ReactElement;
@@ -952,7 +966,7 @@ type IsCookieFunction = (object: any) => object is Cookie;
  */
 declare const isCookie: IsCookieFunction;
 
-type RequestHandler = (request: Request, loadContext?: MiddlewareEnabled extends true ? unstable_InitialContext : AppLoadContext) => Promise<Response>;
+type RequestHandler = (request: Request, loadContext?: MiddlewareEnabled extends true ? unstable_RouterContextProvider : AppLoadContext) => Promise<Response>;
 type CreateRequestHandlerFunction = (build: ServerBuild | (() => ServerBuild | Promise<ServerBuild>), mode?: string) => RequestHandler;
 declare const createRequestHandler: CreateRequestHandlerFunction;
 
@@ -1149,12 +1163,6 @@ type ToArgs<Params extends Record<string, string | undefined>> = Equal<Params, {
  */
 declare function href<Path extends keyof Args>(path: Path, ...args: Args[Path]): string;
 
-type ServerContext = {
-    redirect?: Response;
-};
-declare global {
-    var ___reactRouterServerStorage___: AsyncLocalStorage<ServerContext> | undefined;
-}
 type RSCRouteConfigEntryBase = {
     action?: ActionFunction;
     clientAction?: ClientActionFunction;
@@ -1252,8 +1260,11 @@ type DecodeReplyFunction = (reply: FormData | string, { temporaryReferences }: {
 }) => Promise<unknown[]>;
 type LoadServerActionFunction = (id: string) => Promise<Function>;
 /**
- * Matches the given routes to a Request and returns a RSC Response encoding an
- * `RSCPayload` for consumption by a RSC enabled client router.
+ * Matches the given routes to a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request)
+ * and returns an [RSC](https://react.dev/reference/rsc/server-components)
+ * [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+ * encoding an {@link unstable_RSCPayload} for consumption by an [RSC](https://react.dev/reference/rsc/server-components)
+ * enabled client router.
  *
  * @example
  * import {
@@ -1290,27 +1301,33 @@ type LoadServerActionFunction = (id: string) => Promise<Function>;
  * @mode data
  * @param opts Options
  * @param opts.basename The basename to use when matching the request.
+ * @param opts.createTemporaryReferenceSet A function that returns a temporary
+ * reference set for the request, used to track temporary references in the [RSC](https://react.dev/reference/rsc/server-components)
+ * stream.
  * @param opts.decodeAction Your `react-server-dom-xyz/server`'s `decodeAction`
  * function, responsible for loading a server action.
+ * @param opts.decodeFormState A function responsible for decoding form state for
+ * progressively enhanceable forms with React's [`useActionState`](https://react.dev/reference/react/useActionState)
+ * using your `react-server-dom-xyz/server`'s `decodeFormState`.
  * @param opts.decodeReply Your `react-server-dom-xyz/server`'s `decodeReply`
  * function, used to decode the server function's arguments and bind them to the
  * implementation for invocation by the router.
- * @param opts.decodeFormState A function responsible for decoding form state for
- * progressively enhanceable forms with `useActionState` using your
- * `react-server-dom-xyz/server`'s `decodeFormState`.
  * @param opts.generateResponse A function responsible for using your
- * `renderToReadableStream` to generate a Response encoding the `RSCPayload`.
+ * `renderToReadableStream` to generate a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+ * encoding the {@link unstable_RSCPayload}.
  * @param opts.loadServerAction Your `react-server-dom-xyz/server`'s
  * `loadServerAction` function, used to load a server action by ID.
- * @param opts.request The request to match against.
- * @param opts.requestContext An instance of `unstable_RouterContextProvider`
- * that should be created per request, to be passed to loaders, actions and middleware.
- * @param opts.routes Your route definitions.
- * @param opts.createTemporaryReferenceSet A function that returns a temporary
- * reference set for the request, used to track temporary references in the RSC stream.
  * @param opts.onError An optional error handler that will be called with any
  * errors that occur during the request processing.
- * @returns A Response that contains the RSC data for hydration.
+ * @param opts.request The [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request)
+ * to match against.
+ * @param opts.requestContext An instance of {@link unstable_RouterContextProvider}
+ * that should be created per request, to be passed to [`action`](../../start/data/route-object#action)s,
+ * [`loader`](../../start/data/route-object#loader)s and [middleware](../../how-to/middleware).
+ * @param opts.routes Your {@link unstable_RSCRouteConfigEntry | route definitions}.
+ * @returns A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+ * that contains the [RSC](https://react.dev/reference/rsc/server-components)
+ * data for hydration.
  */
 declare function matchRSCServerRequest({ createTemporaryReferenceSet, basename, decodeReply, requestContext, loadServerAction, decodeAction, decodeFormState, onError, request, routes, generateResponse, }: {
     createTemporaryReferenceSet: () => unknown;
@@ -1362,10 +1379,12 @@ type EncodeReplyFunction = (args: unknown[], options: {
  * @param opts.createFromReadableStream Your `react-server-dom-xyz/client`'s
  * `createFromReadableStream`. Used to decode payloads from the server.
  * @param opts.createTemporaryReferenceSet A function that creates a temporary
- * reference set for the RSC payload.
+ * reference set for the [RSC](https://react.dev/reference/rsc/server-components)
+ * payload.
  * @param opts.encodeReply Your `react-server-dom-xyz/client`'s `encodeReply`.
  * Used when sending payloads to the server.
- * @param opts.fetch Optional fetch implementation. Defaults to global `fetch`.
+ * @param opts.fetch Optional [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
+ * implementation. Defaults to global [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/fetch).
  * @returns A function that can be used to call server actions.
  */
 declare function createCallServer({ createFromReadableStream, createTemporaryReferenceSet, encodeReply, fetch: fetchImplementation, }: {
@@ -1375,8 +1394,10 @@ declare function createCallServer({ createFromReadableStream, createTemporaryRef
     fetch?: (request: Request) => Promise<Response>;
 }): (id: string, args: unknown[]) => Promise<unknown>;
 /**
- * Props for the `unstable_RSCHydratedRouter` component.
+ * Props for the {@link unstable_RSCHydratedRouter} component.
+ *
  * @name unstable_RSCHydratedRouterProps
+ * @category Types
  */
 interface RSCHydratedRouterProps {
     /**
@@ -1385,27 +1406,29 @@ interface RSCHydratedRouterProps {
      */
     createFromReadableStream: BrowserCreateFromReadableStreamFunction;
     /**
-     * Optional fetch implementation.  Defaults to global `fetch`.
+     * Optional fetch implementation. Defaults to global [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/fetch).
      */
     fetch?: (request: Request) => Promise<Response>;
     /**
-     * The decoded `RSCPayload` to hydrate.
+     * The decoded {@link unstable_RSCPayload} to hydrate.
      */
     payload: RSCPayload;
     /**
-     * `eager` or `lazy` - Determines if links are eagerly discovered, or delayed
-     * until clicked.
+     * `"eager"` or `"lazy"` - Determines if links are eagerly discovered, or
+     * delayed until clicked.
      */
     routeDiscovery?: "eager" | "lazy";
     /**
-     * A function that returns an `unstable_InitialContext` object
-     * (`Map<RouterContext, unknown>`), for use in client loaders, actions and
-     * middleware.
+     * A function that returns an {@link unstable_RouterContextProvider} instance
+     * which is provided as the `context` argument to client [`action`](../../start/data/route-object#action)s,
+     * [`loader`](../../start/data/route-object#loader)s and [middleware](../../how-to/middleware).
+     * This function is called to generate a fresh `context` instance on each
+     * navigation or fetcher call.
      */
     unstable_getContext?: RouterInit["unstable_getContext"];
 }
 /**
- * Hydrates a server rendered `RSCPayload` in the browser.
+ * Hydrates a server rendered {@link unstable_RSCPayload} in the browser.
  *
  * @example
  * import { startTransition, StrictMode } from "react";
@@ -1416,25 +1439,19 @@ interface RSCHydratedRouterProps {
  * } from "react-router";
  * import type { unstable_RSCPayload as RSCPayload } from "react-router";
  *
- * createFromReadableStream(getRSCStream()).then(
- *   (payload: RSCServerPayload) => {
- *     startTransition(async () => {
- *       hydrateRoot(
- *         document,
- *         <StrictMode>
- *           <RSCHydratedRouter
- *             createFromReadableStream={
- *               createFromReadableStream
- *             }
- *             payload={payload}
- *           />
- *         </StrictMode>,
- *         {
- *           formState: await getFormState(payload),
- *         }
- *       );
- *     });
- *   }
+ * createFromReadableStream(getRSCStream()).then((payload) =>
+ *   startTransition(async () => {
+ *     hydrateRoot(
+ *       document,
+ *       <StrictMode>
+ *         <RSCHydratedRouter
+ *           createFromReadableStream={createFromReadableStream}
+ *           payload={payload}
+ *         />
+ *       </StrictMode>,
+ *       { formState: await getFormState(payload) },
+ *     );
+ *   }),
  * );
  *
  * @name unstable_RSCHydratedRouter
@@ -1444,18 +1461,20 @@ interface RSCHydratedRouterProps {
  * @param props Props
  * @param {unstable_RSCHydratedRouterProps.createFromReadableStream} props.createFromReadableStream n/a
  * @param {unstable_RSCHydratedRouterProps.fetch} props.fetch n/a
+ * @param {unstable_RSCHydratedRouterProps.unstable_getContext} props.unstable_getContext n/a
  * @param {unstable_RSCHydratedRouterProps.payload} props.payload n/a
  * @param {unstable_RSCHydratedRouterProps.routeDiscovery} props.routeDiscovery n/a
- * @param {unstable_RSCHydratedRouterProps.unstable_getContext} props.unstable_getContext n/a
- * @returns A hydrated router that can be used to navigate and render routes.
+ * @returns A hydrated {@link DataRouter} that can be used to navigate and
+ * render routes.
  */
 declare function RSCHydratedRouter({ createFromReadableStream, fetch: fetchImplementation, payload, routeDiscovery, unstable_getContext, }: RSCHydratedRouterProps): React.JSX.Element;
 
 type SSRCreateFromReadableStreamFunction = (body: ReadableStream<Uint8Array>) => Promise<unknown>;
 /**
- * Routes the incoming request to the RSC server and appropriately proxies the
- * server response for data / resource requests, or renders to HTML for a document
- * request.
+ * Routes the incoming [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request)
+ * to the [RSC](https://react.dev/reference/rsc/server-components) server and
+ * appropriately proxies the server response for data / resource requests, or
+ * renders to HTML for a document request.
  *
  * @example
  * import { createFromReadableStream } from "@vitejs/plugin-rsc/ssr";
@@ -1489,15 +1508,17 @@ type SSRCreateFromReadableStreamFunction = (body: ReadableStream<Uint8Array>) =>
  * @param opts Options
  * @param opts.createFromReadableStream Your `react-server-dom-xyz/client`'s
  * `createFromReadableStream` function, used to decode payloads from the server.
- * @param opts.fetchServer A function that forwards a `Request` to the RSC handler
- * and returns a `Promise<Response>` containing a serialized `RSCPayload`.
- * @param opts.renderHTML A function that renders the `RSCPayload` to HTML, usually
- * using a `<RSCStaticRouter>`.
- * @param opts.request The request to route.
+ * @param opts.fetchServer A function that forwards a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request)
+ * to the [RSC](https://react.dev/reference/rsc/server-components) handler
+ * and returns a `Promise<Response>` containing a serialized {@link unstable_RSCPayload}.
  * @param opts.hydrate Whether to hydrate the server response with the RSC payload.
  * Defaults to `true`.
- * @returns A `Response` that either contains the RSC payload for data requests, or
- * renders the HTML for document requests.
+ * @param opts.renderHTML A function that renders the {@link unstable_RSCPayload} to
+ * HTML, usually using a {@link unstable_RSCStaticRouter | `<RSCStaticRouter>`}.
+ * @param opts.request The request to route.
+ * @returns A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+ * that either contains the [RSC](https://react.dev/reference/rsc/server-components)
+ * payload for data requests, or renders the HTML for document requests.
  */
 declare function routeRSCServerRequest({ request, fetchServer, createFromReadableStream, renderHTML, hydrate, }: {
     request: Request;
@@ -1507,19 +1528,21 @@ declare function routeRSCServerRequest({ request, fetchServer, createFromReadabl
     hydrate?: boolean;
 }): Promise<Response>;
 /**
- * Props for the `RSCStaticRouter` component.
+ * Props for the {@link unstable_RSCStaticRouter} component.
+ *
  * @name unstable_RSCStaticRouterProps
+ * @category Types
  */
 interface RSCStaticRouterProps {
     /**
-     * A function that starts decoding of the `RSCPayload`. Usually passed through
-     * from `routeRSCServerRequest`'s `renderHTML`.
+     * A function that starts decoding of the {@link unstable_RSCPayload}. Usually passed
+     * through from {@link unstable_routeRSCServerRequest}'s `renderHTML`.
      */
     getPayload: () => Promise<RSCPayload>;
 }
 /**
- * Pre-renders an `RSCPayload` to HTML. Usually used in `routeRSCServerRequest`'s
- * `renderHTML` callback.
+ * Pre-renders an {@link unstable_RSCPayload} to HTML. Usually used in
+ * {@link unstable_routeRSCServerRequest}'s `renderHTML` callback.
  *
  * @example
  * import { createFromReadableStream } from "@vitejs/plugin-rsc/ssr";
@@ -1552,7 +1575,7 @@ interface RSCStaticRouterProps {
  * @mode data
  * @param props Props
  * @param {unstable_RSCStaticRouterProps.getPayload} props.getPayload n/a
- * @returns A React component that renders the `RSCPayload` as HTML.
+ * @returns A React component that renders the {@link unstable_RSCPayload} as HTML.
  */
 declare function RSCStaticRouter({ getPayload }: RSCStaticRouterProps): React.JSX.Element | null;
 
@@ -1562,7 +1585,8 @@ declare global {
     }
 }
 /**
- * Get the prerendered RSC stream for hydration. Usually passed directly to your
+ * Get the prerendered [RSC](https://react.dev/reference/rsc/server-components)
+ * stream for hydration. Usually passed directly to your
  * `react-server-dom-xyz/client`'s `createFromReadableStream`.
  *
  * @example
@@ -1580,7 +1604,7 @@ declare global {
  *       hydrateRoot(
  *         document,
  *         <StrictMode>
- *           <RSCHydratedRouter ...props />
+ *           <RSCHydratedRouter {...props} />
  *         </StrictMode>,
  *         {
  *           // Options
@@ -1594,9 +1618,11 @@ declare global {
  * @public
  * @category RSC
  * @mode data
- * @returns A `ReadableStream` that contains the RSC data for hydration.
+ * @returns A [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream)
+ * that contains the [RSC](https://react.dev/reference/rsc/server-components)
+ * data for hydration.
  */
-declare function getRSCStream(): ReadableStream<any>;
+declare function getRSCStream(): ReadableStream;
 
 declare function RSCDefaultRootErrorBoundary({ hasRootLayout, }: {
     hasRootLayout: boolean;
@@ -1638,6 +1664,11 @@ declare function getHydrationData(state: {
     hasHydrateFallback: boolean;
 }, location: Path, basename: string | undefined, isSpaMode: boolean): HydrationState;
 
+/**
+ * @module index
+ * @mergeModuleWith react-router
+ */
+
 declare const unstable_matchRSCServerRequest: typeof matchRSCServerRequest;
 
-export { ActionFunction, AppLoadContext, Blocker, BlockerFunction, ClientActionFunction, ClientLoaderFunction, type Cookie, type CookieOptions, type CookieSignatureOptions, type CreateRequestHandlerFunction, DataRouteObject, Router as DataRouter, DataStrategyFunction, EntryContext, type FlashSessionData, HeadersFunction, HydrationState, IndexRouteObject, InitialEntry, type IsCookieFunction, type IsSessionFunction, LinksFunction, LoaderFunction, Location, MetaFunction, type NavigateFunction, NavigateOptions, Navigation, Action as NavigationType, NonIndexRouteObject, ParamParseKey, Params, PatchRoutesOnNavigationFunction, Path, PathMatch, PathPattern, RelativeRoutingType, type RequestHandler, RouteObject, RouterInit, RouterState, type RoutesTestStubProps, ServerBuild, ServerRouter, type ServerRouterProps, type Session, type SessionData, type SessionIdStorageStrategy, type SessionStorage, ShouldRevalidateFunction, To, UIMatch, AssetsManifest as UNSAFE_AssetsManifest, MiddlewareEnabled as UNSAFE_MiddlewareEnabled, RSCDefaultRootErrorBoundary as UNSAFE_RSCDefaultRootErrorBoundary, RemixErrorBoundary as UNSAFE_RemixErrorBoundary, RouteModules as UNSAFE_RouteModules, ServerMode as UNSAFE_ServerMode, SingleFetchRedirectSymbol as UNSAFE_SingleFetchRedirectSymbol, decodeViaTurboStream as UNSAFE_decodeViaTurboStream, deserializeErrors as UNSAFE_deserializeErrors, getHydrationData as UNSAFE_getHydrationData, getPatchRoutesOnNavigationFunction as UNSAFE_getPatchRoutesOnNavigationFunction, getTurboStreamSingleFetchDataStrategy as UNSAFE_getTurboStreamSingleFetchDataStrategy, useFogOFWarDiscovery as UNSAFE_useFogOFWarDiscovery, createCookie, createCookieSessionStorage, createMemorySessionStorage, createRequestHandler, createRoutesStub, createSession, createSessionStorage, href, isCookie, isSession, type BrowserCreateFromReadableStreamFunction as unstable_BrowserCreateFromReadableStreamFunction, type DecodeActionFunction as unstable_DecodeActionFunction, type DecodeFormStateFunction as unstable_DecodeFormStateFunction, type DecodeReplyFunction as unstable_DecodeReplyFunction, type EncodeReplyFunction as unstable_EncodeReplyFunction, unstable_InitialContext, type LoadServerActionFunction as unstable_LoadServerActionFunction, RSCHydratedRouter as unstable_RSCHydratedRouter, type RSCHydratedRouterProps as unstable_RSCHydratedRouterProps, type RSCManifestPayload as unstable_RSCManifestPayload, type RSCMatch as unstable_RSCMatch, type RSCPayload as unstable_RSCPayload, type RSCRenderPayload as unstable_RSCRenderPayload, type RSCRouteConfig as unstable_RSCRouteConfig, type RSCRouteConfigEntry as unstable_RSCRouteConfigEntry, type RSCRouteManifest as unstable_RSCRouteManifest, type RSCRouteMatch as unstable_RSCRouteMatch, RSCStaticRouter as unstable_RSCStaticRouter, type RSCStaticRouterProps as unstable_RSCStaticRouterProps, unstable_RouterContextProvider, type SSRCreateFromReadableStreamFunction as unstable_SSRCreateFromReadableStreamFunction, createCallServer as unstable_createCallServer, getRSCStream as unstable_getRSCStream, unstable_matchRSCServerRequest, routeRSCServerRequest as unstable_routeRSCServerRequest, setDevServerHooks as unstable_setDevServerHooks, useActionData, useAsyncError, useAsyncValue, useBlocker, useHref, useInRouterContext, useLoaderData, useLocation, useMatch, useMatches, useNavigate, useNavigation, useNavigationType, useOutlet, useOutletContext, useParams, useResolvedPath, useRevalidator, useRouteError, useRouteLoaderData, useRoutes };
+export { ActionFunction, AppLoadContext, Blocker, BlockerFunction, ClientActionFunction, ClientLoaderFunction, type Cookie, type CookieOptions, type CookieSignatureOptions, type CreateRequestHandlerFunction, DataRouteObject, Router as DataRouter, DataStrategyFunction, EntryContext, type FlashSessionData, HeadersFunction, HydrationState, IndexRouteObject, InitialEntry, type IsCookieFunction, type IsSessionFunction, LinksFunction, LoaderFunction, Location, MetaFunction, type NavigateFunction, NavigateOptions, Navigation, Action as NavigationType, NonIndexRouteObject, ParamParseKey, Params, PatchRoutesOnNavigationFunction, Path, PathMatch, PathPattern, RelativeRoutingType, type RequestHandler, RouteObject, RouterInit, RouterState, type RoutesTestStubProps, ServerBuild, ServerRouter, type ServerRouterProps, type Session, type SessionData, type SessionIdStorageStrategy, type SessionStorage, ShouldRevalidateFunction, To, UIMatch, AssetsManifest as UNSAFE_AssetsManifest, MiddlewareEnabled as UNSAFE_MiddlewareEnabled, RSCDefaultRootErrorBoundary as UNSAFE_RSCDefaultRootErrorBoundary, RemixErrorBoundary as UNSAFE_RemixErrorBoundary, RouteModules as UNSAFE_RouteModules, ServerMode as UNSAFE_ServerMode, SingleFetchRedirectSymbol as UNSAFE_SingleFetchRedirectSymbol, decodeViaTurboStream as UNSAFE_decodeViaTurboStream, deserializeErrors as UNSAFE_deserializeErrors, getHydrationData as UNSAFE_getHydrationData, getPatchRoutesOnNavigationFunction as UNSAFE_getPatchRoutesOnNavigationFunction, getTurboStreamSingleFetchDataStrategy as UNSAFE_getTurboStreamSingleFetchDataStrategy, useFogOFWarDiscovery as UNSAFE_useFogOFWarDiscovery, createCookie, createCookieSessionStorage, createMemorySessionStorage, createRequestHandler, createRoutesStub, createSession, createSessionStorage, href, isCookie, isSession, type BrowserCreateFromReadableStreamFunction as unstable_BrowserCreateFromReadableStreamFunction, type DecodeActionFunction as unstable_DecodeActionFunction, type DecodeFormStateFunction as unstable_DecodeFormStateFunction, type DecodeReplyFunction as unstable_DecodeReplyFunction, type EncodeReplyFunction as unstable_EncodeReplyFunction, type LoadServerActionFunction as unstable_LoadServerActionFunction, RSCHydratedRouter as unstable_RSCHydratedRouter, type RSCHydratedRouterProps as unstable_RSCHydratedRouterProps, type RSCManifestPayload as unstable_RSCManifestPayload, type RSCMatch as unstable_RSCMatch, type RSCPayload as unstable_RSCPayload, type RSCRenderPayload as unstable_RSCRenderPayload, type RSCRouteConfig as unstable_RSCRouteConfig, type RSCRouteConfigEntry as unstable_RSCRouteConfigEntry, type RSCRouteManifest as unstable_RSCRouteManifest, type RSCRouteMatch as unstable_RSCRouteMatch, RSCStaticRouter as unstable_RSCStaticRouter, type RSCStaticRouterProps as unstable_RSCStaticRouterProps, unstable_RouterContextProvider, type SSRCreateFromReadableStreamFunction as unstable_SSRCreateFromReadableStreamFunction, createCallServer as unstable_createCallServer, getRSCStream as unstable_getRSCStream, unstable_matchRSCServerRequest, routeRSCServerRequest as unstable_routeRSCServerRequest, setDevServerHooks as unstable_setDevServerHooks, useActionData, useAsyncError, useAsyncValue, useBlocker, useHref, useInRouterContext, useLoaderData, useLocation, useMatch, useMatches, useNavigate, useNavigation, useNavigationType, useOutlet, useOutletContext, useParams, useResolvedPath, useRevalidator, useRouteError, useRouteLoaderData, useRoutes };