react-router 8.4.0 → 8.5.1

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

@@ -1,5 +1,5 @@
 /**
- * react-router v8.4.0
+ * react-router v8.5.1
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -50,6 +50,7 @@ function hydrate(index) {
 				set(-0);
 				continue;
 		}
+		validateIndex(index, values.length);
 		if (hydrated[index]) {
 			set(hydrated[index]);
 			continue;
@@ -121,11 +122,21 @@ function hydrate(index) {
 					set(obj);
 					continue;
 				case "P":
+					validateIndex(b, values.length);
 					if (hydrated[b]) set(hydrated[index] = hydrated[b]);
 					else {
 						const d = new Deferred();
+						const promise = d.promise;
+						promise.status = "pending";
+						promise.then((value) => {
+							promise.status = "fulfilled";
+							promise.value = value;
+						}, (reason) => {
+							promise.status = "rejected";
+							promise.reason = reason;
+						});
 						deferred[b] = d;
-						set(hydrated[index] = d.promise);
+						set(hydrated[index] = promise);
 					}
 					continue;
 				case "E":
@@ -135,6 +146,7 @@ function hydrate(index) {
 					set(error);
 					continue;
 				case "Z":
+					validateIndex(b, values.length);
 					set(hydrated[index] = hydrated[b]);
 					continue;
 				default:
@@ -185,7 +197,12 @@ function hydrate(index) {
 					r[0] = k;
 				}]);
 				postRun.push(() => {
-					object[r[0]] = r[1];
+					Object.defineProperty(object, r[0], {
+						value: r[1],
+						enumerable: true,
+						configurable: true,
+						writable: true
+					});
 				});
 			}
 			set(object);
@@ -195,5 +212,8 @@ function hydrate(index) {
 	while (postRun.length > 0) postRun.pop()();
 	return result;
 }
+function validateIndex(index, length) {
+	if (!Number.isSafeInteger(index) || index < 0 || index >= length) throw new SyntaxError();
+}
 //#endregion
 export { unflatten };

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

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

package/dist/production/dom-export.d.ts

@@ -1,7 +1,8 @@
 
 import { RouterProvider, RouterProviderProps } from "./lib/dom-export/dom-router-provider.js";
+import { RouterFetch, RouterFetchContext } from "./lib/dom/ssr/single-fetch.js";
 import { DecodeActionFunction, DecodeFormStateFunction, DecodeReplyFunction, RSCManifestPayload, RSCPayload, RSCRenderPayload } from "./lib/rsc/server.rsc.js";
 import { RSCHydratedRouter, createCallServer } from "./lib/rsc/browser.js";
 import { HydratedRouter, HydratedRouterProps } from "./lib/dom-export/hydrated-router.js";
 import { getRSCStream } from "./lib/rsc/html-stream/browser.js";
-export { HydratedRouter, type HydratedRouterProps, RouterProvider, type RouterProviderProps, type DecodeActionFunction as unstable_DecodeActionFunction, type DecodeFormStateFunction as unstable_DecodeFormStateFunction, type DecodeReplyFunction as unstable_DecodeReplyFunction, RSCHydratedRouter as unstable_RSCHydratedRouter, type RSCManifestPayload as unstable_RSCManifestPayload, type RSCPayload as unstable_RSCPayload, type RSCRenderPayload as unstable_RSCRenderPayload, createCallServer as unstable_createCallServer, getRSCStream as unstable_getRSCStream };
+export { HydratedRouter, type HydratedRouterProps, RouterProvider, type RouterProviderProps, type DecodeActionFunction as unstable_DecodeActionFunction, type DecodeFormStateFunction as unstable_DecodeFormStateFunction, type DecodeReplyFunction as unstable_DecodeReplyFunction, RSCHydratedRouter as unstable_RSCHydratedRouter, type RSCManifestPayload as unstable_RSCManifestPayload, type RSCPayload as unstable_RSCPayload, type RSCRenderPayload as unstable_RSCRenderPayload, type RouterFetch as unstable_RouterFetch, type RouterFetchContext as unstable_RouterFetchContext, createCallServer as unstable_createCallServer, getRSCStream as unstable_getRSCStream };

package/dist/production/dom-export.js

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

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

@@ -1,5 +1,5 @@
 /**
- * react-router v8.4.0
+ * react-router v8.5.1
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -10,8 +10,8 @@
  */
 "use client";
 import { AwaitContextProvider } from "./lib/context.js";
-import { MemoryRouter, Navigate, Outlet, Route, Router, RouterProvider, Routes, WithComponentProps, WithErrorBoundaryProps, WithHydrateFallbackProps } from "./lib/components.js";
 import { Links, Meta } from "./lib/dom/ssr/components.js";
+import { MemoryRouter, Navigate, Outlet, Route, Router, RouterProvider, Routes, WithComponentProps, WithErrorBoundaryProps, WithHydrateFallbackProps } from "./lib/components.js";
 import { BrowserRouter, Form, HashRouter, HistoryRouter, Link, NavLink, ScrollRestoration } from "./lib/dom/lib.js";
 import { StaticRouter, StaticRouterProvider } from "./lib/dom/server.js";
 export { BrowserRouter, Form, HashRouter, Link, Links, MemoryRouter, Meta, NavLink, Navigate, Outlet, Route, Router, RouterProvider, Routes, ScrollRestoration, StaticRouter, StaticRouterProvider, AwaitContextProvider as UNSAFE_AwaitContextProvider, WithComponentProps as UNSAFE_WithComponentProps, WithErrorBoundaryProps as UNSAFE_WithErrorBoundaryProps, WithHydrateFallbackProps as UNSAFE_WithHydrateFallbackProps, HistoryRouter as unstable_HistoryRouter };

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

@@ -352,6 +352,13 @@ interface DataFunctionArgs<Context> {
    * In Framework mode, this is a normalized URL with React-Router-specific
    * implementation details removed (`.data` suffixes, `index`/`_routes` search
    * params). For the raw incoming URL, use `request.url`.
+   *
+   * This normalization preserves standard URL pathname encoding and casing.
+   * For example, a request to `/%61dmin.data` produces a `url.pathname` of
+   * `/%61dmin`. This is not a canonical representation of the matched route.
+   * For authorization, attach {@link https://reactrouter.com/how-to/middleware#authentication server middleware}
+   * to the protected route or a common ancestor instead of relying on literal
+   * pathname-prefix comparisons.
    */
   url: URL;
   /**
@@ -556,6 +563,11 @@ interface DataStrategyMatch extends RouteMatch<string, DataRouteObject> {
    */
   resolve: (handlerOverride?: (handler: (ctx?: unknown) => DataFunctionReturnValue) => DataFunctionReturnValue) => Promise<DataStrategyResult>;
 }
+/**
+ * The operation that initiated a data strategy execution. Static handler
+ * executions use `"static"`.
+ */
+type DataStrategyInitiator = "initialization" | "navigation" | "fetcher" | "revalidation" | "static";
 interface DataStrategyFunctionArgs<Context = DefaultContext> extends DataFunctionArgs<Context> {
   /**
    * Matches for this route extended with Data strategy APIs
@@ -563,8 +575,23 @@ interface DataStrategyFunctionArgs<Context = DefaultContext> extends DataFunctio
   matches: DataStrategyMatch[];
   runClientMiddleware: (cb: DataStrategyFunction<Context>) => Promise<Record<string, DataStrategyResult>>;
   /**
-   * The key of the fetcher we are calling `dataStrategy` for, otherwise `null`
-   * for navigational executions
+   * The operation that initiated this data strategy execution
+   *
+   * This field is experimental and subject to breaking changes.
+   */
+  unstable_initiator: DataStrategyInitiator;
+  /**
+   * The history action (`"PUSH"`, `"REPLACE"`, or `"POP"`) for a navigation-
+   * initiated execution, including fetchers reloaded by that navigation.
+   * `null` for initialization, fetcher, revalidation, and static executions.
+   *
+   * This field is experimental and subject to breaking changes.
+   */
+  unstable_navigationType: Action | null;
+  /**
+   * The key of the fetcher targeted by this data strategy execution, otherwise
+   * `null`. Fetchers reloaded during a navigation or revalidation retain that
+   * `unstable_initiator` while providing their key here.
    */
   fetcherKey: string | null;
 }
@@ -979,6 +1006,204 @@ type ErrorResponse = {
  */
 declare function isRouteErrorResponse(error: any): error is ErrorResponse;
 //#endregion
+//#region lib/components.d.ts
+interface AwaitResolveRenderFunction<Resolve = any> {
+  (data: Awaited<Resolve>): React.ReactNode;
+}
+/**
+ * @category Types
+ */
+interface AwaitProps<Resolve> {
+  /** Use either `resolve` or `unstable_promise`, never both. */
+  unstable_promise?: never;
+  /**
+   * When using a function, the resolved value is provided as the parameter.
+   *
+   * ```tsx [2]
+   * <Await resolve={reviewsPromise}>
+   *   {(resolvedReviews) => <Reviews items={resolvedReviews} />}
+   * </Await>
+   * ```
+   *
+   * When using React elements, {@link useAsyncValue} will provide the
+   * resolved value:
+   *
+   * ```tsx [2]
+   * <Await resolve={reviewsPromise}>
+   *   <Reviews />
+   * </Await>
+   *
+   * function Reviews() {
+   *   const resolvedReviews = useAsyncValue();
+   *   return <div>...</div>;
+   * }
+   * ```
+   */
+  children: React.ReactNode | AwaitResolveRenderFunction<Resolve>;
+  /**
+   * The error element renders instead of the `children` when the [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
+   * rejects.
+   *
+   * ```tsx
+   * <Await
+   *   errorElement={<div>Oops</div>}
+   *   resolve={reviewsPromise}
+   * >
+   *   <Reviews />
+   * </Await>
+   * ```
+   *
+   * To provide a more contextual error, you can use the {@link useAsyncError} in a
+   * child component
+   *
+   * ```tsx
+   * <Await
+   *   errorElement={<ReviewsError />}
+   *   resolve={reviewsPromise}
+   * >
+   *   <Reviews />
+   * </Await>
+   *
+   * function ReviewsError() {
+   *   const error = useAsyncError();
+   *   return <div>Error loading reviews: {error.message}</div>;
+   * }
+   * ```
+   *
+   * If you do not provide an `errorElement`, the rejected value will bubble up
+   * to the nearest route-level [`ErrorBoundary`](../../start/framework/route-module#errorboundary)
+   * and be accessible via the {@link useRouteError} hook.
+   */
+  errorElement?: React.ReactNode;
+  /**
+   * Takes a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
+   * returned from a [`loader`](../../start/framework/route-module#loader) to be
+   * resolved and rendered.
+   *
+   * ```tsx
+   * import { Await, useLoaderData } from "react-router";
+   *
+   * export async function loader() {
+   *   let reviews = getReviews(); // not awaited
+   *   let book = await getBook();
+   *   return {
+   *     book,
+   *     reviews, // this is a promise
+   *   };
+   * }
+   *
+   * export default function Book() {
+   *   const {
+   *     book,
+   *     reviews, // this is the same promise
+   *   } = useLoaderData();
+   *
+   *   return (
+   *     <div>
+   *       <h1>{book.title}</h1>
+   *       <p>{book.description}</p>
+   *       <React.Suspense fallback={<ReviewsSkeleton />}>
+   *         <Await
+   *           // and is the promise we pass to Await
+   *           resolve={reviews}
+   *         >
+   *           <Reviews />
+   *         </Await>
+   *       </React.Suspense>
+   *     </div>
+   *   );
+   * }
+   * ```
+   */
+  resolve: Resolve;
+}
+interface AwaitPromiseProps<Resolve> extends Omit<AwaitProps<Resolve>, "resolve" | "unstable_promise"> {
+  resolve?: never;
+  /**
+   * A promise (or value) to read using React's `use()` API in client components.
+   * Unlike `resolve` in client components, this accepts promise-like values
+   * without modifying the source promise.
+   *
+   * `errorElement` handles promise rejections. Errors thrown while rendering
+   * children bubble to the nearest React error boundary.
+   *
+   * ```tsx
+   * <Await unstable_promise={reviewsPromise} errorElement={<ReviewsError />}>
+   *   {(reviews) => <Reviews items={reviews} />}
+   * </Await>
+   * ```
+   *
+   * Pass exactly one of `unstable_promise` or `resolve`.
+   */
+  unstable_promise: Resolve;
+}
+/**
+ * Used to render promise values with automatic error handling.
+ *
+ * **Note:** `<Await>` expects to be rendered inside a [`<React.Suspense>`](https://react.dev/reference/react/Suspense)
+ *
+ * Pass `unstable_promise` instead of `resolve` to opt into React's
+ * [`use()`](https://react.dev/reference/react/use) implementation. With
+ * `unstable_promise`, `errorElement` handles promise rejections, while errors
+ * thrown by children bubble to the nearest React error boundary.
+ *
+ * In React Server Components, `resolve` already has this error-handling behavior:
+ * `errorElement` handles only input rejections, while child render errors
+ * propagate to the surrounding error boundary. Both props accept promise-like
+ * values without modifying the source promise. Both props treat a falsy
+ * `errorElement` as absent and propagate the rejection. Pass an empty fragment
+ * to handle a rejection without rendering any content.
+ *
+ * <docs-warning>The `unstable_promise` prop is experimental and may change in
+ * minor or patch releases.</docs-warning>
+ *
+ * @example
+ * import { Await, useLoaderData } from "react-router";
+ *
+ * export async function loader() {
+ *   // not awaited
+ *   const reviews = getReviews();
+ *   // awaited (blocks the transition)
+ *   const book = await fetch("/api/book").then((res) => res.json());
+ *   return { book, reviews };
+ * }
+ *
+ * function Book() {
+ *   const { book, reviews } = useLoaderData();
+ *   return (
+ *     <div>
+ *       <h1>{book.title}</h1>
+ *       <p>{book.description}</p>
+ *       <React.Suspense fallback={<ReviewsSkeleton />}>
+ *         <Await
+ *           resolve={reviews}
+ *           errorElement={
+ *             <div>Could not load reviews 😬</div>
+ *           }
+ *           children={(resolvedReviews) => (
+ *             <Reviews items={resolvedReviews} />
+ *           )}
+ *         />
+ *       </React.Suspense>
+ *     </div>
+ *   );
+ * }
+ *
+ * @public
+ * @category Components
+ * @mode framework
+ * @mode data
+ * @param props Props
+ * @param {AwaitProps.children} props.children n/a
+ * @param {AwaitProps.errorElement} props.errorElement n/a
+ * @param {AwaitProps.resolve} props.resolve n/a
+ * @param props.unstable_promise A promise (or value) to read using React's `use()`
+ * API in client components. Accepts promise-like values without modifying the
+ * source promise. Pass exactly one of `unstable_promise` or `resolve`.
+ * @returns React element for the rendered awaited value
+ */
+declare function Await$1<Resolve>(props: AwaitProps<Resolve> | AwaitPromiseProps<Resolve>): React.JSX.Element;
+//#endregion
 //#region lib/router/instrumentation.d.ts
 type ServerInstrumentation = {
   handler?: InstrumentRequestHandlerFunction;
@@ -1390,6 +1615,8 @@ type HydrationState = Partial<Pick<RouterState, "loaderData" | "actionData" | "e
  * Future flags to toggle new feature behavior
  */
 interface FutureConfig {
+  /** @internal Enables application-controlled Framework route discovery. */
+  unstable_customRouteDiscovery?: boolean;
   /** Enables route-pattern matching after calling `unstable_preloadRoutePattern()`. */
   unstable_routePatternMatching?: boolean;
 }
@@ -1435,6 +1662,8 @@ interface StaticHandler {
    * The set of data routes managed by this handler
    */
   dataRoutes: DataRouteObject[];
+  /** @private Estimated route metadata visits per regex match. */
+  readonly _matchCost?: number;
   /**
    * @private
    * PRIVATE - DO NOT USE
@@ -1536,6 +1765,10 @@ type BaseNavigateOptions = BaseNavigateOrFetchOptions & {
   replace?: boolean;
   state?: any;
   fromRouteId?: string;
+  /**
+   * @deprecated Use React's `<ViewTransition>` component instead. See the
+   * [migration guide](https://reactrouter.com/how-to/view-transitions).
+   */
   viewTransition?: boolean;
   mask?: To;
 };
@@ -2087,168 +2320,6 @@ type LdJsonValue = LdJsonPrimitive | LdJsonObject | LdJsonArray;
  */
 type RouteHandle = unknown;
 //#endregion
-//#region lib/components.d.ts
-interface AwaitResolveRenderFunction<Resolve = any> {
-  (data: Awaited<Resolve>): React.ReactNode;
-}
-/**
- * @category Types
- */
-interface AwaitProps<Resolve> {
-  /**
-   * When using a function, the resolved value is provided as the parameter.
-   *
-   * ```tsx [2]
-   * <Await resolve={reviewsPromise}>
-   *   {(resolvedReviews) => <Reviews items={resolvedReviews} />}
-   * </Await>
-   * ```
-   *
-   * When using React elements, {@link useAsyncValue} will provide the
-   * resolved value:
-   *
-   * ```tsx [2]
-   * <Await resolve={reviewsPromise}>
-   *   <Reviews />
-   * </Await>
-   *
-   * function Reviews() {
-   *   const resolvedReviews = useAsyncValue();
-   *   return <div>...</div>;
-   * }
-   * ```
-   */
-  children: React.ReactNode | AwaitResolveRenderFunction<Resolve>;
-  /**
-   * The error element renders instead of the `children` when the [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
-   * rejects.
-   *
-   * ```tsx
-   * <Await
-   *   errorElement={<div>Oops</div>}
-   *   resolve={reviewsPromise}
-   * >
-   *   <Reviews />
-   * </Await>
-   * ```
-   *
-   * To provide a more contextual error, you can use the {@link useAsyncError} in a
-   * child component
-   *
-   * ```tsx
-   * <Await
-   *   errorElement={<ReviewsError />}
-   *   resolve={reviewsPromise}
-   * >
-   *   <Reviews />
-   * </Await>
-   *
-   * function ReviewsError() {
-   *   const error = useAsyncError();
-   *   return <div>Error loading reviews: {error.message}</div>;
-   * }
-   * ```
-   *
-   * If you do not provide an `errorElement`, the rejected value will bubble up
-   * to the nearest route-level [`ErrorBoundary`](../../start/framework/route-module#errorboundary)
-   * and be accessible via the {@link useRouteError} hook.
-   */
-  errorElement?: React.ReactNode;
-  /**
-   * Takes a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
-   * returned from a [`loader`](../../start/framework/route-module#loader) to be
-   * resolved and rendered.
-   *
-   * ```tsx
-   * import { Await, useLoaderData } from "react-router";
-   *
-   * export async function loader() {
-   *   let reviews = getReviews(); // not awaited
-   *   let book = await getBook();
-   *   return {
-   *     book,
-   *     reviews, // this is a promise
-   *   };
-   * }
-   *
-   * export default function Book() {
-   *   const {
-   *     book,
-   *     reviews, // this is the same promise
-   *   } = useLoaderData();
-   *
-   *   return (
-   *     <div>
-   *       <h1>{book.title}</h1>
-   *       <p>{book.description}</p>
-   *       <React.Suspense fallback={<ReviewsSkeleton />}>
-   *         <Await
-   *           // and is the promise we pass to Await
-   *           resolve={reviews}
-   *         >
-   *           <Reviews />
-   *         </Await>
-   *       </React.Suspense>
-   *     </div>
-   *   );
-   * }
-   * ```
-   */
-  resolve: Resolve;
-}
-/**
- * Used to render promise values with automatic error handling.
- *
- * **Note:** `<Await>` expects to be rendered inside a [`<React.Suspense>`](https://react.dev/reference/react/Suspense)
- *
- * @example
- * import { Await, useLoaderData } from "react-router";
- *
- * export async function loader() {
- *   // not awaited
- *   const reviews = getReviews();
- *   // awaited (blocks the transition)
- *   const book = await fetch("/api/book").then((res) => res.json());
- *   return { book, reviews };
- * }
- *
- * function Book() {
- *   const { book, reviews } = useLoaderData();
- *   return (
- *     <div>
- *       <h1>{book.title}</h1>
- *       <p>{book.description}</p>
- *       <React.Suspense fallback={<ReviewsSkeleton />}>
- *         <Await
- *           resolve={reviews}
- *           errorElement={
- *             <div>Could not load reviews 😬</div>
- *           }
- *           children={(resolvedReviews) => (
- *             <Reviews items={resolvedReviews} />
- *           )}
- *         />
- *       </React.Suspense>
- *     </div>
- *   );
- * }
- *
- * @public
- * @category Components
- * @mode framework
- * @mode data
- * @param props Props
- * @param {AwaitProps.children} props.children n/a
- * @param {AwaitProps.errorElement} props.errorElement n/a
- * @param {AwaitProps.resolve} props.resolve n/a
- * @returns React element for the rendered awaited value
- */
-declare function Await$1<Resolve>({
-  children,
-  errorElement,
-  resolve
-}: AwaitProps<Resolve>): React.JSX.Element;
-//#endregion
 //#region lib/rsc/server.rsc.d.ts
 declare function getRequest(): Request;
 declare const redirect: typeof redirect$1;
@@ -2267,6 +2338,7 @@ type RSCRouteConfigEntryBase = {
   links?: LinksFunction;
   loader?: LoaderFunction;
   meta?: MetaFunction;
+  middleware?: MiddlewareFunction<any>[];
   shouldRevalidate?: ShouldRevalidateFunction;
 };
 type RSCRouteConfigEntry = RSCRouteConfigEntryBase & {
@@ -2452,7 +2524,7 @@ declare function matchRSCServerRequest({
   onError,
   request,
   routes,
-  generateResponse
+  generateResponse: encodeResponse
 }: {
   allowedActionOrigins?: string[];
   createTemporaryReferenceSet: () => unknown;