react-router 8.0.1 → 8.2.0

package/dist/development/lib/dom/ssr/components.js

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

package/dist/development/lib/dom/ssr/data.js

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

package/dist/development/lib/dom/ssr/errorBoundaries.js

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

package/dist/development/lib/dom/ssr/fallback.js

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

package/dist/development/lib/dom/ssr/fog-of-war.js

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

package/dist/development/lib/dom/ssr/hydration.js

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

package/dist/development/lib/dom/ssr/invariant.js

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

package/dist/development/lib/dom/ssr/links.js

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

package/dist/development/lib/dom/ssr/markup.js

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

package/dist/development/lib/dom/ssr/routeModules.js

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

package/dist/development/lib/dom/ssr/routes-test-stub.js

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

package/dist/development/lib/dom/ssr/routes.js

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

package/dist/development/lib/dom/ssr/server.js

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

package/dist/development/lib/dom/ssr/single-fetch.js

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

package/dist/development/lib/dom-export/dom-router-provider.js

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

package/dist/development/lib/dom-export/hydrated-router.js

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

package/dist/development/lib/errors.js

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

package/dist/development/lib/hooks.d.ts

@@ -143,12 +143,16 @@ interface NavigateFunction {
  * All properties are optional.
  *
  * ```tsx
- * navigate({
- *   pathname: "/some/route",
- *   search: "?search=param",
- *   hash: "#hash",
- *   state: { some: "state" },
- * });
+ * navigate(
+ *   {
+ *     pathname: "/some/route",
+ *     search: "?search=param",
+ *     hash: "#hash",
+ *   },
+ *   {
+ *     state: { some: "state" },
+ *   },
+ * );
  * ```
  *
  * If you use `state`, that will be available on the {@link Location} object on
@@ -576,6 +580,29 @@ declare function useRevalidator(): {
  * parent/child routes or the route [`handle`](../../start/framework/route-module#handle)
  * property
  *
+ * Pairing the route `handle` with `useMatches` gets very powerful since you can put
+ * whatever you want on a route handle and have access to `useMatches` anywhere.
+ * Please see the [handle](../../how-to/using-handle) documentation for an example
+ * of breadcrumbs via `useMatches`/`handle`.
+ *
+ * ```tsx
+ * import { useMatches } from "react-router";
+ *
+ * function SomeComponent() {
+ *   const matches = useMatches();
+ *   // matches[i].id          // route id
+ *   // matches[i].pathname    // the portion of the URL the route matched
+ *   // matches[i].params      // the parsed params from the URL
+ *   // matches[i].loaderData  // the data from the loader
+ *   // matches[i].handle      // the route handle with any app specific data
+ * }
+ * ```
+ *
+ * <docs-info>useMatches only works with a data router like `createBrowserRouter`,
+ * since they know the full route tree up front and can provide all of the current
+ * matches. Additionally, `useMatches` will not match down into any descendant route
+ * trees since the router isn't aware of the descendant routes.</docs-info>
+ *
  * @public
  * @category Hooks
  * @mode framework

package/dist/development/lib/hooks.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.0.1
+ * react-router v8.2.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -162,12 +162,16 @@ const navigateEffectWarning = "You should call navigate() in a React.useEffect()
 * All properties are optional.
 *
 * ```tsx
-* navigate({
-*   pathname: "/some/route",
-*   search: "?search=param",
-*   hash: "#hash",
-*   state: { some: "state" },
-* });
+* navigate(
+*   {
+*     pathname: "/some/route",
+*     search: "?search=param",
+*     hash: "#hash",
+*   },
+*   {
+*     state: { some: "state" },
+*   },
+* );
 * ```
 *
 * If you use `state`, that will be available on the {@link Location} object on
@@ -919,6 +923,29 @@ function useRevalidator() {
 * parent/child routes or the route [`handle`](../../start/framework/route-module#handle)
 * property
 *
+* Pairing the route `handle` with `useMatches` gets very powerful since you can put
+* whatever you want on a route handle and have access to `useMatches` anywhere.
+* Please see the [handle](../../how-to/using-handle) documentation for an example
+* of breadcrumbs via `useMatches`/`handle`.
+*
+* ```tsx
+* import { useMatches } from "react-router";
+*
+* function SomeComponent() {
+*   const matches = useMatches();
+*   // matches[i].id          // route id
+*   // matches[i].pathname    // the portion of the URL the route matched
+*   // matches[i].params      // the parsed params from the URL
+*   // matches[i].loaderData  // the data from the loader
+*   // matches[i].handle      // the route handle with any app specific data
+* }
+* ```
+*
+* <docs-info>useMatches only works with a data router like `createBrowserRouter`,
+* since they know the full route tree up front and can provide all of the current
+* matches. Additionally, `useMatches` will not match down into any descendant route
+* trees since the router isn't aware of the descendant routes.</docs-info>
+*
 * @public
 * @category Hooks
 * @mode framework

package/dist/development/lib/href.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.0.1
+ * react-router v8.2.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -9,6 +9,9 @@
  * @license MIT
  */
 //#region lib/href.ts
+function stringify(p) {
+	return p == null ? "" : typeof p === "string" ? p : String(p);
+}
 /**
 Returns a resolved URL path for the specified route.
 
@@ -25,11 +28,11 @@ function href(path, ...args) {
 		const isRequired = questionMark === void 0;
 		const value = params?.[param];
 		if (isRequired && value === void 0) throw new Error(`Path '${path}' requires param '${param}' but it was not provided`);
-		return value === void 0 ? "" : "/" + value;
+		return value == null ? "" : "/" + encodeURIComponent(stringify(value));
 	});
 	if (path.endsWith("*")) {
 		const value = params?.["*"];
-		if (value !== void 0) result += "/" + value;
+		if (value !== void 0) result += "/" + stringify(value).split("/").map(encodeURIComponent).join("/");
 	}
 	return result || "/";
 }

package/dist/development/lib/router/history.js

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

package/dist/development/lib/router/instrumentation.d.ts

@@ -12,6 +12,19 @@ type ClientInstrumentation = {
 type InstrumentRequestHandlerFunction = (handler: InstrumentableRequestHandler) => void;
 type InstrumentRouterFunction = (router: InstrumentableRouter) => void;
 type InstrumentRouteFunction = (route: InstrumentableRoute) => void;
+/**
+ * Route metadata available after React Router has matched an instrumented
+ * request, navigation, or fetcher call.
+ */
+type InstrumentationResultMeta = {
+  url: LoaderFunctionArgs["url"];
+  pattern: string;
+  params: LoaderFunctionArgs["params"];
+};
+/**
+ * Result returned by route-level instrumented handler calls, such as
+ * instrumented loaders, actions, middleware, and lazy route functions.
+ */
 type InstrumentationHandlerResult = {
   status: "success";
   error: undefined;
@@ -19,7 +32,21 @@ type InstrumentationHandlerResult = {
   status: "error";
   error: Error;
 };
-type InstrumentFunction<T> = (handler: () => Promise<InstrumentationHandlerResult>, info: T) => Promise<void>;
+/**
+ * Result returned by client-side router instrumented navigation and fetcher
+ * calls.
+ */
+type InstrumentationClientRouterResult = InstrumentationHandlerResult & {
+  meta: InstrumentationResultMeta | undefined;
+};
+/**
+ * Result returned by server request handler instrumentation.
+ */
+type InstrumentationServerHandlerResult = InstrumentationHandlerResult & {
+  statusCode: number;
+  meta: InstrumentationResultMeta | undefined;
+};
+type InstrumentFunction<T, TInnerResult = InstrumentationHandlerResult> = (handler: () => Promise<TInnerResult>, info: T) => Promise<void>;
 type ReadonlyRequest = {
   method: string;
   url: string;
@@ -42,18 +69,16 @@ type RouteInstrumentations = {
   action?: InstrumentFunction<RouteHandlerInstrumentationInfo>;
 };
 type RouteLazyInstrumentationInfo = undefined;
-type RouteHandlerInstrumentationInfo = Readonly<{
+type RouteHandlerInstrumentationInfo = Readonly<Omit<LoaderFunctionArgs, "request" | "context"> & {
   request: ReadonlyRequest;
-  params: LoaderFunctionArgs["params"];
-  pattern: string;
   context: ReadonlyContext;
 }>;
 type InstrumentableRouter = {
   instrument(instrumentations: RouterInstrumentations): void;
 };
 type RouterInstrumentations = {
-  navigate?: InstrumentFunction<RouterNavigationInstrumentationInfo>;
-  fetch?: InstrumentFunction<RouterFetchInstrumentationInfo>;
+  navigate?: InstrumentFunction<RouterNavigationInstrumentationInfo, InstrumentationClientRouterResult>;
+  fetch?: InstrumentFunction<RouterFetchInstrumentationInfo, InstrumentationClientRouterResult>;
 };
 type RouterNavigationInstrumentationInfo = Readonly<{
   to: string | number;
@@ -76,11 +101,11 @@ type InstrumentableRequestHandler = {
   instrument(instrumentations: RequestHandlerInstrumentations): void;
 };
 type RequestHandlerInstrumentations = {
-  request?: InstrumentFunction<RequestHandlerInstrumentationInfo>;
+  request?: InstrumentFunction<RequestHandlerInstrumentationInfo, InstrumentationServerHandlerResult>;
 };
 type RequestHandlerInstrumentationInfo = Readonly<{
   request: ReadonlyRequest;
   context: ReadonlyContext | undefined;
 }>;
 //#endregion
-export { ClientInstrumentation, InstrumentRequestHandlerFunction, InstrumentRouteFunction, InstrumentRouterFunction, InstrumentationHandlerResult, ServerInstrumentation };
+export { ClientInstrumentation, InstrumentRequestHandlerFunction, InstrumentRouteFunction, InstrumentRouterFunction, InstrumentationClientRouterResult, InstrumentationHandlerResult, InstrumentationServerHandlerResult, ServerInstrumentation };