v7.8.2

Compare Source

Patch Changes

• [UNSTABLE] Remove Data Mode future.unstable_middleware flag from createBrowserRouter (#​14213)

  • This is only needed as a Framework Mode flag because of the route modules and the getLoadContext type behavior change
  • In Data Mode, it's an opt-in feature because it's just a new property on a route object, so there's no behavior changes that necessitate a flag

• [UNSTABLE] Add <RouterProvider unstable_onError>/<HydratedRouter unstable_onError> prop for client side error reporting (#​14162)

• server action revalidation opt out via $SKIP_REVALIDATION field (#​14154)

• Properly escape interpolated param values in generatePath() (#​13530)

• Maintain ReadonlyMap and ReadonlySet types in server response data. (#​13092)

• [UNSTABLE] Delay serialization of .data redirects to 202 responses until after middleware chain (#​14205)

• Fix TypeError if you throw from patchRoutesOnNavigation when no partial matches exist (#​14198)

• Fix basename usage without a leading slash in data routers (#​11671)

• [UNSTABLE] Update client middleware so it returns the data strategy results allowing for more advanced post-processing middleware (#​14151)

v7.8.1

Compare Source

Patch Changes

• Fix usage of optional path segments in nested routes defined using absolute paths (#​14135)
• Bubble client pre-next middleware error to the shallowest ancestor that needs to load, not strictly the shallowest ancestor with a loader (#​14150)
• Fix optional static segment matching in matchPath (#​11813)
• Fix prerendering when a basename is set with ssr:false (#​13791)
• Provide isRouteErrorResponse utility in react-server environments (#​14166)
• Propagate non-redirect Responses thrown from middleware to the error boundary on document/data requests (#​14182)
• Handle meta and links Route Exports in RSC Data Mode (#​14136)
• Properly convert returned/thrown data() values to Response instances via Response.json() in resource routes and middleware (#​14159, #​14181)

v7.8.0

Compare Source

Minor Changes

• Add nonce prop to Links & PrefetchPageLinks (#​14048)
• Add loaderData arguments/properties alongside existing data arguments/properties to provide consistency and clarity between loaderData and actionData across the board (#​14047)
  • Updated types: Route.MetaArgs, Route.MetaMatch, MetaArgs, MetaMatch, Route.ComponentProps.matches, UIMatch
  • @deprecated warnings have been added to the existing data properties to point users to new loaderData properties, in preparation for removing the data properties in a future major release

Patch Changes

• Prevent "Did not find corresponding fetcher result" console error when navigating during a fetcher.submit revalidation (#​14114)

• Bubble client-side middleware errors prior to next to the appropriate ancestor error boundary (#​14138)

• Switch Lazy Route Discovery manifest URL generation to usea standalone URLSearchParams instance instead of URL.searchParams to avoid a major performance bottleneck in Chrome (#​14084)

• Adjust internal RSC usage of React.use to avoid Webpack compilation errors when using React 18 (#​14113)

• Remove dependency on @types/node in TypeScript declaration files (#​14059)

• Fix types for UIMatch to reflect that the loaderData/data properties may be undefined (#​12206)

  • When an ErrorBoundary is being rendered, not all active matches will have loader data available, since it may have been their loader that threw to trigger the boundary
  • The UIMatch.data type was not correctly handing this and would always reflect the presence of data, leading to the unexpected runtime errors when an ErrorBoundary was rendered
  • ⚠️ This may cause some type errors to show up in your code for unguarded match.data accesses - you should properly guard for undefined values in those scenarios.

  // app/root.tsx
  export function loader() {
    someFunctionThatThrows(); // ❌ Throws an Error
    return { title: "My Title" };
  }
  
  export function Layout({ children }: { children: React.ReactNode }) {
    let matches = useMatches();
    let rootMatch = matches[0] as UIMatch<Awaited<ReturnType<typeof loader>>>;
    //  ^ rootMatch.data is incorrectly typed here, so TypeScript does not
    //    complain if you do the following which throws an error at runtime:
    let { title } = rootMatch.data; // 💥
  
    return <html>...</html>;
  }

• [UNSTABLE] Ensure resource route errors go through handleError w/middleware enabled (#​14078)

• [UNSTABLE] Propagate returned Response from server middleware if next wasn't called (#​14093)

• [UNSTABLE] Allow server middlewares to return data() values which will be converted into a Response (#​14093)

• [UNSTABLE] Update middleware error handling so that the next function never throws and instead handles any middleware errors at the proper ErrorBoundary and returns the Response up through the ancestor next function (#​14118)

• [UNSTABLE] When middleware is enabled, make the context parameter read-only (via Readonly<unstable_RouterContextProvider>) so that TypeScript will not allow you to write arbitrary fields to it in loaders, actions, or middleware. (#​14097)

• [UNSTABLE] Rename and alter the signature/functionality of the unstable_respond API in staticHandler.query/staticHandler.queryRoute (#​14103)

  • The API has been renamed to unstable_generateMiddlewareResponse for clarity
  • The main functional change is that instead of running the loaders/actions before calling unstable_respond and handing you the result, we now pass a query/queryRoute function as a parameter and you execute the loaders/actions inside your callback, giving you full access to pre-processing and error handling
  • The query version of the API now has a signature of (query: (r: Request) => Promise<StaticHandlerContext | Response>) => Promise<Response>
  • The queryRoute version of the API now has a signature of (queryRoute: (r: Request) => Promise<Response>) => Promise<Response>
  • This allows for more advanced usages such as running logic before/after calling query and direct error handling of errors thrown from query
  • ⚠️ This is a breaking change if you've adopted the staticHandler unstable_respond API

  let response = await staticHandler.query(request, {
    requestContext: new unstable_RouterContextProvider(),
    async unstable_generateMiddlewareResponse(query) {
      try {
        // At this point we've run middleware top-down so we need to call the
        // handlers and generate the Response to bubble back up the middleware
        let result = await query(request);
        if (isResponse(result)) {
          return result; // Redirects, etc.
        }
        return await generateHtmlResponse(result);
      } catch (error: unknown) {
        return generateErrorResponse(error);
      }
    },
  });

• [UNSTABLE] Convert internal middleware implementations to use the new unstable_generateMiddlewareResponse API (#​14103)

• [UNSTABLE] Change getLoadContext signature (type GetLoadContextFunction) when future.unstable_middleware is enabled so that it returns an unstable_RouterContextProvider instance instead of a Map used to contruct the instance internally (#​14097)

  • This also removes the type unstable_InitialContext export
  • ⚠️ This is a breaking change if you have adopted middleware and are using a custom server with a getLoadContext function

• [UNSTABLE] Run client middleware on client navigations even if no loaders exist (#​14106)

• [UNSTABLE] Change the unstable_getContext signature on RouterProvider/HydratedRouter/unstable_RSCHydratedRouter so that it returns an unstable_RouterContextProvider instance instead of a Map used to contruct the instance internally (#​14097)

  • ⚠️ This is a breaking change if you have adopted the unstable_getContext prop

• [UNSTABLE] proxy server action side-effect redirects from actions for document and callServer requests (#​14131)

• [UNSTABLE] Fix RSC Data Mode issue where routes that return false from shouldRevalidate would be replaced by an <Outlet /> (#​14071)

v7.7.1

Compare Source

Patch Changes

• In RSC Data Mode, fix bug where routes with errors weren't forced to revalidate when shouldRevalidate returned false (#​14026)
• In RSC Data Mode, fix Matched leaf route at location "/..." does not have an element or Component warnings when error boundaries are rendered. (#​14021)

v7.7.0

Compare Source

Minor Changes

• Add unstable RSC support (#​13700)

  For more information, see the RSC documentation.

Patch Changes

• Handle InvalidCharacterError when validating cookie signature (#​13847)

• Pass a copy of searchParams to the setSearchParams callback function to avoid muations of the internal searchParams instance. This was an issue when navigations were blocked because the internal instance be out of sync with useLocation().search. (#​12784)

• Support invalid Date in turbo-stream v2 fork (#​13684)

• In Framework Mode, clear critical CSS in development after initial render (#​13872)

• Strip search parameters from patchRoutesOnNavigation path param for fetcher calls (#​13911)

• Skip scroll restoration on useRevalidator() calls because they're not new locations (#​13671)

• Support unencoded UTF-8 routes in prerender config with ssr set to false (#​13699)

• Do not throw if the url hash is not a valid URI component (#​13247)

• Fix a regression in createRoutesStub introduced with the middleware feature. (#​13946)

  As part of that work we altered the signature to align with the new middleware APIs without making it backwards compatible with the prior AppLoadContext API. This permitted createRoutesStub to work if you were opting into middleware and the updated context typings, but broke createRoutesStub for users not yet opting into middleware.

  We've reverted this change and re-implemented it in such a way that both sets of users can leverage it.

  // If you have not opted into middleware, the old API should work again
  let context: AppLoadContext = {
    /*...*/
  };
  let Stub = createRoutesStub(routes, context);
  
  // If you have opted into middleware, you should now pass an instantiated `unstable_routerContextProvider` instead of a `getContext` factory function.
  let context = new unstable_RouterContextProvider();
  context.set(SomeContext, someValue);
  let Stub = createRoutesStub(routes, context);

  ⚠️ This may be a breaking bug for if you have adopted the unstable Middleware feature and are using createRoutesStub with the updated API.

• Remove Content-Length header from Single Fetch responses (#​13902)