react-router 0.0.0-experimental-b588f7e → 0.0.0-experimental-23decd7bc

package/dist/production/{route-data-ByAYLHuM.d.mts → route-data-x_b_BLCv.d.ts}

@@ -1,6 +1,16 @@
 import * as React from 'react';
 import { ComponentType, ReactElement } from 'react';
 
+/**
+ * An augmentable interface users can modify in their app-code to opt into
+ * future-flag-specific types
+ */
+interface Future {
+}
+type MiddlewareEnabled = Future extends {
+    unstable_middleware: infer T extends boolean;
+} ? T : false;
+
 /**
  * Actions represent the type of change to a location value.
  */
@@ -206,16 +216,6 @@ type UrlHistoryOptions = {
     v5Compat?: boolean;
 };
 
-/**
- * An augmentable interface users can modify in their app-code to opt into
- * future-flag-specific types
- */
-interface Future {
-}
-type MiddlewareEnabled = Future extends {
-    unstable_middleware: infer T extends boolean;
-} ? T : false;
-
 type MaybePromise<T> = T | Promise<T>;
 /**
  * Map of routeId -> data returned from a loader/action/error
@@ -912,8 +912,11 @@ interface Router {
      * @param routeId The parent route id or a callback function accepting `patch`
      *                to perform batch patching
      * @param children The additional children routes
+     * @param unstable_allowElementMutations Allow mutation or route elements on
+     *                                       existing routes. Intended for RSC-usage
+     *                                       only.
      */
-    patchRoutes(routeId: string | null, children: AgnosticRouteObject[]): void;
+    patchRoutes(routeId: string | null, children: AgnosticRouteObject[], unstable_allowElementMutations?: boolean): void;
     /**
      * @private
      * PRIVATE - DO NOT USE
@@ -922,6 +925,13 @@ interface Router {
      * TODO: Replace this with granular route update APIs (addRoute, updateRoute, deleteRoute)
      */
     _internalSetRoutes(routes: AgnosticRouteObject[]): void;
+    /**
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Cause subscribers to re-render.  This is used to force a re-render.
+     */
+    _internalSetStateDoNotUseOrYouWillBreakYourApp(state: Partial<RouterState>): void;
     /**
      * @private
      * PRIVATE - DO NOT USE
@@ -1045,6 +1055,7 @@ interface StaticHandler {
         skipRevalidation?: boolean;
         dataStrategy?: DataStrategyFunction<unknown>;
         unstable_respond?: (staticContext: StaticHandlerContext) => MaybePromise<Response>;
+        unstable_stream?: (context: unstable_RouterContextProvider, query: (r: Request) => Promise<StaticHandlerContext | Response>) => MaybePromise<Response>;
     }): Promise<StaticHandlerContext | Response>;
     queryRoute(request: Request, opts?: {
         routeId?: string;
@@ -1767,7 +1778,73 @@ type ClientData<T> = T extends Response ? never : T extends DataWithResponseInit
 type ServerData<T> = T extends Response ? never : T extends DataWithResponseInit<infer U> ? Serialize<U> : Serialize<T>;
 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;
+type ClientDataFunctionArgs<Params> = {
+    /**
+     * A {@link https://developer.mozilla.org/en-US/docs/Web/API/Request Fetch Request instance} which you can use to read the URL, the method, the "content-type" header, and the request body from the request.
+     *
+     * @note Because client data functions are called before a network request is made, the Request object does not include the headers which the browser automatically adds. React Router infers the "content-type" header from the enc-type of the form that performed the submission.
+     **/
+    request: Request;
+    /**
+     * {@link https://reactrouter.com/start/framework/routing#dynamic-segments Dynamic route params} for the current route.
+     * @example
+     * // app/routes.ts
+     * route("teams/:teamId", "./team.tsx"),
+     *
+     * // app/team.tsx
+     * export function clientLoader({
+     *   params,
+     * }: Route.ClientLoaderArgs) {
+     *   params.teamId;
+     *   //        ^ string
+     * }
+     **/
+    params: 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<Params> = {
+    /** 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. */
+    request: Request;
+    /**
+     * {@link https://reactrouter.com/start/framework/routing#dynamic-segments Dynamic route params} for the current route.
+     * @example
+     * // app/routes.ts
+     * route("teams/:teamId", "./team.tsx"),
+     *
+     * // app/team.tsx
+     * export function loader({
+     *   params,
+     * }: Route.LoaderArgs) {
+     *   params.teamId;
+     *   //        ^ string
+     * }
+     **/
+    params: Params;
+    /**
+     * 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: MiddlewareEnabled extends true ? unstable_RouterContextProvider : AppLoadContext;
+};
+type SerializeFrom<T> = T extends (...args: infer Args) => unknown ? Args extends [
+    ClientLoaderFunctionArgs | ClientActionFunctionArgs | ClientDataFunctionArgs<unknown>
+] ? ClientDataFrom<T> : ServerDataFrom<T> : T;
 type IsDefined<T> = Equal<T, undefined> extends true ? false : true;
 type IsHydrate<ClientLoader> = ClientLoader extends {
     hydrate: true;
@@ -1790,4 +1867,4 @@ type _DataActionData<ServerActionData, ClientActionData> = Awaited<[
     IsDefined<ClientActionData>
 ] extends [true, true] ? ServerActionData | ClientActionData : IsDefined<ClientActionData> extends true ? ClientActionData : IsDefined<ServerActionData> extends true ? ServerActionData : undefined>;
 
-export { type Params as $, type ActionFunction as A, type Blocker 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 DataStrategyMatch as J, type DataStrategyResult as K, type Location as L, type MetaFunction as M, type NonIndexRouteObject as N, DataWithResponseInit as O, type PatchRoutesOnNavigationFunction as P, type ErrorResponse as Q, type RouterInit as R, type StaticHandlerContext as S, type To as T, type FormEncType as U, type FormMethod as V, type HTMLFormMethod as W, type LazyRouteFunction as X, type LoaderFunctionArgs as Y, type unstable_MiddlewareFunction as Z, type ParamParseKey as _, type Router as a, type GetActionData as a$, type PathMatch as a0, type PathParam as a1, type PathPattern as a2, type RedirectFunction as a3, type unstable_RouterContext as a4, type ShouldRevalidateFunction as a5, type ShouldRevalidateFunctionArgs as a6, type UIMatch as a7, unstable_createContext as a8, unstable_RouterContextProvider as a9, type MetaDescriptor as aA, type PageLinkDescriptor as aB, type HtmlLinkDescriptor as aC, type LinkDescriptor as aD, type Future 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 RouteManifest as aR, type ServerRouteModule as aS, type SerializeFrom as aT, type History as aU, type RouteModule as aV, type unstable_MiddlewareNextFunction as aW, type ServerDataFrom as aX, type Pretty as aY, type GetLoaderData as aZ, type Normalize as a_, Action as aa, createPath as ab, parsePath as ac, IDLE_NAVIGATION as ad, IDLE_FETCHER as ae, IDLE_BLOCKER as af, data as ag, generatePath as ah, isRouteErrorResponse as ai, matchPath as aj, matchRoutes as ak, redirect as al, redirectDocument as am, replace as an, resolvePath as ao, type DataRouteMatch as ap, type NavigateOptions as aq, type Navigator as ar, type PatchRoutesOnNavigationFunctionArgs as as, type RouteMatch as at, type ClientActionFunction as au, type ClientActionFunctionArgs as av, type ClientLoaderFunctionArgs as aw, type HeadersArgs as ax, type HeadersFunction as ay, type MetaArgs as az, type RouteModules as b, type RouteObject as c, type StaticHandler as d, type IndexRouteObject as e, type LoaderFunction as f, type LinksFunction as g, type MiddlewareEnabled as h, type AppLoadContext as i, type RouterState as j, type DataRouteObject as k, type ClientLoaderFunction as l, type Path as m, type GetScrollRestorationKeyFunction as n, type Fetcher as o, type Navigation as p, type NavigationStates as q, type RelativeRoutingType as r, type BlockerFunction as s, type RouterSubscriber as t, type unstable_InitialContext as u, type RouterNavigateOptions as v, type RouterFetchOptions as w, type RevalidationState as x, type ActionFunctionArgs as y, type DataStrategyFunctionArgs as z };
+export { type DataStrategyFunctionArgs as $, type ActionFunction as A, type StaticHandlerContext as B, type ClientDataFunctionArgs as C, type DataStrategyFunction as D, type Equal as E, type Fetcher as F, type GetLoaderData as G, type HydrationState as H, type InitialEntry as I, type Navigation as J, type NavigationStates as K, type LinkDescriptor as L, type MetaDescriptor as M, type Normalize as N, type RelativeRoutingType as O, type Pretty as P, type Blocker as Q, type RouteModule as R, type ServerDataFunctionArgs as S, type To as T, type BlockerFunction as U, type RouterInit as V, type RouterSubscriber as W, type RouterNavigateOptions as X, type RouterFetchOptions as Y, type RevalidationState as Z, type ActionFunctionArgs as _, type Location as a, type FutureConfig as a$, type DataStrategyMatch as a0, type DataStrategyResult as a1, DataWithResponseInit as a2, type ErrorResponse as a3, type FormEncType as a4, type FormMethod as a5, type HTMLFormMethod as a6, type LazyRouteFunction as a7, type LoaderFunctionArgs as a8, type unstable_MiddlewareFunction as a9, type NavigateOptions as aA, type Navigator as aB, type PatchRoutesOnNavigationFunctionArgs as aC, type RouteMatch as aD, type RouteObject as aE, type ClientActionFunctionArgs as aF, type ClientLoaderFunctionArgs as aG, type HeadersArgs as aH, type MetaArgs as aI, type PageLinkDescriptor as aJ, type HtmlLinkDescriptor as aK, type Future as aL, type unstable_SerializesTo as aM, createBrowserHistory as aN, invariant as aO, createRouter as aP, ErrorResponseImpl as aQ, DataRouterContext as aR, DataRouterStateContext as aS, FetchersContext as aT, LocationContext as aU, NavigationContext as aV, RouteContext as aW, ViewTransitionContext as aX, type RouteManifest as aY, type ServerRouteModule as aZ, type SerializeFrom as a_, type ParamParseKey as aa, type PathMatch as ab, type PathParam as ac, type PathPattern as ad, type RedirectFunction as ae, type unstable_RouterContext as af, type ShouldRevalidateFunctionArgs as ag, type UIMatch as ah, unstable_createContext as ai, unstable_RouterContextProvider as aj, Action as ak, createPath as al, parsePath as am, IDLE_NAVIGATION as an, IDLE_FETCHER as ao, IDLE_BLOCKER as ap, data as aq, generatePath as ar, isRouteErrorResponse as as, matchPath as at, matchRoutes as au, redirect as av, redirectDocument as aw, replace as ax, resolvePath as ay, type DataRouteMatch as az, type ServerDataFrom as b, type History as b0, type CreateStaticHandlerOptions as b1, type GetActionData as c, type Router as d, type RouteModules as e, type IndexRouteObject as f, type LoaderFunction as g, type MetaFunction as h, type LinksFunction as i, type NonIndexRouteObject as j, type unstable_InitialContext as k, type MiddlewareEnabled as l, type AppLoadContext as m, type ClientActionFunction as n, type ClientLoaderFunction as o, type HeadersFunction as p, type ShouldRevalidateFunction as q, type Params as r, type RouterState as s, type PatchRoutesOnNavigationFunction as t, type unstable_MiddlewareNextFunction as u, type DataRouteObject as v, type Path as w, type StaticHandler as x, type GetScrollPositionFunction as y, type GetScrollRestorationKeyFunction as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-router",
-  "version": "0.0.0-experimental-b588f7e",
+  "version": "0.0.0-experimental-23decd7bc",
   "description": "Declarative routing for React",
   "keywords": [
     "react",
@@ -23,11 +23,20 @@
   "module": "./dist/development/index.mjs",
   "exports": {
     ".": {
+      "react-server": {
+        "module": "./dist/development/index-react-server.mjs",
+        "default": "./dist/development/index-react-server.js"
+      },
       "node": {
         "types": "./dist/development/index.d.ts",
+        "module": "./dist/development/index.mjs",
         "module-sync": "./dist/development/index.mjs",
         "default": "./dist/development/index.js"
       },
+      "module": {
+        "types": "./dist/development/index.d.mts",
+        "default": "./dist/development/index.mjs"
+      },
       "import": {
         "types": "./dist/development/index.d.mts",
         "default": "./dist/development/index.mjs"
@@ -37,6 +46,26 @@
         "default": "./dist/development/index.js"
       }
     },
+    "./dom": {
+      "node": {
+        "types": "./dist/development/dom-export.d.ts",
+        "module": "./dist/development/dom-export.mjs",
+        "module-sync": "./dist/development/dom-export.mjs",
+        "default": "./dist/development/dom-export.js"
+      },
+      "module": {
+        "types": "./dist/development/dom-export.d.mts",
+        "default": "./dist/development/dom-export.mjs"
+      },
+      "import": {
+        "types": "./dist/development/dom-export.d.mts",
+        "default": "./dist/development/dom-export.mjs"
+      },
+      "default": {
+        "types": "./dist/development/dom-export.d.ts",
+        "default": "./dist/development/dom-export.js"
+      }
+    },
     "./internal": {
       "node": {
         "types": "./dist/development/lib/types/internal.d.ts"
@@ -48,26 +77,35 @@
         "types": "./dist/development/lib/types/index.d.ts"
       }
     },
-    "./dom": {
+    "./internal/react-server-client": {
+      "react-server": {
+        "module": "./dist/development/index-react-server-client.mjs",
+        "default": "./dist/development/index-react-server-client.js"
+      },
       "node": {
-        "types": "./dist/development/dom-export.d.ts",
-        "module-sync": "./dist/development/dom-export.mjs",
-        "default": "./dist/development/dom-export.js"
+        "types": "./dist/development/index.d.ts",
+        "module": "./dist/development/index.mjs",
+        "module-sync": "./dist/development/index.mjs",
+        "default": "./dist/development/index.js"
+      },
+      "module": {
+        "types": "./dist/development/index.d.mts",
+        "default": "./dist/development/index.mjs"
       },
       "import": {
-        "types": "./dist/development/dom-export.d.mts",
-        "default": "./dist/development/dom-export.mjs"
+        "types": "./dist/development/index.d.mts",
+        "default": "./dist/development/index.mjs"
       },
       "default": {
-        "types": "./dist/development/dom-export.d.ts",
-        "default": "./dist/development/dom-export.js"
+        "types": "./dist/development/index.d.ts",
+        "default": "./dist/development/index.js"
       }
     },
     "./package.json": "./package.json"
   },
   "wireit": {
     "build": {
-      "command": "rimraf dist && tsup",
+      "command": "rimraf dist && tsup && tsup --config tsup.config.rsc.ts",
       "files": [
         "lib/**",
         "*.ts",
@@ -112,6 +150,7 @@
   },
   "scripts": {
     "build": "wireit",
+    "watch": "tsup --watch & tsup --config tsup.config.rsc.ts --watch",
     "typecheck": "tsc"
   }
 }