react-router 0.0.0-experimental-2a6c7bc → 0.0.0-experimental-e89ad3012

package/dist/{production/index-react-server-client-BuCmY0hu.d.mts → development/index-react-server-client-pe1TAKAq.d.mts}

@@ -1,7 +1,7 @@
-import './components-CFzgj3gZ.mjs';
+import './components-BkK38HPd.mjs';
 import * as React from 'react';
-import { az as RouteManifest, M as MiddlewareEnabled, o as unstable_RouterContextProvider, j as LoaderFunctionArgs, i as ActionFunctionArgs, J as StaticHandlerContext, H as HydrationState, z as DataRouteObject, a2 as HTMLFormMethod, a0 as FormEncType, a as RelativeRoutingType, T as To, aA as History, E as GetScrollRestorationKeyFunction, e as RouterInit, F as FutureConfig$1, D as DataStrategyFunction, P as PatchRoutesOnNavigationFunction, q as NavigateOptions, K as Fetcher, f as RouteObject, R as Router, B as BlockerFunction, c as Location, aB as CreateStaticHandlerOptions$1, C as StaticHandler } from './context-AvZz33Zq.mjs';
-import { o as ServerRouteModule, A as AppLoadContext, c as RouteModules, h as ClientLoaderFunction, m as PageLinkDescriptor, d as SerializeFrom } from './route-data-BnrIwdAP.mjs';
+import { az as RouteManifest, M as MiddlewareEnabled, o as unstable_RouterContextProvider, j as LoaderFunctionArgs, i as ActionFunctionArgs, J as StaticHandlerContext, H as HydrationState, z as DataRouteObject, a2 as HTMLFormMethod, a0 as FormEncType, a as RelativeRoutingType, T as To, aA as History, E as GetScrollRestorationKeyFunction, e as RouterInit, F as FutureConfig$1, D as DataStrategyFunction, P as PatchRoutesOnNavigationFunction, q as NavigateOptions, K as Fetcher, f as RouteObject, R as Router, B as BlockerFunction, c as Location, aB as CreateStaticHandlerOptions$1, C as StaticHandler } from './context-CphUWOpx.mjs';
+import { o as ServerRouteModule, A as AppLoadContext, c as RouteModules, h as ClientLoaderFunction, m as PageLinkDescriptor, d as SerializeFrom } from './route-data-DJXZgnJq.mjs';
 
 type ServerRouteManifest = RouteManifest<Omit<ServerRoute, "children">>;
 interface ServerRoute extends Route {
@@ -463,7 +463,7 @@ interface DOMRouterOpts {
      * [`clientLoader`](../../start/framework/route-module#clientLoader)), you may
      * want to include `loaderData` for only some routes that were loaded/rendered
      * on the server. This allows you to hydrate _some_ of the routes (such as the
-     * app layout/shell) while showing a {@link PathRouteProps.HydrateFallback | `HydrateFallback`}
+     * app layout/shell) while showing a `HydrateFallback`
      * component and running the [`loader`](../../start/data/route-object#loader)s
      * for other routes during hydration.
      *
@@ -471,8 +471,7 @@ interface DOMRouterOpts {
      * hydration in two scenarios:
      *
      *  1. No hydration data is provided
-     *     In these cases the {@link PathRouteProps.HydrateFallback | `HydrateFallback`}
-     *     component will render on initial hydration
+     *     In these cases the `HydrateFallback` component will render on initial hydration
      *  2. The `loader.hydrate` property is set to `true`
      *     This allows you to run the [`loader`](../../start/data/route-object#loader)
      *     even if you did not render a fallback on initial hydration (i.e., to
@@ -534,9 +533,9 @@ interface DOMRouterOpts {
      *
      * The `dataStrategy` function should return a key/value-object of
      * `routeId` -> {@link DataStrategyResult} and should include entries for any
-     * routes where a handler was executed. A {@link DataStrategyResult} indicates
-     * if the handler was successful or not based on the {@link DataStrategyResult.type}
-     * field. If the returned {@link DataStrategyResult.result} is a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response),
+     * routes where a handler was executed. A `DataStrategyResult` indicates
+     * if the handler was successful or not based on the `DataStrategyResult.type`
+     * field. If the returned `DataStrategyResult.result` is a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response),
      * React Router will unwrap it for you (via [`res.json`](https://developer.mozilla.org/en-US/docs/Web/API/Response/json)
      * or [`res.text`](https://developer.mozilla.org/en-US/docs/Web/API/Response/text)).
      * If you need to do custom decoding of a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
@@ -556,7 +555,7 @@ interface DOMRouterOpts {
      * let router = createBrowserRouter(routes, {
      *   async dataStrategy({ matches, request }) {
      *     const matchesToLoad = matches.filter((m) => m.shouldLoad);
-     *     const results = {};
+     *     const results: Record<string, DataStrategyResult> = {};
      *     await Promise.all(
      *       matchesToLoad.map(async (match) => {
      *         console.log(`Processing ${match.route.id}`);
@@ -730,7 +729,7 @@ interface DOMRouterOpts {
      *
      * `patchRoutesOnNavigation` will be called anytime React Router is unable to
      * match a `path`. The arguments include the `path`, any partial
-     * {@link RouteMatch | `matches`}, and a `patch` function you can call to patch
+     * `matches`, and a `patch` function you can call to patch
      * new routes into the tree at a specific location. This method is executed
      * during the `loading` portion of the navigation for `GET` requests and during
      * the `submitting` portion of the navigation for non-`GET` requests.
@@ -833,7 +832,7 @@ interface DOMRouterOpts {
      *   **Co-locating route discovery with route definition**
      *
      *   If you don't wish to perform your own pseudo-matching, you can leverage
-     *   the partial {@link RouteMatch | `matches`} array and the [`handle`](../../start/data/route-object#handle)
+     *   the partial `matches` array and the [`handle`](../../start/data/route-object#handle)
      *   field on a route to keep the children definitions co-located:
      *
      *   ```tsx
@@ -2484,4 +2483,4 @@ declare function createStaticRouter(routes: RouteObject[], context: StaticHandle
     future?: Partial<FutureConfig$1>;
 }): Router;
 
-export { type PrefetchBehavior as $, type AssetsManifest as A, type BrowserRouterProps as B, useViewTransitionState as C, type DOMRouterOpts as D, type EntryContext as E, type FutureConfig as F, type FetcherSubmitOptions as G, type HashRouterProps as H, type SubmitOptions as I, type SubmitTarget as J, createSearchParams as K, type LinkProps as L, type StaticRouterProps as M, type NavLinkProps as N, type StaticRouterProviderProps as O, type ParamKeyValuePair as P, createStaticHandler as Q, createStaticRouter as R, type ServerBuild as S, StaticRouter as T, type URLSearchParamsInit as U, StaticRouterProvider as V, Meta as W, Links as X, Scripts as Y, PrefetchPageLinks as Z, type ScriptsProps as _, type HistoryRouterProps as a, type DiscoverBehavior as a0, type HandleDataRequestFunction as a1, type HandleDocumentRequestFunction as a2, type HandleErrorFunction as a3, type ServerEntryModule as a4, FrameworkContext as a5, createClientRoutes as a6, createClientRoutesWithHMRRevalidationOptOut as a7, shouldHydrateRouteLoader as a8, useScrollRestoration as a9, type NavLinkRenderProps as b, type FetcherFormProps as c, type FormProps as d, type ScrollRestorationProps as e, type SetURLSearchParams as f, type SubmitFunction as g, type FetcherSubmitFunction as h, type FetcherWithComponents as i, createBrowserRouter as j, createHashRouter as k, BrowserRouter as l, HashRouter as m, Link as n, HistoryRouter as o, NavLink as p, Form as q, ScrollRestoration as r, useSearchParams as s, useSubmit as t, useLinkClickHandler as u, useFormAction as v, useFetcher as w, useFetchers as x, useBeforeUnload as y, usePrompt as z };
+export { type ScriptsProps as $, type AssetsManifest as A, type BrowserRouterProps as B, useViewTransitionState as C, type DOMRouterOpts as D, type EntryContext as E, type FutureConfig as F, type FetcherSubmitOptions as G, type HashRouterProps as H, type SubmitOptions as I, type SubmitTarget as J, createSearchParams as K, type LinkProps as L, type StaticRouterProps as M, type NavLinkProps as N, type StaticRouterProviderProps as O, type ParamKeyValuePair as P, createStaticHandler as Q, createStaticRouter as R, type ServerBuild as S, StaticRouter as T, type URLSearchParamsInit as U, StaticRouterProvider as V, Meta as W, Links as X, Scripts as Y, PrefetchPageLinks as Z, type LinksProps as _, type HistoryRouterProps as a, type PrefetchBehavior as a0, type DiscoverBehavior as a1, type HandleDataRequestFunction as a2, type HandleDocumentRequestFunction as a3, type HandleErrorFunction as a4, type ServerEntryModule as a5, FrameworkContext as a6, createClientRoutes as a7, createClientRoutesWithHMRRevalidationOptOut as a8, shouldHydrateRouteLoader as a9, useScrollRestoration as aa, type NavLinkRenderProps as b, type FetcherFormProps as c, type FormProps as d, type ScrollRestorationProps as e, type SetURLSearchParams as f, type SubmitFunction as g, type FetcherSubmitFunction as h, type FetcherWithComponents as i, createBrowserRouter as j, createHashRouter as k, BrowserRouter as l, HashRouter as m, Link as n, HistoryRouter as o, NavLink as p, Form as q, ScrollRestoration as r, useSearchParams as s, useSubmit as t, useLinkClickHandler as u, useFormAction as v, useFetcher as w, useFetchers as x, useBeforeUnload as y, usePrompt as z };

package/dist/development/index-react-server-client.d.mts

@@ -1,5 +1,5 @@
-export { f as Await, g as MemoryRouter, h as Navigate, i as Outlet, j as Route, k as Router, l as RouterProvider, m as Routes, W as UNSAFE_WithComponentProps, v as UNSAFE_WithErrorBoundaryProps, t as UNSAFE_WithHydrateFallbackProps } from './components-CFzgj3gZ.mjs';
-export { l as BrowserRouter, q as Form, m as HashRouter, n as Link, X as Links, W as Meta, p as NavLink, r as ScrollRestoration, T as StaticRouter, V as StaticRouterProvider, o as unstable_HistoryRouter } from './index-react-server-client-BuCmY0hu.mjs';
-import './context-AvZz33Zq.mjs';
+export { f as Await, g as MemoryRouter, h as Navigate, i as Outlet, j as Route, k as Router, l as RouterProvider, m as Routes, W as UNSAFE_WithComponentProps, v as UNSAFE_WithErrorBoundaryProps, t as UNSAFE_WithHydrateFallbackProps } from './components-BkK38HPd.mjs';
+export { l as BrowserRouter, q as Form, m as HashRouter, n as Link, X as Links, W as Meta, p as NavLink, r as ScrollRestoration, T as StaticRouter, V as StaticRouterProvider, o as unstable_HistoryRouter } from './index-react-server-client-pe1TAKAq.mjs';
+import './context-CphUWOpx.mjs';
 import 'react';
-import './route-data-BnrIwdAP.mjs';
+import './route-data-DJXZgnJq.mjs';

package/dist/development/index-react-server-client.d.ts

@@ -1,3 +1,3 @@
-export { h as Await, V as BrowserRouter, _ as Form, W as HashRouter, X as Link, am as Links, i as MemoryRouter, al as Meta, Z as NavLink, j as Navigate, k as Outlet, l as Route, m as Router, n as RouterProvider, o as Routes, $ as ScrollRestoration, aj as StaticRouter, ak as StaticRouterProvider, ay as UNSAFE_WithComponentProps, aC as UNSAFE_WithErrorBoundaryProps, aA as UNSAFE_WithHydrateFallbackProps, Y as unstable_HistoryRouter } from './index-react-server-client-DIZWnqdE.js';
-import './routeModules-BbH0xTnc.js';
+export { h as Await, V as BrowserRouter, _ as Form, W as HashRouter, X as Link, am as Links, i as MemoryRouter, al as Meta, Z as NavLink, j as Navigate, k as Outlet, l as Route, m as Router, n as RouterProvider, o as Routes, $ as ScrollRestoration, aj as StaticRouter, ak as StaticRouterProvider, az as UNSAFE_WithComponentProps, aD as UNSAFE_WithErrorBoundaryProps, aB as UNSAFE_WithHydrateFallbackProps, Y as unstable_HistoryRouter } from './index-react-server-client-D-lyvxf_.js';
+import './routeModules-DH3xUx4Z.js';
 import 'react';

package/dist/development/index-react-server-client.js

@@ -1,5 +1,5 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});/**
- * react-router v0.0.0-experimental-2a6c7bc
+ * react-router v0.0.0-experimental-e89ad3012
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -30,11 +30,11 @@
 
 
 
-var _chunkGSZ4XTPZjs = require('./chunk-GSZ4XTPZ.js');
+var _chunkROJMZUUVjs = require('./chunk-ROJMZUUV.js');
 
 
 
-var _chunkJRLTRGBEjs = require('./chunk-JRLTRGBE.js');
+var _chunkJJHCVRDZjs = require('./chunk-JJHCVRDZ.js');
 
 
 
@@ -58,4 +58,4 @@ var _chunkJRLTRGBEjs = require('./chunk-JRLTRGBE.js');
 
 
 
-exports.Await = _chunkGSZ4XTPZjs.Await; exports.BrowserRouter = _chunkGSZ4XTPZjs.BrowserRouter; exports.Form = _chunkGSZ4XTPZjs.Form; exports.HashRouter = _chunkGSZ4XTPZjs.HashRouter; exports.Link = _chunkGSZ4XTPZjs.Link; exports.Links = _chunkJRLTRGBEjs.Links; exports.MemoryRouter = _chunkGSZ4XTPZjs.MemoryRouter; exports.Meta = _chunkJRLTRGBEjs.Meta; exports.NavLink = _chunkGSZ4XTPZjs.NavLink; exports.Navigate = _chunkGSZ4XTPZjs.Navigate; exports.Outlet = _chunkGSZ4XTPZjs.Outlet; exports.Route = _chunkGSZ4XTPZjs.Route; exports.Router = _chunkGSZ4XTPZjs.Router; exports.RouterProvider = _chunkGSZ4XTPZjs.RouterProvider; exports.Routes = _chunkGSZ4XTPZjs.Routes; exports.ScrollRestoration = _chunkGSZ4XTPZjs.ScrollRestoration; exports.StaticRouter = _chunkGSZ4XTPZjs.StaticRouter; exports.StaticRouterProvider = _chunkGSZ4XTPZjs.StaticRouterProvider; exports.UNSAFE_WithComponentProps = _chunkGSZ4XTPZjs.WithComponentProps; exports.UNSAFE_WithErrorBoundaryProps = _chunkGSZ4XTPZjs.WithErrorBoundaryProps; exports.UNSAFE_WithHydrateFallbackProps = _chunkGSZ4XTPZjs.WithHydrateFallbackProps; exports.unstable_HistoryRouter = _chunkGSZ4XTPZjs.HistoryRouter;
+exports.Await = _chunkROJMZUUVjs.Await; exports.BrowserRouter = _chunkROJMZUUVjs.BrowserRouter; exports.Form = _chunkROJMZUUVjs.Form; exports.HashRouter = _chunkROJMZUUVjs.HashRouter; exports.Link = _chunkROJMZUUVjs.Link; exports.Links = _chunkJJHCVRDZjs.Links; exports.MemoryRouter = _chunkROJMZUUVjs.MemoryRouter; exports.Meta = _chunkJJHCVRDZjs.Meta; exports.NavLink = _chunkROJMZUUVjs.NavLink; exports.Navigate = _chunkROJMZUUVjs.Navigate; exports.Outlet = _chunkROJMZUUVjs.Outlet; exports.Route = _chunkROJMZUUVjs.Route; exports.Router = _chunkROJMZUUVjs.Router; exports.RouterProvider = _chunkROJMZUUVjs.RouterProvider; exports.Routes = _chunkROJMZUUVjs.Routes; exports.ScrollRestoration = _chunkROJMZUUVjs.ScrollRestoration; exports.StaticRouter = _chunkROJMZUUVjs.StaticRouter; exports.StaticRouterProvider = _chunkROJMZUUVjs.StaticRouterProvider; exports.UNSAFE_WithComponentProps = _chunkROJMZUUVjs.WithComponentProps; exports.UNSAFE_WithErrorBoundaryProps = _chunkROJMZUUVjs.WithErrorBoundaryProps; exports.UNSAFE_WithHydrateFallbackProps = _chunkROJMZUUVjs.WithHydrateFallbackProps; exports.unstable_HistoryRouter = _chunkROJMZUUVjs.HistoryRouter;

package/dist/development/index-react-server-client.mjs

@@ -1,5 +1,5 @@
 /**
- * react-router v0.0.0-experimental-2a6c7bc
+ * react-router v0.0.0-experimental-e89ad3012
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -32,7 +32,7 @@ import {
   WithComponentProps,
   WithErrorBoundaryProps,
   WithHydrateFallbackProps
-} from "./chunk-VEWXUMGM.mjs";
+} from "./chunk-3O4L5GVQ.mjs";
 export {
   Await,
   BrowserRouter,

package/dist/development/index-react-server.d.mts

@@ -227,27 +227,117 @@ type Submission = {
     json: undefined;
     text: string;
 };
+/**
+ * A context instance used as the key for the `get`/`set` methods of a
+ * {@link unstable_RouterContextProvider}. Accepts an optional default
+ * value to be returned if no value has been set.
+ */
 interface unstable_RouterContext<T = unknown> {
     defaultValue?: T;
 }
 /**
- * Creates a context object that may be used to store and retrieve arbitrary values.
+ * Creates a type-safe context object that can be used to store and retrieve
+ * values in middleware, [loaders](../../start/framework/route-module#loader),
+ * and [actions](../../start/framework/route-module#action). Similar to React's
+ * [`createContext`](https://react.dev/reference/react/createContext), but
+ * designed for React Router's request/response lifecycle.
+ *
+ * If a `defaultValue` is provided, it will be returned from `context.get()` when
+ * no value has been set for the context. Otherwise reading this context when no
+ * value has been set will throw an error.
  *
- * If a `defaultValue` is provided, it will be returned from `context.get()` when no value has been
- * set for the context. Otherwise reading this context when no value has been set will throw an
- * error.
+ * ```tsx filename=app/context.ts
+ * import { unstable_createContext } from "react-router";
+ *
+ * // Create a context for user data
+ * export const userContext =
+ *   unstable_createContext<User | null>(null);
+ * ```
+ *
+ * ```tsx filename=app/middleware/auth.ts
+ * import { userContext } from "~/context";
+ * import { getUserFromSession } from "~/auth.server";
+ *
+ * export const authMiddleware = async ({
+ *   request,
+ *   context,
+ * }) => {
+ *   const user = await getUserFromSession(request);
+ *   context.set(userContext, user);
+ * };
+ * ```
  *
- * @param defaultValue The default value for the context
- * @returns A context object
+ * ```tsx filename=app/routes/profile.tsx
+ * import { userContext } from "~/context";
+ *
+ * export async function loader({
+ *   context,
+ * }: Route.LoaderArgs) {
+ *   const user = context.get(userContext);
+ *
+ *   if (!user) {
+ *     throw new Response("Unauthorized", { status: 401 });
+ *   }
+ *
+ *   return { user };
+ * }
+ * ```
+ *
+ * @public
+ * @category Utils
+ * @mode framework
+ * @mode data
+ * @param defaultValue An optional default value for the context. This value will
+ * be returned if no value has been set for this context.
+ * @returns A {@link unstable_RouterContext} object that can be used with
+ * `context.get()` and `context.set()` in middleware, loaders, and actions.
  */
 declare function unstable_createContext<T>(defaultValue?: T): unstable_RouterContext<T>;
 /**
- * Provides methods for writing/reading values in application context in a typesafe way.
+ * Provides methods for writing/reading values in application context in a
+ * type-safe way.  Primarily for usage with [Middleware](../../how-to/middleware).
+ *
+ * @example
+ * import {
+ *   unstable_createContext,
+ *   unstable_RouterContextProvider
+ * } from "react-router";
+ *
+ * const userContext = unstable_createContext<User | null>(null);
+ * const contextProvider = new unstable_RouterContextProvider();
+ * contextProvider.set(userContext, getUser());
+ * const user = contextProvider.get(userContext);
+ * //    ^ User
+ *
+ * @public
+ * @category Utils
+ * @mode framework
+ * @mode data
  */
 declare class unstable_RouterContextProvider {
     #private;
+    /**
+     * Create a new `unstable_RouterContextProvider` instance
+     * @param init An optional initial context map to populate the provider with
+     */
     constructor(init?: Map<unstable_RouterContext, unknown>);
+    /**
+     * Access a value from the context. If no value has been set for the
+     * context, it will return the context's `defaultValue` if provided, or throw an
+     * error if no `defaultValue` was set.
+     * @param context The context to get the value for
+     * @returns The value for the context, or the contexts `defaultValue` if no
+     * value was set
+     */
     get<T>(context: unstable_RouterContext<T>): T;
+    /**
+     * Set a value for the context. If the context already has a value set,
+     * this will overwrite it.
+     *
+     * @param context The context to set the value for
+     * @param value The value to set for the context
+     * @returns {void}
+     */
     set<C extends unstable_RouterContext>(context: C, value: C extends unstable_RouterContext<infer T> ? T : never): void;
 }
 type DefaultContext = MiddlewareEnabled extends true ? Readonly<unstable_RouterContextProvider> : any;
@@ -272,7 +362,7 @@ interface DataFunctionArgs<Context> {
      *   params.teamId;
      *   //        ^ string
      * }
-     **/
+     */
     params: Params;
     /**
      * This is the context passed in to your server adapter's getLoadContext() function.
@@ -587,7 +677,27 @@ interface AgnosticDataRouteMatch extends AgnosticRouteMatch<string, AgnosticData
 /**
  * Matches the given routes to a location and returns the match data.
  *
+ * @example
+ * import { matchRoutes } from "react-router";
+ *
+ * let routes = [{
+ *   path: "/",
+ *   Component: Root,
+ *   children: [{
+ *     path: "dashboard",
+ *     Component: Dashboard,
+ *   }]
+ * }];
+ *
+ * matchRoutes(routes, "/dashboard"); // [rootMatch, dashboardMatch]
+ *
+ * @public
  * @category Utils
+ * @param routes The array of route objects to match against.
+ * @param locationArg The location to match against, either a string path or a
+ * partial {@link Location} object
+ * @param basename Optional base path to strip from the location before matching.
+ * @returns An array of matched routes, or `null` if no matches were found.
  */
 declare function matchRoutes<RouteObjectType extends AgnosticRouteObject = AgnosticRouteObject>(routes: RouteObjectType[], locationArg: Partial<Location> | string, basename?: string): AgnosticRouteMatch<string, RouteObjectType>[] | null;
 interface UIMatch<Data = unknown, Handle = unknown> {
@@ -595,7 +705,7 @@ interface UIMatch<Data = unknown, Handle = unknown> {
     pathname: string;
     /**
      * {@link https://reactrouter.com/start/framework/routing#dynamic-segments Dynamic route params} for the matched route.
-     **/
+     */
     params: AgnosticRouteMatch["params"];
     /**
      * The return value from the matched route's loader or clientLoader
@@ -616,9 +726,29 @@ declare class DataWithResponseInit<D> {
 }
 /**
  * Create "responses" that contain `status`/`headers` without forcing
- * serialization into an actual `Response` - used by Remix single fetch
+ * serialization into an actual `Response`
  *
+ * @example
+ * import { data } from "react-router";
+ *
+ * export async function action({ request }) {
+ *   let formData = await request.formData();
+ *   let item = await createItem(formData);
+ *   return data(item, {
+ *     status: 201,
+ *     headers: { "X-Custom-Header": "value" }
+ *   });
+ * }
+ *
+ * @public
  * @category Utils
+ * @mode framework
+ * @mode data
+ * @param data The data to be included in the response.
+ * @param init The status code or a `ResponseInit` object to be included in the
+ * response.
+ * @returns A `DataWithResponseInit` instance containing the data and response
+ * init.
  */
 declare function data<D>(data: D, init?: number | ResponseInit): DataWithResponseInit<D>;
 type RedirectFunction = (url: string, init?: number | ResponseInit) => Response;
@@ -626,7 +756,25 @@ type RedirectFunction = (url: string, init?: number | ResponseInit) => Response;
  * A redirect response. Sets the status code and the `Location` header.
  * Defaults to "302 Found".
  *
+ * @example
+ * import { redirect } from "react-router";
+ *
+ * export function loader({ request }) {
+ *   if (!isLoggedIn(request))
+ *     throw redirect("/login");
+ *   }
+ *
+ *   // ...
+ * }
+ *
+ * @public
  * @category Utils
+ * @mode framework
+ * @mode data
+ * @param url The URL to redirect to.
+ * @param init The status code or a `ResponseInit` object to be included in the
+ * response.
+ * @returns A `Response` object with the redirect status and `Location` header.
  */
 declare const redirect$1: RedirectFunction;
 /**
@@ -634,7 +782,26 @@ declare const redirect$1: RedirectFunction;
  * Sets the status code and the `Location` header.
  * Defaults to "302 Found".
  *
+ * @example
+ * // routes/logout.tsx
+ * import { redirectDocument } from "react-router";
+ * import { destroySession } from "../sessions.server";
+ *
+ * export async function action({ request }) {
+ *   let session = await getSession(request.headers.get("Cookie"));
+ *   return redirectDocument("/", {
+ *     headers: { "Set-Cookie": await destroySession(session) }
+ *   });
+ * }
+ *
+ * @public
  * @category Utils
+ * @mode framework
+ * @mode data
+ * @param url The URL to redirect to.
+ * @param init The status code or a `ResponseInit` object to be included in the
+ * response.
+ * @returns A `Response` object with the redirect status and `Location` header.
  */
 declare const redirectDocument$1: RedirectFunction;
 /**
@@ -643,7 +810,21 @@ declare const redirectDocument$1: RedirectFunction;
  * Sets the status code and the `Location` header.
  * Defaults to "302 Found".
  *
+ * @example
+ * import { replace } from "react-router";
+ *
+ * export function loader() {
+ *   return replace("/new-location");
+ * }
+ *
+ * @public
  * @category Utils
+ * @mode framework
+ * @mode data
+ * @param url The URL to redirect to.
+ * @param init The status code or a `ResponseInit` object to be included in the
+ * response.
+ * @returns A `Response` object with the redirect status and `Location` header.
  */
 declare const replace$1: RedirectFunction;
 
@@ -956,15 +1137,13 @@ interface StaticHandler {
         skipLoaderErrorBubbling?: boolean;
         skipRevalidation?: boolean;
         dataStrategy?: DataStrategyFunction<unknown>;
-        unstable_respond?: (staticContext: StaticHandlerContext) => MaybePromise<Response>;
-        unstable_stream?: (context: unstable_RouterContextProvider, query: (r: Request) => Promise<StaticHandlerContext | Response>) => MaybePromise<Response>;
+        unstable_generateMiddlewareResponse?: (query: (r: Request) => Promise<StaticHandlerContext | Response>) => MaybePromise<Response>;
     }): Promise<StaticHandlerContext | Response>;
     queryRoute(request: Request, opts?: {
         routeId?: string;
         requestContext?: unknown;
         dataStrategy?: DataStrategyFunction<unknown>;
-        unstable_respond?: (res: Response) => MaybePromise<Response>;
-        unstable_stream?: (context: unstable_RouterContextProvider, queryRoute: (r: Request) => Promise<Response>) => MaybePromise<Response>;
+        unstable_generateMiddlewareResponse?: (queryRoute: (r: Request) => Promise<Response>) => MaybePromise<Response>;
     }): Promise<any>;
 }
 type ViewTransitionOpts = {