react-router 7.2.0 → 7.3.0-pre.1

package/dist/development/index.mjs

@@ -1,5 +1,5 @@
 /**
- * react-router v7.2.0
+ * react-router v7.3.0-pre.1
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -89,6 +89,8 @@ import {
   resolvePath,
   setDevServerHooks,
   shouldHydrateRouteLoader,
+  unstable_RouterContextProvider,
+  unstable_createContext,
   useActionData,
   useAsyncError,
   useAsyncValue,
@@ -121,7 +123,7 @@ import {
   useSearchParams,
   useSubmit,
   useViewTransitionState
-} from "./chunk-HA7DTUK3.mjs";
+} from "./chunk-3XNZT7XE.mjs";
 export {
   Await,
   BrowserRouter,
@@ -204,6 +206,8 @@ export {
   replace,
   resolvePath,
   HistoryRouter as unstable_HistoryRouter,
+  unstable_RouterContextProvider,
+  unstable_createContext,
   setDevServerHooks as unstable_setDevServerHooks,
   usePrompt as unstable_usePrompt,
   useActionData,

package/dist/development/lib/types/route-module.d.mts

@@ -1,8 +1,9 @@
-import { az as LinkDescriptor, aw as MetaDescriptor, aO as ServerDataFrom, aP as ClientDataFrom, aQ as Func, E as Equal, aR as Pretty } from '../../route-data-BmvbmBej.mjs';
-import { A as AppLoadContext } from '../../data-CQbyyGzl.mjs';
+import { aE as LinkDescriptor, aB as MetaDescriptor, aT as ServerDataFrom, aU as ClientDataFrom, aV as Func, aW as unstable_MiddlewareNextFunction, E as Equal, u as unstable_RouterContextProvider, aX as Pretty } from '../../route-data-H2S3hwhf.mjs';
+import { M as MiddlewareEnabled, A as AppLoadContext } from '../../future-ldDp5FKH.mjs';
 import 'react';
 
 type IsDefined<T> = Equal<T, undefined> extends true ? false : true;
+type MaybePromise<T> = T | Promise<T>;
 type RouteModule = {
     meta?: Func;
     links?: Func;
@@ -96,6 +97,15 @@ type ClientDataFunctionArgs<T extends RouteInfo> = {
      * }
      **/
     params: T["params"];
+    /**
+     * When `future.unstable_middleware` is not enabled, this is undefined.
+     *
+     * When `future.unstable_middleware` is enabled, this is an instance of
+     * `unstable_RouterContextProvider` and can be used to access context values
+     * from your route middlewares.  You may pass in initial context values in your
+     * `<HydratedRouter unstable_getContext>` prop
+     */
+    context: unstable_RouterContextProvider;
 };
 type ServerDataFunctionArgs<T extends RouteInfo> = {
     /** A {@link https://developer.mozilla.org/en-US/docs/Web/API/Request Fetch Request instance} which you can use to read the url, method, headers (such as cookies), and request body from the request. */
@@ -116,12 +126,21 @@ type ServerDataFunctionArgs<T extends RouteInfo> = {
      **/
     params: T["params"];
     /**
-     * This is the context passed in to your server adapter's getLoadContext() function.
-     * It's a way to bridge the gap between the adapter's request/response API with your React Router app.
+     * Without `future.unstable_middleware` enabled, this is the context passed in
+     * to your server adapter's `getLoadContext` function. It's a way to bridge the
+     * gap between the adapter's request/response API with your React Router app.
      * It is only applicable if you are using a custom server adapter.
+     *
+     * With `future.unstable_middleware` enabled, this is an instance of
+     * `unstable_RouterContextProvider` and can be used for type-safe access to
+     * context value set in your route middlewares.  If you are using a custom
+     * server adapter, you may provide an initial set of context values from your
+     * `getLoadContext` function.
      */
-    context: AppLoadContext;
+    context: MiddlewareEnabled extends true ? unstable_RouterContextProvider : AppLoadContext;
 };
+type CreateServerMiddlewareFunction<T extends RouteInfo> = (args: ServerDataFunctionArgs<T>, next: unstable_MiddlewareNextFunction<Response>) => MaybePromise<Response | void>;
+type CreateClientMiddlewareFunction<T extends RouteInfo> = (args: ClientDataFunctionArgs<T>, next: unstable_MiddlewareNextFunction<undefined>) => MaybePromise<undefined>;
 type CreateServerLoaderArgs<T extends RouteInfo> = ServerDataFunctionArgs<T>;
 type CreateClientLoaderArgs<T extends RouteInfo> = ClientDataFunctionArgs<T> & {
     /** This is an asynchronous function to get the data from the server loader for this route. On client-side navigations, this will make a {@link https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API fetch} call to the React Router server loader. If you opt-into running your clientLoader on hydration, then this function will return the data that was already loaded on the server (via Promise.resolve). */
@@ -187,4 +206,4 @@ type CreateErrorBoundaryProps<T extends RouteInfo> = {
     actionData?: T["actionData"];
 };
 
-export type { CreateActionData, CreateClientActionArgs, CreateClientLoaderArgs, CreateComponentProps, CreateErrorBoundaryProps, CreateHydrateFallbackProps, CreateLoaderData, CreateMetaArgs, CreateServerActionArgs, CreateServerLoaderArgs, HeadersArgs, LinkDescriptors, MetaDescriptors };
+export type { CreateActionData, CreateClientActionArgs, CreateClientLoaderArgs, CreateClientMiddlewareFunction, CreateComponentProps, CreateErrorBoundaryProps, CreateHydrateFallbackProps, CreateLoaderData, CreateMetaArgs, CreateServerActionArgs, CreateServerLoaderArgs, CreateServerMiddlewareFunction, HeadersArgs, LinkDescriptors, MetaDescriptors };

package/dist/development/lib/types/route-module.d.ts

@@ -1,8 +1,9 @@
-import { az as LinkDescriptor, aw as MetaDescriptor, aO as ServerDataFrom, aP as ClientDataFrom, aQ as Func, E as Equal, aR as Pretty } from '../../route-data-BmvbmBej.js';
-import { A as AppLoadContext } from '../../data-CQbyyGzl.js';
+import { aE as LinkDescriptor, aB as MetaDescriptor, aT as ServerDataFrom, aU as ClientDataFrom, aV as Func, aW as unstable_MiddlewareNextFunction, E as Equal, u as unstable_RouterContextProvider, aX as Pretty } from '../../route-data-H2S3hwhf.js';
+import { M as MiddlewareEnabled, A as AppLoadContext } from '../../future-ldDp5FKH.js';
 import 'react';
 
 type IsDefined<T> = Equal<T, undefined> extends true ? false : true;
+type MaybePromise<T> = T | Promise<T>;
 type RouteModule = {
     meta?: Func;
     links?: Func;
@@ -96,6 +97,15 @@ type ClientDataFunctionArgs<T extends RouteInfo> = {
      * }
      **/
     params: T["params"];
+    /**
+     * When `future.unstable_middleware` is not enabled, this is undefined.
+     *
+     * When `future.unstable_middleware` is enabled, this is an instance of
+     * `unstable_RouterContextProvider` and can be used to access context values
+     * from your route middlewares.  You may pass in initial context values in your
+     * `<HydratedRouter unstable_getContext>` prop
+     */
+    context: unstable_RouterContextProvider;
 };
 type ServerDataFunctionArgs<T extends RouteInfo> = {
     /** A {@link https://developer.mozilla.org/en-US/docs/Web/API/Request Fetch Request instance} which you can use to read the url, method, headers (such as cookies), and request body from the request. */
@@ -116,12 +126,21 @@ type ServerDataFunctionArgs<T extends RouteInfo> = {
      **/
     params: T["params"];
     /**
-     * This is the context passed in to your server adapter's getLoadContext() function.
-     * It's a way to bridge the gap between the adapter's request/response API with your React Router app.
+     * Without `future.unstable_middleware` enabled, this is the context passed in
+     * to your server adapter's `getLoadContext` function. It's a way to bridge the
+     * gap between the adapter's request/response API with your React Router app.
      * It is only applicable if you are using a custom server adapter.
+     *
+     * With `future.unstable_middleware` enabled, this is an instance of
+     * `unstable_RouterContextProvider` and can be used for type-safe access to
+     * context value set in your route middlewares.  If you are using a custom
+     * server adapter, you may provide an initial set of context values from your
+     * `getLoadContext` function.
      */
-    context: AppLoadContext;
+    context: MiddlewareEnabled extends true ? unstable_RouterContextProvider : AppLoadContext;
 };
+type CreateServerMiddlewareFunction<T extends RouteInfo> = (args: ServerDataFunctionArgs<T>, next: unstable_MiddlewareNextFunction<Response>) => MaybePromise<Response | void>;
+type CreateClientMiddlewareFunction<T extends RouteInfo> = (args: ClientDataFunctionArgs<T>, next: unstable_MiddlewareNextFunction<undefined>) => MaybePromise<undefined>;
 type CreateServerLoaderArgs<T extends RouteInfo> = ServerDataFunctionArgs<T>;
 type CreateClientLoaderArgs<T extends RouteInfo> = ClientDataFunctionArgs<T> & {
     /** This is an asynchronous function to get the data from the server loader for this route. On client-side navigations, this will make a {@link https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API fetch} call to the React Router server loader. If you opt-into running your clientLoader on hydration, then this function will return the data that was already loaded on the server (via Promise.resolve). */
@@ -187,4 +206,4 @@ type CreateErrorBoundaryProps<T extends RouteInfo> = {
     actionData?: T["actionData"];
 };
 
-export type { CreateActionData, CreateClientActionArgs, CreateClientLoaderArgs, CreateComponentProps, CreateErrorBoundaryProps, CreateHydrateFallbackProps, CreateLoaderData, CreateMetaArgs, CreateServerActionArgs, CreateServerLoaderArgs, HeadersArgs, LinkDescriptors, MetaDescriptors };
+export type { CreateActionData, CreateClientActionArgs, CreateClientLoaderArgs, CreateClientMiddlewareFunction, CreateComponentProps, CreateErrorBoundaryProps, CreateHydrateFallbackProps, CreateLoaderData, CreateMetaArgs, CreateServerActionArgs, CreateServerLoaderArgs, CreateServerMiddlewareFunction, HeadersArgs, LinkDescriptors, MetaDescriptors };

package/dist/development/lib/types/route-module.js

@@ -1,5 +1,5 @@
 /**
- * react-router v7.2.0
+ * react-router v7.3.0-pre.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/types/route-module.mjs

@@ -1,5 +1,5 @@
 /**
- * react-router v7.2.0
+ * react-router v7.3.0-pre.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/{production/route-data-BmvbmBej.d.mts → development/route-data-H2S3hwhf.d.mts}

@@ -260,6 +260,34 @@ type Submission = {
     json: undefined;
     text: string;
 };
+interface unstable_RouterContext<T = unknown> {
+    defaultValue?: T;
+}
+/**
+ * Creates a context object that may be used to store and retrieve arbitrary values.
+ *
+ * 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.
+ *
+ * @param defaultValue The default value for the context
+ * @returns A context object
+ */
+declare function unstable_createContext<T>(defaultValue?: T): unstable_RouterContext<T>;
+/**
+ * A Map of RouterContext objects to their initial values - used to populate a
+ * fresh `context` value per request/navigation/fetch
+ */
+type unstable_InitialContext = Map<unstable_RouterContext, unknown>;
+/**
+ * Provides methods for writing/reading values in application context in a typesafe way.
+ */
+declare class unstable_RouterContextProvider {
+    #private;
+    constructor(init?: unstable_InitialContext);
+    get<T>(context: unstable_RouterContext<T>): T;
+    set<C extends unstable_RouterContext>(context: C, value: C extends unstable_RouterContext<infer T> ? T : never): void;
+}
 /**
  * @private
  * Arguments passed to route loader/action functions.  Same for now but we keep
@@ -288,8 +316,22 @@ interface DataFunctionArgs<Context> {
      * It's a way to bridge the gap between the adapter's request/response API with your React Router app.
      * It is only applicable if you are using a custom server adapter.
      */
-    context?: Context;
+    context: Context;
 }
+/**
+ * Route middleware `next` function to call downstream handlers and then complete
+ * middlewares from the bottom-up
+ */
+interface unstable_MiddlewareNextFunction<Result = unknown> {
+    (): Result | Promise<Result>;
+}
+/**
+ * Route middleware function signature.  Receives the same "data" arguments as a
+ * `loader`/`action` (`request`, `params`, `context`) as the first parameter and
+ * a `next` function as the second parameter which will call downstream handlers
+ * and then complete middlewares from the bottom-up
+ */
+type unstable_MiddlewareFunction<Result = unknown> = (args: DataFunctionArgs<unstable_RouterContextProvider>, next: unstable_MiddlewareNextFunction<Result>) => Result | Promise<Result>;
 /**
  * Arguments passed to loader functions
  */
@@ -301,11 +343,9 @@ interface LoaderFunctionArgs<Context = any> extends DataFunctionArgs<Context> {
 interface ActionFunctionArgs<Context = any> extends DataFunctionArgs<Context> {
 }
 /**
- * Loaders and actions can return anything except `undefined` (`null` is a
- * valid return value if there is no data to return).  Responses are preferred
- * and will ease any future migration to Remix
+ * Loaders and actions can return anything
  */
-type DataFunctionValue = Response | NonNullable<unknown> | null;
+type DataFunctionValue = unknown;
 type DataFunctionReturnValue = Promise<DataFunctionValue> | DataFunctionValue;
 /**
  * Route loader function signature
@@ -402,13 +442,14 @@ interface DataStrategyResult {
     type: "data" | "error";
     result: unknown;
 }
-interface DataStrategyFunction {
-    (args: DataStrategyFunctionArgs): Promise<Record<string, DataStrategyResult>>;
+interface DataStrategyFunction<Context = any> {
+    (args: DataStrategyFunctionArgs<Context>): Promise<Record<string, DataStrategyResult>>;
 }
 type AgnosticPatchRoutesOnNavigationFunctionArgs<O extends AgnosticRouteObject = AgnosticRouteObject, M extends AgnosticRouteMatch = AgnosticRouteMatch> = {
     signal: AbortSignal;
     path: string;
     matches: M[];
+    fetcherKey: string | undefined;
     patch: (routeId: string | null, children: O[]) => void;
 };
 type AgnosticPatchRoutesOnNavigationFunction<O extends AgnosticRouteObject = AgnosticRouteObject, M extends AgnosticRouteMatch = AgnosticRouteMatch> = (opts: AgnosticPatchRoutesOnNavigationFunctionArgs<O, M>) => void | Promise<void>;
@@ -444,6 +485,7 @@ type AgnosticBaseRouteObject = {
     caseSensitive?: boolean;
     path?: string;
     id?: string;
+    unstable_middleware?: unstable_MiddlewareFunction[];
     loader?: LoaderFunction | boolean;
     action?: ActionFunction | boolean;
     hasErrorBoundary?: boolean;
@@ -669,6 +711,7 @@ declare class ErrorResponseImpl implements ErrorResponse {
  */
 declare function isRouteErrorResponse(error: any): error is ErrorResponse;
 
+type MaybePromise<T> = T | Promise<T>;
 /**
  * A Router instance manages all navigation and data loading/mutations
  */
@@ -924,6 +967,7 @@ type HydrationState = Partial<Pick<RouterState, "loaderData" | "actionData" | "e
  * Future flags to toggle new feature behavior
  */
 interface FutureConfig {
+    unstable_middleware: boolean;
 }
 /**
  * Initialization options for createRouter
@@ -932,6 +976,7 @@ interface RouterInit {
     routes: AgnosticRouteObject[];
     history: History;
     basename?: string;
+    unstable_getContext?: () => MaybePromise<unstable_InitialContext>;
     mapRouteProperties?: MapRoutePropertiesFunction;
     future?: Partial<FutureConfig>;
     hydrationData?: HydrationState;
@@ -961,13 +1006,17 @@ interface StaticHandler {
     dataRoutes: AgnosticDataRouteObject[];
     query(request: Request, opts?: {
         requestContext?: unknown;
+        filterMatchesToLoad?: (match: AgnosticDataRouteMatch) => boolean;
         skipLoaderErrorBubbling?: boolean;
-        dataStrategy?: DataStrategyFunction;
+        skipRevalidation?: boolean;
+        dataStrategy?: DataStrategyFunction<unknown>;
+        unstable_respond?: (staticContext: StaticHandlerContext) => MaybePromise<Response>;
     }): Promise<StaticHandlerContext | Response>;
     queryRoute(request: Request, opts?: {
         routeId?: string;
         requestContext?: unknown;
-        dataStrategy?: DataStrategyFunction;
+        dataStrategy?: DataStrategyFunction<unknown>;
+        unstable_respond?: (res: Response) => MaybePromise<Response>;
     }): Promise<any>;
 }
 type ViewTransitionOpts = {
@@ -1201,6 +1250,7 @@ interface IndexRouteObject {
     caseSensitive?: AgnosticIndexRouteObject["caseSensitive"];
     path?: AgnosticIndexRouteObject["path"];
     id?: AgnosticIndexRouteObject["id"];
+    unstable_middleware?: AgnosticIndexRouteObject["unstable_middleware"];
     loader?: AgnosticIndexRouteObject["loader"];
     action?: AgnosticIndexRouteObject["action"];
     hasErrorBoundary?: AgnosticIndexRouteObject["hasErrorBoundary"];
@@ -1220,6 +1270,7 @@ interface NonIndexRouteObject {
     caseSensitive?: AgnosticNonIndexRouteObject["caseSensitive"];
     path?: AgnosticNonIndexRouteObject["path"];
     id?: AgnosticNonIndexRouteObject["id"];
+    unstable_middleware?: AgnosticNonIndexRouteObject["unstable_middleware"];
     loader?: AgnosticNonIndexRouteObject["loader"];
     action?: AgnosticNonIndexRouteObject["action"];
     hasErrorBoundary?: AgnosticNonIndexRouteObject["hasErrorBoundary"];
@@ -1425,6 +1476,7 @@ interface RouteModules {
 interface RouteModule {
     clientAction?: ClientActionFunction;
     clientLoader?: ClientLoaderFunction;
+    unstable_clientMiddleware?: unstable_MiddlewareFunction<undefined>[];
     ErrorBoundary?: ErrorBoundaryComponent;
     HydrateFallback?: HydrateFallbackComponent;
     Layout?: LayoutComponent;
@@ -1443,6 +1495,7 @@ interface ServerRouteModule extends RouteModule {
         [name: string]: string;
     };
     loader?: LoaderFunction;
+    unstable_middleware?: unstable_MiddlewareFunction<Response>[];
 }
 /**
  * A function that handles data mutations for a route on the client
@@ -1451,7 +1504,7 @@ type ClientActionFunction = (args: ClientActionFunctionArgs) => ReturnType<Actio
 /**
  * Arguments passed to a route `clientAction` function
  */
-type ClientActionFunctionArgs = ActionFunctionArgs<undefined> & {
+type ClientActionFunctionArgs = ActionFunctionArgs & {
     serverAction: <T = unknown>() => Promise<SerializeFrom<T>>;
 };
 /**
@@ -1463,7 +1516,7 @@ type ClientLoaderFunction = ((args: ClientLoaderFunctionArgs) => ReturnType<Load
 /**
  * Arguments passed to a route `clientLoader` function
  */
-type ClientLoaderFunctionArgs = LoaderFunctionArgs<undefined> & {
+type ClientLoaderFunctionArgs = LoaderFunctionArgs & {
     serverLoader: <T = unknown>() => Promise<SerializeFrom<T>>;
 };
 /**
@@ -1628,7 +1681,7 @@ type Serializable = undefined | null | boolean | string | symbol | number | Arra
  * in your application.
  */
 type unstable_SerializesTo<T> = {
-    unstable__ReactRouter_SerializesTo?: [T];
+    unstable__ReactRouter_SerializesTo: [T];
 };
 
 type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;
@@ -1649,4 +1702,4 @@ type ServerDataFrom<T> = ServerData<DataFrom<T>>;
 type ClientDataFrom<T> = ClientData<DataFrom<T>>;
 type SerializeFrom<T> = T extends (...args: infer Args) => unknown ? Args extends [ClientLoaderFunctionArgs | ClientActionFunctionArgs] ? ClientDataFrom<T> : ServerDataFrom<T> : T;
 
-export { type HTMLFormMethod as $, type ActionFunctionArgs as A, type BlockerFunction as B, type CreateStaticHandlerOptions as C, type DataStrategyFunction as D, type Equal as E, type FutureConfig as F, type GetScrollPositionFunction as G, type HydrationState as H, type InitialEntry as I, type RouterSubscriber as J, type RouterNavigateOptions as K, type LoaderFunctionArgs as L, type MetaFunction as M, type NavigateOptions as N, type RouterFetchOptions as O, type ParamParseKey as P, type DataStrategyFunctionArgs as Q, type RouteModules as R, type ServerRouteModule as S, type To as T, type UIMatch as U, type DataStrategyMatch as V, type DataStrategyResult as W, DataWithResponseInit as X, type ErrorResponse as Y, type FormEncType as Z, type FormMethod as _, type Router as a, type LazyRouteFunction as a0, type PathParam as a1, type RedirectFunction as a2, type ShouldRevalidateFunction as a3, type ShouldRevalidateFunctionArgs as a4, createPath as a5, parsePath as a6, IDLE_NAVIGATION as a7, IDLE_FETCHER as a8, IDLE_BLOCKER as a9, type unstable_SerializesTo as aA, createBrowserHistory as aB, invariant as aC, createRouter as aD, ErrorResponseImpl as aE, DataRouterContext as aF, DataRouterStateContext as aG, FetchersContext as aH, LocationContext as aI, NavigationContext as aJ, RouteContext as aK, ViewTransitionContext as aL, type RouteModule as aM, type History as aN, type ServerDataFrom as aO, type ClientDataFrom as aP, type Func as aQ, type Pretty as aR, data as aa, generatePath as ab, isRouteErrorResponse as ac, matchPath as ad, matchRoutes as ae, redirect as af, redirectDocument as ag, replace as ah, resolvePath as ai, type DataRouteMatch as aj, type DataRouteObject as ak, type Navigator as al, type PatchRoutesOnNavigationFunction as am, type PatchRoutesOnNavigationFunctionArgs as an, type RouteMatch as ao, type ClientActionFunction as ap, type ClientActionFunctionArgs as aq, type ClientLoaderFunction as ar, type ClientLoaderFunctionArgs as as, type HeadersArgs as at, type HeadersFunction as au, type MetaArgs as av, type MetaDescriptor as aw, type PageLinkDescriptor as ax, type HtmlLinkDescriptor as ay, type LinkDescriptor as az, type RouteManifest as b, type RelativeRoutingType as c, type Location as d, Action as e, type Path as f, type PathPattern as g, type PathMatch as h, type Params as i, type RouteObject as j, type Navigation as k, type RevalidationState as l, type SerializeFrom as m, type Blocker as n, type StaticHandlerContext as o, type StaticHandler as p, type IndexRouteObject as q, type LoaderFunction as r, type ActionFunction as s, type LinksFunction as t, type NonIndexRouteObject as u, type RouterState as v, type GetScrollRestorationKeyFunction as w, type Fetcher as x, type NavigationStates as y, type RouterInit as z };
+export { type FormEncType as $, type ActionFunctionArgs as A, type BlockerFunction as B, type CreateStaticHandlerOptions as C, type DataStrategyFunction as D, type Equal as E, type FutureConfig as F, type GetScrollPositionFunction as G, type HydrationState as H, type InitialEntry as I, type Fetcher as J, type NavigationStates as K, type LoaderFunctionArgs as L, type MetaFunction as M, type NavigateOptions as N, type RouterSubscriber as O, type ParamParseKey as P, type RouterNavigateOptions as Q, type RouterInit as R, type ServerRouteModule as S, type To as T, type UIMatch as U, type RouterFetchOptions as V, type DataStrategyFunctionArgs as W, type DataStrategyMatch as X, type DataStrategyResult as Y, DataWithResponseInit as Z, type ErrorResponse as _, type RouteModules as a, type FormMethod as a0, type HTMLFormMethod as a1, type LazyRouteFunction as a2, type unstable_MiddlewareFunction as a3, type PathParam as a4, type RedirectFunction as a5, type unstable_RouterContext as a6, type ShouldRevalidateFunction as a7, type ShouldRevalidateFunctionArgs as a8, unstable_createContext as a9, type MetaArgs as aA, type MetaDescriptor as aB, type PageLinkDescriptor as aC, type HtmlLinkDescriptor as aD, type LinkDescriptor as aE, type unstable_SerializesTo as aF, createBrowserHistory as aG, invariant as aH, createRouter as aI, ErrorResponseImpl as aJ, DataRouterContext as aK, DataRouterStateContext as aL, FetchersContext as aM, LocationContext as aN, NavigationContext as aO, RouteContext as aP, ViewTransitionContext as aQ, type RouteModule as aR, type History as aS, type ServerDataFrom as aT, type ClientDataFrom as aU, type Func as aV, type unstable_MiddlewareNextFunction as aW, type Pretty as aX, createPath as aa, parsePath as ab, IDLE_NAVIGATION as ac, IDLE_FETCHER as ad, IDLE_BLOCKER as ae, data as af, generatePath as ag, isRouteErrorResponse as ah, matchPath as ai, matchRoutes as aj, redirect as ak, redirectDocument as al, replace as am, resolvePath as an, type DataRouteMatch as ao, type DataRouteObject as ap, type Navigator as aq, type PatchRoutesOnNavigationFunction as ar, type PatchRoutesOnNavigationFunctionArgs as as, type RouteMatch as at, type ClientActionFunction as au, type ClientActionFunctionArgs as av, type ClientLoaderFunction as aw, type ClientLoaderFunctionArgs as ax, type HeadersArgs as ay, type HeadersFunction as az, type Router as b, type RouteManifest as c, type RelativeRoutingType as d, type Location as e, Action as f, type Path as g, type PathPattern as h, type PathMatch as i, type Params as j, type RouteObject as k, type Navigation as l, type RevalidationState as m, type SerializeFrom as n, type Blocker as o, type StaticHandlerContext as p, type StaticHandler as q, type unstable_InitialContext as r, type IndexRouteObject as s, type LoaderFunction as t, unstable_RouterContextProvider as u, type ActionFunction as v, type LinksFunction as w, type NonIndexRouteObject as x, type RouterState as y, type GetScrollRestorationKeyFunction as z };

package/dist/development/{route-data-BmvbmBej.d.mts → route-data-H2S3hwhf.d.ts}

@@ -260,6 +260,34 @@ type Submission = {
     json: undefined;
     text: string;
 };
+interface unstable_RouterContext<T = unknown> {
+    defaultValue?: T;
+}
+/**
+ * Creates a context object that may be used to store and retrieve arbitrary values.
+ *
+ * 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.
+ *
+ * @param defaultValue The default value for the context
+ * @returns A context object
+ */
+declare function unstable_createContext<T>(defaultValue?: T): unstable_RouterContext<T>;
+/**
+ * A Map of RouterContext objects to their initial values - used to populate a
+ * fresh `context` value per request/navigation/fetch
+ */
+type unstable_InitialContext = Map<unstable_RouterContext, unknown>;
+/**
+ * Provides methods for writing/reading values in application context in a typesafe way.
+ */
+declare class unstable_RouterContextProvider {
+    #private;
+    constructor(init?: unstable_InitialContext);
+    get<T>(context: unstable_RouterContext<T>): T;
+    set<C extends unstable_RouterContext>(context: C, value: C extends unstable_RouterContext<infer T> ? T : never): void;
+}
 /**
  * @private
  * Arguments passed to route loader/action functions.  Same for now but we keep
@@ -288,8 +316,22 @@ interface DataFunctionArgs<Context> {
      * It's a way to bridge the gap between the adapter's request/response API with your React Router app.
      * It is only applicable if you are using a custom server adapter.
      */
-    context?: Context;
+    context: Context;
 }
+/**
+ * Route middleware `next` function to call downstream handlers and then complete
+ * middlewares from the bottom-up
+ */
+interface unstable_MiddlewareNextFunction<Result = unknown> {
+    (): Result | Promise<Result>;
+}
+/**
+ * Route middleware function signature.  Receives the same "data" arguments as a
+ * `loader`/`action` (`request`, `params`, `context`) as the first parameter and
+ * a `next` function as the second parameter which will call downstream handlers
+ * and then complete middlewares from the bottom-up
+ */
+type unstable_MiddlewareFunction<Result = unknown> = (args: DataFunctionArgs<unstable_RouterContextProvider>, next: unstable_MiddlewareNextFunction<Result>) => Result | Promise<Result>;
 /**
  * Arguments passed to loader functions
  */
@@ -301,11 +343,9 @@ interface LoaderFunctionArgs<Context = any> extends DataFunctionArgs<Context> {
 interface ActionFunctionArgs<Context = any> extends DataFunctionArgs<Context> {
 }
 /**
- * Loaders and actions can return anything except `undefined` (`null` is a
- * valid return value if there is no data to return).  Responses are preferred
- * and will ease any future migration to Remix
+ * Loaders and actions can return anything
  */
-type DataFunctionValue = Response | NonNullable<unknown> | null;
+type DataFunctionValue = unknown;
 type DataFunctionReturnValue = Promise<DataFunctionValue> | DataFunctionValue;
 /**
  * Route loader function signature
@@ -402,13 +442,14 @@ interface DataStrategyResult {
     type: "data" | "error";
     result: unknown;
 }
-interface DataStrategyFunction {
-    (args: DataStrategyFunctionArgs): Promise<Record<string, DataStrategyResult>>;
+interface DataStrategyFunction<Context = any> {
+    (args: DataStrategyFunctionArgs<Context>): Promise<Record<string, DataStrategyResult>>;
 }
 type AgnosticPatchRoutesOnNavigationFunctionArgs<O extends AgnosticRouteObject = AgnosticRouteObject, M extends AgnosticRouteMatch = AgnosticRouteMatch> = {
     signal: AbortSignal;
     path: string;
     matches: M[];
+    fetcherKey: string | undefined;
     patch: (routeId: string | null, children: O[]) => void;
 };
 type AgnosticPatchRoutesOnNavigationFunction<O extends AgnosticRouteObject = AgnosticRouteObject, M extends AgnosticRouteMatch = AgnosticRouteMatch> = (opts: AgnosticPatchRoutesOnNavigationFunctionArgs<O, M>) => void | Promise<void>;
@@ -444,6 +485,7 @@ type AgnosticBaseRouteObject = {
     caseSensitive?: boolean;
     path?: string;
     id?: string;
+    unstable_middleware?: unstable_MiddlewareFunction[];
     loader?: LoaderFunction | boolean;
     action?: ActionFunction | boolean;
     hasErrorBoundary?: boolean;
@@ -669,6 +711,7 @@ declare class ErrorResponseImpl implements ErrorResponse {
  */
 declare function isRouteErrorResponse(error: any): error is ErrorResponse;
 
+type MaybePromise<T> = T | Promise<T>;
 /**
  * A Router instance manages all navigation and data loading/mutations
  */
@@ -924,6 +967,7 @@ type HydrationState = Partial<Pick<RouterState, "loaderData" | "actionData" | "e
  * Future flags to toggle new feature behavior
  */
 interface FutureConfig {
+    unstable_middleware: boolean;
 }
 /**
  * Initialization options for createRouter
@@ -932,6 +976,7 @@ interface RouterInit {
     routes: AgnosticRouteObject[];
     history: History;
     basename?: string;
+    unstable_getContext?: () => MaybePromise<unstable_InitialContext>;
     mapRouteProperties?: MapRoutePropertiesFunction;
     future?: Partial<FutureConfig>;
     hydrationData?: HydrationState;
@@ -961,13 +1006,17 @@ interface StaticHandler {
     dataRoutes: AgnosticDataRouteObject[];
     query(request: Request, opts?: {
         requestContext?: unknown;
+        filterMatchesToLoad?: (match: AgnosticDataRouteMatch) => boolean;
         skipLoaderErrorBubbling?: boolean;
-        dataStrategy?: DataStrategyFunction;
+        skipRevalidation?: boolean;
+        dataStrategy?: DataStrategyFunction<unknown>;
+        unstable_respond?: (staticContext: StaticHandlerContext) => MaybePromise<Response>;
     }): Promise<StaticHandlerContext | Response>;
     queryRoute(request: Request, opts?: {
         routeId?: string;
         requestContext?: unknown;
-        dataStrategy?: DataStrategyFunction;
+        dataStrategy?: DataStrategyFunction<unknown>;
+        unstable_respond?: (res: Response) => MaybePromise<Response>;
     }): Promise<any>;
 }
 type ViewTransitionOpts = {
@@ -1201,6 +1250,7 @@ interface IndexRouteObject {
     caseSensitive?: AgnosticIndexRouteObject["caseSensitive"];
     path?: AgnosticIndexRouteObject["path"];
     id?: AgnosticIndexRouteObject["id"];
+    unstable_middleware?: AgnosticIndexRouteObject["unstable_middleware"];
     loader?: AgnosticIndexRouteObject["loader"];
     action?: AgnosticIndexRouteObject["action"];
     hasErrorBoundary?: AgnosticIndexRouteObject["hasErrorBoundary"];
@@ -1220,6 +1270,7 @@ interface NonIndexRouteObject {
     caseSensitive?: AgnosticNonIndexRouteObject["caseSensitive"];
     path?: AgnosticNonIndexRouteObject["path"];
     id?: AgnosticNonIndexRouteObject["id"];
+    unstable_middleware?: AgnosticNonIndexRouteObject["unstable_middleware"];
     loader?: AgnosticNonIndexRouteObject["loader"];
     action?: AgnosticNonIndexRouteObject["action"];
     hasErrorBoundary?: AgnosticNonIndexRouteObject["hasErrorBoundary"];
@@ -1425,6 +1476,7 @@ interface RouteModules {
 interface RouteModule {
     clientAction?: ClientActionFunction;
     clientLoader?: ClientLoaderFunction;
+    unstable_clientMiddleware?: unstable_MiddlewareFunction<undefined>[];
     ErrorBoundary?: ErrorBoundaryComponent;
     HydrateFallback?: HydrateFallbackComponent;
     Layout?: LayoutComponent;
@@ -1443,6 +1495,7 @@ interface ServerRouteModule extends RouteModule {
         [name: string]: string;
     };
     loader?: LoaderFunction;
+    unstable_middleware?: unstable_MiddlewareFunction<Response>[];
 }
 /**
  * A function that handles data mutations for a route on the client
@@ -1451,7 +1504,7 @@ type ClientActionFunction = (args: ClientActionFunctionArgs) => ReturnType<Actio
 /**
  * Arguments passed to a route `clientAction` function
  */
-type ClientActionFunctionArgs = ActionFunctionArgs<undefined> & {
+type ClientActionFunctionArgs = ActionFunctionArgs & {
     serverAction: <T = unknown>() => Promise<SerializeFrom<T>>;
 };
 /**
@@ -1463,7 +1516,7 @@ type ClientLoaderFunction = ((args: ClientLoaderFunctionArgs) => ReturnType<Load
 /**
  * Arguments passed to a route `clientLoader` function
  */
-type ClientLoaderFunctionArgs = LoaderFunctionArgs<undefined> & {
+type ClientLoaderFunctionArgs = LoaderFunctionArgs & {
     serverLoader: <T = unknown>() => Promise<SerializeFrom<T>>;
 };
 /**
@@ -1628,7 +1681,7 @@ type Serializable = undefined | null | boolean | string | symbol | number | Arra
  * in your application.
  */
 type unstable_SerializesTo<T> = {
-    unstable__ReactRouter_SerializesTo?: [T];
+    unstable__ReactRouter_SerializesTo: [T];
 };
 
 type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;
@@ -1649,4 +1702,4 @@ type ServerDataFrom<T> = ServerData<DataFrom<T>>;
 type ClientDataFrom<T> = ClientData<DataFrom<T>>;
 type SerializeFrom<T> = T extends (...args: infer Args) => unknown ? Args extends [ClientLoaderFunctionArgs | ClientActionFunctionArgs] ? ClientDataFrom<T> : ServerDataFrom<T> : T;
 
-export { type HTMLFormMethod as $, type ActionFunctionArgs as A, type BlockerFunction as B, type CreateStaticHandlerOptions as C, type DataStrategyFunction as D, type Equal as E, type FutureConfig as F, type GetScrollPositionFunction as G, type HydrationState as H, type InitialEntry as I, type RouterSubscriber as J, type RouterNavigateOptions as K, type LoaderFunctionArgs as L, type MetaFunction as M, type NavigateOptions as N, type RouterFetchOptions as O, type ParamParseKey as P, type DataStrategyFunctionArgs as Q, type RouteModules as R, type ServerRouteModule as S, type To as T, type UIMatch as U, type DataStrategyMatch as V, type DataStrategyResult as W, DataWithResponseInit as X, type ErrorResponse as Y, type FormEncType as Z, type FormMethod as _, type Router as a, type LazyRouteFunction as a0, type PathParam as a1, type RedirectFunction as a2, type ShouldRevalidateFunction as a3, type ShouldRevalidateFunctionArgs as a4, createPath as a5, parsePath as a6, IDLE_NAVIGATION as a7, IDLE_FETCHER as a8, IDLE_BLOCKER as a9, type unstable_SerializesTo as aA, createBrowserHistory as aB, invariant as aC, createRouter as aD, ErrorResponseImpl as aE, DataRouterContext as aF, DataRouterStateContext as aG, FetchersContext as aH, LocationContext as aI, NavigationContext as aJ, RouteContext as aK, ViewTransitionContext as aL, type RouteModule as aM, type History as aN, type ServerDataFrom as aO, type ClientDataFrom as aP, type Func as aQ, type Pretty as aR, data as aa, generatePath as ab, isRouteErrorResponse as ac, matchPath as ad, matchRoutes as ae, redirect as af, redirectDocument as ag, replace as ah, resolvePath as ai, type DataRouteMatch as aj, type DataRouteObject as ak, type Navigator as al, type PatchRoutesOnNavigationFunction as am, type PatchRoutesOnNavigationFunctionArgs as an, type RouteMatch as ao, type ClientActionFunction as ap, type ClientActionFunctionArgs as aq, type ClientLoaderFunction as ar, type ClientLoaderFunctionArgs as as, type HeadersArgs as at, type HeadersFunction as au, type MetaArgs as av, type MetaDescriptor as aw, type PageLinkDescriptor as ax, type HtmlLinkDescriptor as ay, type LinkDescriptor as az, type RouteManifest as b, type RelativeRoutingType as c, type Location as d, Action as e, type Path as f, type PathPattern as g, type PathMatch as h, type Params as i, type RouteObject as j, type Navigation as k, type RevalidationState as l, type SerializeFrom as m, type Blocker as n, type StaticHandlerContext as o, type StaticHandler as p, type IndexRouteObject as q, type LoaderFunction as r, type ActionFunction as s, type LinksFunction as t, type NonIndexRouteObject as u, type RouterState as v, type GetScrollRestorationKeyFunction as w, type Fetcher as x, type NavigationStates as y, type RouterInit as z };
+export { type FormEncType as $, type ActionFunctionArgs as A, type BlockerFunction as B, type CreateStaticHandlerOptions as C, type DataStrategyFunction as D, type Equal as E, type FutureConfig as F, type GetScrollPositionFunction as G, type HydrationState as H, type InitialEntry as I, type Fetcher as J, type NavigationStates as K, type LoaderFunctionArgs as L, type MetaFunction as M, type NavigateOptions as N, type RouterSubscriber as O, type ParamParseKey as P, type RouterNavigateOptions as Q, type RouterInit as R, type ServerRouteModule as S, type To as T, type UIMatch as U, type RouterFetchOptions as V, type DataStrategyFunctionArgs as W, type DataStrategyMatch as X, type DataStrategyResult as Y, DataWithResponseInit as Z, type ErrorResponse as _, type RouteModules as a, type FormMethod as a0, type HTMLFormMethod as a1, type LazyRouteFunction as a2, type unstable_MiddlewareFunction as a3, type PathParam as a4, type RedirectFunction as a5, type unstable_RouterContext as a6, type ShouldRevalidateFunction as a7, type ShouldRevalidateFunctionArgs as a8, unstable_createContext as a9, type MetaArgs as aA, type MetaDescriptor as aB, type PageLinkDescriptor as aC, type HtmlLinkDescriptor as aD, type LinkDescriptor as aE, type unstable_SerializesTo as aF, createBrowserHistory as aG, invariant as aH, createRouter as aI, ErrorResponseImpl as aJ, DataRouterContext as aK, DataRouterStateContext as aL, FetchersContext as aM, LocationContext as aN, NavigationContext as aO, RouteContext as aP, ViewTransitionContext as aQ, type RouteModule as aR, type History as aS, type ServerDataFrom as aT, type ClientDataFrom as aU, type Func as aV, type unstable_MiddlewareNextFunction as aW, type Pretty as aX, createPath as aa, parsePath as ab, IDLE_NAVIGATION as ac, IDLE_FETCHER as ad, IDLE_BLOCKER as ae, data as af, generatePath as ag, isRouteErrorResponse as ah, matchPath as ai, matchRoutes as aj, redirect as ak, redirectDocument as al, replace as am, resolvePath as an, type DataRouteMatch as ao, type DataRouteObject as ap, type Navigator as aq, type PatchRoutesOnNavigationFunction as ar, type PatchRoutesOnNavigationFunctionArgs as as, type RouteMatch as at, type ClientActionFunction as au, type ClientActionFunctionArgs as av, type ClientLoaderFunction as aw, type ClientLoaderFunctionArgs as ax, type HeadersArgs as ay, type HeadersFunction as az, type Router as b, type RouteManifest as c, type RelativeRoutingType as d, type Location as e, Action as f, type Path as g, type PathPattern as h, type PathMatch as i, type Params as j, type RouteObject as k, type Navigation as l, type RevalidationState as m, type SerializeFrom as n, type Blocker as o, type StaticHandlerContext as p, type StaticHandler as q, type unstable_InitialContext as r, type IndexRouteObject as s, type LoaderFunction as t, unstable_RouterContextProvider as u, type ActionFunction as v, type LinksFunction as w, type NonIndexRouteObject as x, type RouterState as y, type GetScrollRestorationKeyFunction as z };