react-router 8.1.0 → 8.3.0

package/dist/development/lib/server-runtime/entry.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/server-runtime/errors.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/server-runtime/headers.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/server-runtime/invariant.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/server-runtime/mode.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/server-runtime/routeMatching.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/server-runtime/routes.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/server-runtime/server.d.ts

@@ -5,6 +5,18 @@ import { ServerBuild } from "./build.js";
 //#region lib/server-runtime/server.d.ts
 type RequestHandler = (request: Request, loadContext?: RouterContextProvider) => Promise<Response>;
 type CreateRequestHandlerFunction = (build: ServerBuild | (() => ServerBuild | Promise<ServerBuild>), mode?: string) => RequestHandler;
+/**
+ * Creates a request handler for a React Router server build.
+ *
+ * This is a low-level API used by server adapters to translate incoming
+ * requests into React Router responses.
+ *
+ * @category Utils
+ * @param build The server build, or a function that resolves to the server
+ * build, used to handle requests.
+ * @param mode The mode in which the server build is running.
+ * @returns A request handler that returns a response for each incoming request.
+ */
 declare const createRequestHandler: CreateRequestHandlerFunction;
 //#endregion
 export { CreateRequestHandlerFunction, RequestHandler, createRequestHandler };

package/dist/development/lib/server-runtime/server.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -137,6 +137,18 @@ function derive(build, mode) {
 		requestHandler
 	};
 }
+/**
+* Creates a request handler for a React Router server build.
+*
+* This is a low-level API used by server adapters to translate incoming
+* requests into React Router responses.
+*
+* @category Utils
+* @param build The server build, or a function that resolves to the server
+* build, used to handle requests.
+* @param mode The mode in which the server build is running.
+* @returns A request handler that returns a response for each incoming request.
+*/
 const createRequestHandler = (build, mode) => {
 	let _build;
 	let serverMode;

package/dist/development/lib/server-runtime/serverHandoff.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/server-runtime/sessions/cookieStorage.d.ts

@@ -17,6 +17,14 @@ interface CookieSessionStorageOptions {
  * needed, and can help to simplify some load-balanced scenarios. However, it
  * also has the limitation that serialized session data may not exceed the
  * browser's maximum cookie size. Trade-offs!
+ *
+ * @public
+ * @category Utils
+ * @mode framework
+ * @mode data
+ * @param options Options for creating the cookie-backed session storage.
+ * @returns A {@link SessionStorage} object that stores all session data in its
+ * cookie.
  */
 declare function createCookieSessionStorage<Data = SessionData, FlashData = Data>({
   cookie: cookieArg

package/dist/development/lib/server-runtime/sessions/cookieStorage.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -19,6 +19,14 @@ import { createSession, warnOnceAboutSigningSessionCookie } from "../sessions.js
 * needed, and can help to simplify some load-balanced scenarios. However, it
 * also has the limitation that serialized session data may not exceed the
 * browser's maximum cookie size. Trade-offs!
+*
+* @public
+* @category Utils
+* @mode framework
+* @mode data
+* @param options Options for creating the cookie-backed session storage.
+* @returns A {@link SessionStorage} object that stores all session data in its
+* cookie.
 */
 function createCookieSessionStorage({ cookie: cookieArg } = {}) {
 	let cookie = isCookie(cookieArg) ? cookieArg : createCookie(cookieArg?.name || "__session", cookieArg);

package/dist/development/lib/server-runtime/sessions/memoryStorage.d.ts

@@ -10,11 +10,17 @@ interface MemorySessionStorageOptions {
   cookie?: SessionIdStorageStrategy["cookie"];
 }
 /**
- * Creates and returns a simple in-memory SessionStorage object, mostly useful
- * for testing and as a reference implementation.
+ * Creates and returns a simple in-memory SessionStorage object.
  *
- * Note: This storage does not scale beyond a single process, so it is not
- * suitable for most production scenarios.
+ * Intended for local development and testing. It does not scale beyond a single
+ * process, and all session data is lost when the server process stops/restarts.
+ *
+ * @public
+ * @category Utils
+ * @mode framework
+ * @mode data
+ * @param options Options for creating the in-memory session storage.
+ * @returns A {@link SessionStorage} object that stores session data in memory.
  */
 declare function createMemorySessionStorage<Data = SessionData, FlashData = Data>({
   cookie

package/dist/development/lib/server-runtime/sessions/memoryStorage.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -11,18 +11,24 @@
 import { createSessionStorage } from "../sessions.js";
 //#region lib/server-runtime/sessions/memoryStorage.ts
 /**
-* Creates and returns a simple in-memory SessionStorage object, mostly useful
-* for testing and as a reference implementation.
+* Creates and returns a simple in-memory SessionStorage object.
 *
-* Note: This storage does not scale beyond a single process, so it is not
-* suitable for most production scenarios.
+* Intended for local development and testing. It does not scale beyond a single
+* process, and all session data is lost when the server process stops/restarts.
+*
+* @public
+* @category Utils
+* @mode framework
+* @mode data
+* @param options Options for creating the in-memory session storage.
+* @returns A {@link SessionStorage} object that stores session data in memory.
 */
 function createMemorySessionStorage({ cookie } = {}) {
 	let map = /* @__PURE__ */ new Map();
 	return createSessionStorage({
 		cookie,
 		async createData(data, expires) {
-			let id = Math.random().toString(36).substring(2, 10);
+			let id = crypto.randomUUID();
 			map.set(id, {
 				data,
 				expires

package/dist/development/lib/server-runtime/sessions.d.ts

@@ -60,13 +60,37 @@ type CreateSessionFunction = <Data = SessionData, FlashData = Data>(initialData?
  *
  * Note: This function is typically not invoked directly by application code.
  * Instead, use a `SessionStorage` object's `getSession` method.
+ *
+ * @category Utils
+ * @param initialData The initial data for the session.
+ * @param id The identifier for the session. Defaults to an empty string for a
+ * new session.
+ * @returns A new {@link Session} object.
  */
 declare const createSession: CreateSessionFunction;
+/**
+ * A function that determines whether a value is a React Router {@link Session}
+ * object.
+ *
+ * @public
+ * @category Utils
+ * @mode framework
+ * @mode data
+ * @param object The value to check.
+ * @returns `true` if the value is a React Router {@link Session} object;
+ * otherwise, `false`.
+ */
 type IsSessionFunction = (object: any) => object is Session;
 /**
- * Returns true if an object is a React Router session.
+ * Returns `true` if a value is a React Router {@link Session} object.
  *
- * @see https://reactrouter.com/api/utils/isSession
+ * @public
+ * @category Utils
+ * @mode framework
+ * @mode data
+ * @param object The value to check.
+ * @returns `true` if the value is a React Router {@link Session} object;
+ * otherwise, `false`.
  */
 declare const isSession: IsSessionFunction;
 /**
@@ -133,6 +157,11 @@ interface SessionIdStorageStrategy<Data = SessionData, FlashData = Data> {
  *
  * Note: This is a low-level API that should only be used if none of the
  * existing session storage options meet your requirements.
+ *
+ * @category Utils
+ * @param strategy The strategy used to store session identifiers and data.
+ * @returns A {@link SessionStorage} object that persists session data using the
+ * provided strategy.
  */
 declare function createSessionStorage<Data = SessionData, FlashData = Data>({
   cookie: cookieArg,

package/dist/development/lib/server-runtime/sessions.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -19,6 +19,12 @@ function flash(name) {
 *
 * Note: This function is typically not invoked directly by application code.
 * Instead, use a `SessionStorage` object's `getSession` method.
+*
+* @category Utils
+* @param initialData The initial data for the session.
+* @param id The identifier for the session. Defaults to an empty string for a
+* new session.
+* @returns A new {@link Session} object.
 */
 const createSession = (initialData = {}, id = "") => {
 	let map = new Map(Object.entries(initialData));
@@ -53,9 +59,15 @@ const createSession = (initialData = {}, id = "") => {
 	};
 };
 /**
-* Returns true if an object is a React Router session.
+* Returns `true` if a value is a React Router {@link Session} object.
 *
-* @see https://reactrouter.com/api/utils/isSession
+* @public
+* @category Utils
+* @mode framework
+* @mode data
+* @param object The value to check.
+* @returns `true` if the value is a React Router {@link Session} object;
+* otherwise, `false`.
 */
 const isSession = (object) => {
 	return object != null && typeof object.id === "string" && typeof object.data !== "undefined" && typeof object.has === "function" && typeof object.get === "function" && typeof object.set === "function" && typeof object.flash === "function" && typeof object.unset === "function";
@@ -65,6 +77,11 @@ const isSession = (object) => {
 *
 * Note: This is a low-level API that should only be used if none of the
 * existing session storage options meet your requirements.
+*
+* @category Utils
+* @param strategy The strategy used to store session identifiers and data.
+* @returns A {@link SessionStorage} object that persists session data using the
+* provided strategy.
 */
 function createSessionStorage({ cookie: cookieArg, createData, readData, updateData, deleteData }) {
 	let cookie = isCookie(cookieArg) ? cookieArg : createCookie(cookieArg?.name || "__session", cookieArg);

package/dist/development/lib/server-runtime/single-fetch.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/server-runtime/urls.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/server-runtime/warnings.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/types/internal.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/vendor/turbo-stream-v2/flatten.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/vendor/turbo-stream-v2/turbo-stream.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/vendor/turbo-stream-v2/unflatten.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/vendor/turbo-stream-v2/utils.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/production/dom-export.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

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

@@ -1,5 +1,5 @@
 /**
- * react-router v8.1.0
+ * react-router v8.3.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/production/index-react-server.d.ts

@@ -2,6 +2,7 @@
 import * as React from "react";
 import { CookieParseOptions, CookieParseOptions as CookieParseOptions$1, CookieSerializeOptions, CookieSerializeOptions as CookieSerializeOptions$1 } from "cookie-es";
 import { BrowserRouter, Form, HashRouter, Link, Links, MemoryRouter, Meta, NavLink, Navigate, Outlet, Route, Router, RouterProvider, Routes, ScrollRestoration, StaticRouter, StaticRouterProvider, unstable_HistoryRouter } from "react-router/internal/react-server-client";
+import { ReactFormState } from "react-dom/client";
 
 //#region lib/router/history.d.ts
 /**
@@ -2317,14 +2318,14 @@ type RSCRenderPayload = {
   type: "render";
   actionData: Record<string, any> | null;
   basename: string | undefined;
+  clientVersion?: string;
   errors: Record<string, any> | null;
   loaderData: Record<string, any>;
   location: Location;
   routeDiscovery: RouteDiscovery;
   matches: RSCRouteMatch[];
   patches?: Promise<RSCRouteManifest[]>;
-  nonce?: string;
-  formState?: unknown;
+  formState?: ReactFormState;
 };
 type RSCManifestPayload = {
   type: "manifest";
@@ -2350,7 +2351,7 @@ type RSCMatch = {
   payload: RSCPayload;
 };
 type DecodeActionFunction = (formData: FormData) => Promise<() => Promise<unknown>>;
-type DecodeFormStateFunction = (result: unknown, formData: FormData) => unknown;
+type DecodeFormStateFunction = (result: unknown, formData: FormData) => Promise<ReactFormState | undefined>;
 type DecodeReplyFunction = (reply: FormData | string, options: {
   temporaryReferences: unknown;
 }) => Promise<unknown[]>;
@@ -2420,6 +2421,8 @@ type RouteDiscovery = {
  * 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.clientVersion A version derived from the client build output used
+ * to detect stale clients during lazy route discovery.
  * @param opts.onError An optional error handler that will be called with any
  * errors that occur during the request processing.
  * @param opts.request The [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request)
@@ -2443,6 +2446,7 @@ declare function matchRSCServerRequest({
   loadServerAction,
   decodeAction,
   decodeFormState,
+  clientVersion,
   onError,
   request,
   routes,
@@ -2456,6 +2460,7 @@ declare function matchRSCServerRequest({
   decodeFormState?: DecodeFormStateFunction;
   requestContext?: RouterContextProvider;
   loadServerAction?: LoadServerActionFunction;
+  clientVersion?: string;
   onError?: (error: unknown) => void;
   request: Request;
   routes: RSCRouteConfigEntry[];
@@ -2489,14 +2494,30 @@ type Pages = Register extends {
 type Args = { [K in keyof Pages]: ToArgs<Pages[K]["params"]> };
 type ToArgs<Params extends Record<string, string | undefined>> = Equal<Params, {}> extends true ? [] : Partial<Params> extends Params ? [Params] | [] : [Params];
 /**
-  Returns a resolved URL path for the specified route.
-
-  ```tsx
-  const h = href("/:lang?/about", { lang: "en" })
-  // -> `/en/about`
-
-  <Link to={href("/products/:id", { id: "abc123" })} />
-  ```
+ * Returns a resolved URL path for the specified route.
+ *
+ * Param values are percent-encoded for use in a path segment: characters that
+ * would change the URL structure (`/`, `?`, `#`, `%`, whitespace, non-ASCII)
+ * are escaped, while characters that RFC 3986 allows literally in a path
+ * segment (`$ & + , ; = : @`) are kept as-is. Note this differs from query-string
+ * encoding (`encodeURIComponent`/`URLSearchParams`), where those characters are
+ * delimiters and must be escaped. Splat (`*`) values are encoded per segment,
+ * preserving `/` separators.
+ *
+ * See [RFC 3986 §3.3](https://datatracker.ietf.org/doc/html/rfc3986#section-3.3)
+ *
+ * @example
+ * const h = href("/:lang?/about", { lang: "en" })
+ * // -> `/en/about`
+ *
+ * <Link to={href("/products/:id", { id: "abc123" })} />
+ *
+ * @public
+ * @category Utils
+ * @mode framework
+ * @param path The route path to resolve
+ * @param args The route params to use when resolving the path
+ * @returns The resolved URL path
  */
 declare function href<Path extends keyof Args>(path: Path, ...args: Args[Path]): string;
 //#endregion
@@ -2552,13 +2573,39 @@ interface Cookie {
 }
 /**
  * Creates a logical container for managing a browser cookie from the server.
+ *
+ * @public
+ * @category Utils
+ * @mode framework
+ * @mode data
+ * @param name The name of the cookie.
+ * @param cookieOptions Options for parsing and serializing the cookie.
+ * @returns A {@link Cookie} object for parsing and serializing the cookie.
  */
 declare const createCookie: (name: string, cookieOptions?: CookieOptions) => Cookie;
+/**
+ * A function that determines whether a value is a React Router {@link Cookie}
+ * object.
+ *
+ * @public
+ * @category Utils
+ * @mode framework
+ * @mode data
+ * @param object The value to check.
+ * @returns `true` if the value is a React Router {@link Cookie} object;
+ * otherwise, `false`.
+ */
 type IsCookieFunction = (object: any) => object is Cookie;
 /**
- * Returns true if an object is a Remix cookie container.
+ * Returns `true` if a value is a React Router {@link Cookie} object.
  *
- * @see https://remix.run/utils/cookies#iscookie
+ * @public
+ * @category Utils
+ * @mode framework
+ * @mode data
+ * @param object The value to check.
+ * @returns `true` if the value is a React Router {@link Cookie} object;
+ * otherwise, `false`.
  */
 declare const isCookie: IsCookieFunction;
 //#endregion
@@ -2620,13 +2667,37 @@ type CreateSessionFunction = <Data = SessionData, FlashData = Data>(initialData?
  *
  * Note: This function is typically not invoked directly by application code.
  * Instead, use a `SessionStorage` object's `getSession` method.
+ *
+ * @category Utils
+ * @param initialData The initial data for the session.
+ * @param id The identifier for the session. Defaults to an empty string for a
+ * new session.
+ * @returns A new {@link Session} object.
  */
 declare const createSession: CreateSessionFunction;
+/**
+ * A function that determines whether a value is a React Router {@link Session}
+ * object.
+ *
+ * @public
+ * @category Utils
+ * @mode framework
+ * @mode data
+ * @param object The value to check.
+ * @returns `true` if the value is a React Router {@link Session} object;
+ * otherwise, `false`.
+ */
 type IsSessionFunction = (object: any) => object is Session;
 /**
- * Returns true if an object is a React Router session.
+ * Returns `true` if a value is a React Router {@link Session} object.
  *
- * @see https://reactrouter.com/api/utils/isSession
+ * @public
+ * @category Utils
+ * @mode framework
+ * @mode data
+ * @param object The value to check.
+ * @returns `true` if the value is a React Router {@link Session} object;
+ * otherwise, `false`.
  */
 declare const isSession: IsSessionFunction;
 /**
@@ -2693,6 +2764,11 @@ interface SessionIdStorageStrategy<Data = SessionData, FlashData = Data> {
  *
  * Note: This is a low-level API that should only be used if none of the
  * existing session storage options meet your requirements.
+ *
+ * @category Utils
+ * @param strategy The strategy used to store session identifiers and data.
+ * @returns A {@link SessionStorage} object that persists session data using the
+ * provided strategy.
  */
 declare function createSessionStorage<Data = SessionData, FlashData = Data>({
   cookie: cookieArg,
@@ -2718,6 +2794,14 @@ interface CookieSessionStorageOptions {
  * needed, and can help to simplify some load-balanced scenarios. However, it
  * also has the limitation that serialized session data may not exceed the
  * browser's maximum cookie size. Trade-offs!
+ *
+ * @public
+ * @category Utils
+ * @mode framework
+ * @mode data
+ * @param options Options for creating the cookie-backed session storage.
+ * @returns A {@link SessionStorage} object that stores all session data in its
+ * cookie.
  */
 declare function createCookieSessionStorage<Data = SessionData, FlashData = Data>({
   cookie: cookieArg
@@ -2732,11 +2816,17 @@ interface MemorySessionStorageOptions {
   cookie?: SessionIdStorageStrategy["cookie"];
 }
 /**
- * Creates and returns a simple in-memory SessionStorage object, mostly useful
- * for testing and as a reference implementation.
+ * Creates and returns a simple in-memory SessionStorage object.
+ *
+ * Intended for local development and testing. It does not scale beyond a single
+ * process, and all session data is lost when the server process stops/restarts.
  *
- * Note: This storage does not scale beyond a single process, so it is not
- * suitable for most production scenarios.
+ * @public
+ * @category Utils
+ * @mode framework
+ * @mode data
+ * @param options Options for creating the in-memory session storage.
+ * @returns A {@link SessionStorage} object that stores session data in memory.
  */
 declare function createMemorySessionStorage<Data = SessionData, FlashData = Data>({
   cookie