react-router 8.3.0 → 8.4.0

package/CHANGELOG.md

@@ -1,5 +1,50 @@
 # `react-router`
 
+## v8.4.0
+
+### Minor Changes
+
+- Deprecate the `createStaticRouter({ branches })` option ([#15297](https://github.com/remix-run/react-router/pull/15297))
+  - `createStaticRouter` now caches route branches internally, ignores `branches`, and logs a deprecation warning when the option is provided
+  - The deprecated `EntryContext.branches` property remains available for compatibility but is always an empty array
+
+### Patch Changes
+
+- Prevent stale route discovery during manifest version-mismatch recovery ([#15489](https://github.com/remix-run/react-router/pull/15489))
+  - Keep concurrent manifest responses pending while a document reload is in progress
+  - Report a discovery error when a previous reload failed to resolve a version mismatch instead of loading a stale route or reloading repeatedly
+  - Fail pending requests if a document reload does not complete within five seconds or the document is restored from the back-forward cache, allowing subsequent requests to recover
+- Preserve lazy route module import errors during SPA navigations instead of replacing them with a missing `dataStrategy` result error ([#15464](https://github.com/remix-run/react-router/pull/15464))
+- Switch to more granular internal router contexts to avoid unnecessary route component re-renders when unrelated data router state changes ([#15376](https://github.com/remix-run/react-router/pull/15376))
+  - ⚠️ This contains some breaking changes to exported `UNSAFE_` contexts, so please review carefully if you are using those unsafe exports
+- Correctly escape streamed RSC redirect locations in meta tag attributes ([#15491](https://github.com/remix-run/react-router/pull/15491))
+- Avoid unintended `document.startViewTransition` calls during initial hydration and `router.revalidate()` calls ([#15484](https://github.com/remix-run/react-router/pull/15484))
+- Fix `SingleFetchNoResultError` thrown when a fetcher revalidates against a splat route during lazy route discovery ([#15395](https://github.com/remix-run/react-router/pull/15395))
+  - Track discovery per fetcher load so revalidation waits for the current load's discovery, even when the fetcher key is reused, while still restarting interrupted loaders after discovery completes
+- Preserve the underlying decode failure as the `cause` of the `Unable to decode turbo-stream response` error ([#15450](https://github.com/remix-run/react-router/pull/15450))
+
+### Unstable Changes
+
+⚠️  _[Unstable features](https://reactrouter.com/community/api-development-strategy#unstable-flags) are not recommended for production use_
+
+- Add a Data Mode `future.unstable_routePatternMatching` flag for more efficient route matching powered by `@remix-run/route-pattern` ([#15298](https://github.com/remix-run/react-router/pull/15298))
+  - Add an `unstable_validateParams` route field to reject invalid parameter values and continue matching
+- Document access control requirements for RSC Server Functions ([#15490](https://github.com/remix-run/react-router/pull/15490))
+  - Treat every Server Function as a public endpoint that must perform all of its own access control checks
+  - Recommend route actions when access control should be provided by route middleware
+
+## v8.3.1
+
+### Patch Changes
+
+- Fix `Expected fetcher: <key>` error thrown on navigation when a fetcher is aborted during its post-action revalidation ([#15365](https://github.com/remix-run/react-router/pull/15365))
+- Fix lazy route discovery caching a path as discovered when the triggering navigation was aborted after the manifest response settled but before the route tree was patched, which permanently (for the session) shadowed the real route behind a catch-all or produced 404s on every subsequent visit ([#15399](https://github.com/remix-run/react-router/pull/15399))
+- Improve route matching performance for long paths ([#15417](https://github.com/remix-run/react-router/pull/15417))
+- Improve validation of action request origins ([#15419](https://github.com/remix-run/react-router/pull/15419))
+- Fix `<ScrollRestoration>` leaving `history.scrollRestoration` set to `"auto"` after a bfcache restore, which let the browser restore scroll on subsequent history traversals before the destination route had rendered ([#15397](https://github.com/remix-run/react-router/pull/15397))
+- Properly respect the `relative` option in `useSubmit`/`fetcher.submit` when resolivng the `action` path ([#15400](https://github.com/remix-run/react-router/pull/15400))
+- Add additional URL validation on client side navigations/redirects ([#15445](https://github.com/remix-run/react-router/pull/15445))
+
 ## v8.3.0
 
 ### Patch Changes
@@ -17,7 +62,7 @@
 
 ### Unstable Changes
 
-⚠️  _[Unstable features](https://reactrouter.com/community/api-development-strategy#unstable-flags) are not recommended for production use_
+⚠️ _[Unstable features](https://reactrouter.com/community/api-development-strategy#unstable-flags) are not recommended for production use_
 
 - Detect stale RSC clients during lazy route discovery and reload the destination document ([#15318](https://github.com/remix-run/react-router/pull/15318))
 
@@ -35,7 +80,6 @@
   ```
 
 - Add CSP nonce support to RSC document rendering ([#15320](https://github.com/remix-run/react-router/pull/15320))
-
   - Add `nonce` options to `unstable_routeRSCServerRequest` and `unstable_RSCStaticRouter`
   - Forward the nonce to the HTML renderer and apply it to injected RSC payload scripts and nonce-aware framework components
 

package/dist/development/dom-export.js

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

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

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

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

@@ -50,7 +50,7 @@ interface Path {
  * An entry in a history stack. A location contains information about the
  * URL path, as well as possibly some arbitrary state and a key.
  */
-interface Location<State = any> extends Path {
+interface Location$1<State = any> extends Path {
   /**
    * A value of arbitrary data associated with this location.
    */
@@ -79,7 +79,7 @@ interface Update {
   /**
    * The new location.
    */
-  location: Location;
+  location: Location$1;
   /**
    * The delta between this location and the former location in the history stack
    */
@@ -113,7 +113,7 @@ interface History {
   /**
    * The current location. This value is mutable.
    */
-  readonly location: Location;
+  readonly location: Location$1;
   /**
    * Returns a valid href for the given `to` value that may be used as
    * the value of an <a href> attribute.
@@ -597,7 +597,7 @@ interface MapRoutePropertiesFunction {
  * onto the route. Either they're meaningful to the router, or they'll get
  * ignored.
  */
-type UnsupportedLazyRouteObjectKey = "lazy" | "caseSensitive" | "path" | "id" | "index" | "children";
+type UnsupportedLazyRouteObjectKey = "lazy" | "caseSensitive" | "path" | "id" | "index" | "children" | "unstable_validateParams";
 /**
  * Keys we cannot change from within a lazy() function. We spread all other keys
  * onto the route. Either they're meaningful to the router, or they'll get
@@ -655,6 +655,11 @@ type BaseRouteObject = {
    * See [`shouldRevalidate`](../../start/data/route-object#shouldRevalidate).
    */
   shouldRevalidate?: ShouldRevalidateFunction;
+  /**
+   * A map of route param names to regular expressions used to validate params
+   * after a route-pattern match.
+   */
+  unstable_validateParams?: Record<string, RegExp>;
   /**
    * The route handle.
    */
@@ -791,7 +796,7 @@ interface DataRouteMatch extends RouteMatch<string, DataRouteObject> {}
  * Defaults to `/`.
  * @returns An array of matched routes, or `null` if no matches were found.
  */
-declare function matchRoutes<RouteObjectType extends RouteObject = RouteObject>(routes: RouteObjectType[], locationArg: Partial<Location> | string, basename?: string): RouteMatch<string, RouteObjectType>[] | null;
+declare function matchRoutes<RouteObjectType extends RouteObject = RouteObject>(routes: RouteObjectType[], locationArg: Partial<Location$1> | string, basename?: string): RouteMatch<string, RouteObjectType>[] | null;
 interface UIMatch<Data = unknown, Handle = unknown> {
   id: string;
   pathname: string;
@@ -811,30 +816,6 @@ interface UIMatch<Data = unknown, Handle = unknown> {
    */
   handle: Handle;
 }
-interface RouteMeta<RouteObjectType extends RouteObject = RouteObject> {
-  relativePath: string;
-  caseSensitive: boolean;
-  childrenIndex: number;
-  route: RouteObjectType;
-  matcher?: RegExp;
-  compiledParams?: CompiledPathParam[];
-}
-/**
- * @private
- * PRIVATE - DO NOT USE
- *
- * A "branch" of routes that match a given route pattern.
- * This is an internal interface not intended for direct external usage.
- */
-interface RouteBranch<RouteObjectType extends RouteObject = RouteObject> {
-  path: string;
-  score: number;
-  routesMeta: RouteMeta<RouteObjectType>[];
-}
-type CompiledPathParam = {
-  paramName: string;
-  isOptional?: boolean;
-};
 declare class DataWithResponseInit<D> {
   type: string;
   data: D;
@@ -1143,9 +1124,10 @@ interface Router$1 {
    * @private
    * PRIVATE - DO NOT USE
    *
-   * Return the route branches for this router instance
+   * Match routes against a location using the router's configured route
+   * matching implementation.
    */
-  get branches(): RouteBranch<DataRouteObject>[] | undefined;
+  match(locationArg: Partial<Location$1> | string): DataRouteMatch[] | null;
   /**
    * @private
    * PRIVATE - DO NOT USE
@@ -1230,7 +1212,15 @@ interface Router$1 {
    * Utility function to create an href for the given location
    * @param location
    */
-  createHref(location: Location | URL): string;
+  createHref(location: Location$1 | URL): string;
+  /**
+   * @private
+   * PRIVATE - DO NOT USE
+   *
+   * Utility function to create a URL for the given location
+   * @param location
+   */
+  createURL?(to: To): URL;
   /**
    * @private
    * PRIVATE - DO NOT USE
@@ -1338,7 +1328,7 @@ interface RouterState {
   /**
    * The current location reflected by the router
    */
-  location: Location;
+  location: Location$1;
   /**
    * The current set of route matches
    */
@@ -1399,7 +1389,10 @@ type HydrationState = Partial<Pick<RouterState, "loaderData" | "actionData" | "e
 /**
  * Future flags to toggle new feature behavior
  */
-interface FutureConfig {}
+interface FutureConfig {
+  /** Enables route-pattern matching after calling `unstable_preloadRoutePattern()`. */
+  unstable_routePatternMatching?: boolean;
+}
 /**
  * Initialization options for createRouter
  */
@@ -1431,6 +1424,8 @@ interface StaticHandlerContext {
   loaderHeaders: Record<string, Headers>;
   actionHeaders: Record<string, Headers>;
   _deepestRenderedBoundaryId?: string | null;
+  /** @private */
+  _match: StaticHandler["match"];
 }
 /**
  * A StaticHandler instance manages a singular SSR navigation/fetch event
@@ -1444,10 +1439,10 @@ interface StaticHandler {
    * @private
    * PRIVATE - DO NOT USE
    *
-   * The route branches derived from the data routes, used for internal route
-   * matching in Framework Mode
+   * Match routes against a location using the handler's configured route
+   * matching implementation.
    */
-  _internalRouteBranches: RouteBranch<DataRouteObject>[];
+  match(locationArg: Partial<Location$1> | string): DataRouteMatch[] | null;
   /**
    * Perform a query for a given request - executing all matched route
    * loaders/actions.  Used for document requests.
@@ -1495,8 +1490,8 @@ interface StaticHandler {
   }): Promise<any>;
 }
 type ViewTransitionOpts = {
-  currentLocation: Location;
-  nextLocation: Location;
+  currentLocation: Location$1;
+  nextLocation: Location$1;
 };
 /**
  * Subscriber function signature for changes to router state
@@ -1514,7 +1509,7 @@ interface RouterSubscriber {
  * for a given location
  */
 interface GetScrollRestorationKeyFunction {
-  (location: Location, matches: UIMatch[]): string | null;
+  (location: Location$1, matches: UIMatch[]): string | null;
 }
 /**
  * Function signature for determining the current scroll position
@@ -1596,7 +1591,7 @@ type NavigationStates = {
   };
   Loading: {
     state: "loading";
-    location: Location;
+    location: Location$1;
     matches: DataRouteMatch[];
     historyAction: Action;
     formMethod: Submission["formMethod"] | undefined;
@@ -1608,7 +1603,7 @@ type NavigationStates = {
   };
   Submitting: {
     state: "submitting";
-    location: Location;
+    location: Location$1;
     matches: DataRouteMatch[];
     historyAction: Action;
     formMethod: Submission["formMethod"];
@@ -1698,7 +1693,7 @@ interface BlockerBlocked {
   state: "blocked";
   reset: () => void;
   proceed: () => void;
-  location: Location;
+  location: Location$1;
 }
 interface BlockerUnblocked {
   state: "unblocked";
@@ -1710,12 +1705,12 @@ interface BlockerProceeding {
   state: "proceeding";
   reset: undefined;
   proceed: undefined;
-  location: Location;
+  location: Location$1;
 }
 type Blocker = BlockerUnblocked | BlockerBlocked | BlockerProceeding;
 type BlockerFunction = (args: {
-  currentLocation: Location;
-  nextLocation: Location;
+  currentLocation: Location$1;
+  nextLocation: Location$1;
   historyAction: Action;
 }) => boolean;
 interface CreateStaticHandlerOptions {
@@ -2000,7 +1995,7 @@ type MetaMatches<MatchLoaders extends Record<string, LoaderFunction | ClientLoad
 interface MetaArgs<Loader extends LoaderFunction | ClientLoaderFunction | unknown = unknown, MatchLoaders extends Record<string, LoaderFunction | ClientLoaderFunction | unknown> = Record<string, unknown>> {
   loaderData: (Loader extends LoaderFunction | ClientLoaderFunction ? SerializeFrom<Loader> : unknown) | undefined;
   params: Params;
-  location: Location;
+  location: Location$1;
   matches: MetaMatches<MatchLoaders>;
   error?: unknown;
 }
@@ -2321,7 +2316,7 @@ type RSCRenderPayload = {
   clientVersion?: string;
   errors: Record<string, any> | null;
   loaderData: Record<string, any>;
-  location: Location;
+  location: Location$1;
   routeDiscovery: RouteDiscovery;
   matches: RSCRouteMatch[];
   patches?: Promise<RSCRouteManifest[]>;
@@ -2369,6 +2364,13 @@ type RouteDiscovery = {
  * encoding an {@link unstable_RSCPayload} for consumption by an [RSC](https://react.dev/reference/rsc/server-components)
  * enabled client router.
  *
+ * Treat every React Server Function as a public endpoint. Server Functions are
+ * not inherently associated with a route. Any route middleware that runs is
+ * selected from the URL used to call a Server Function, but the client controls
+ * both the Server Function identifier and the URL. Perform all access control
+ * checks within each Server Function, or use a route action for
+ * middleware-driven access control.
+ *
  * @example
  * import {
  *   createTemporaryReferenceSet,