react-router - npm Package Compare versions

Comparing version 0.0.0-experimental-c9f8a7b2 to 0.0.0-experimental-cb25a21e1

CHANGELOG.md

 # `react-router`
 
+## 6.23.0
+
+### Minor Changes
+
+- Add a new `unstable_dataStrategy` configuration option ([#11098](https://github.com/remix-run/react-router/pull/11098))
+  - This option allows Data Router applications to take control over the approach for executing route loaders and actions
+  - The default implementation is today's behavior, to fetch all loaders in parallel, but this option allows users to implement more advanced data flows including Remix single-fetch, middleware/context APIs, automatic loader caching, and more
+
+### Patch Changes
+
+- Updated dependencies:
+  - `@remix-run/router@1.16.0`
+
+## 6.22.3
+
+### Patch Changes
+
+- Updated dependencies:
+  - `@remix-run/router@1.15.3`
+
+## 6.22.2
+
+### Patch Changes
+
+- Updated dependencies:
+  - `@remix-run/router@1.15.2`
+
+## 6.22.1
+
+### Patch Changes
+
+- Fix encoding/decoding issues with pre-encoded dynamic parameter values ([#11199](https://github.com/remix-run/react-router/pull/11199))
+- Updated dependencies:
+  - `@remix-run/router@1.15.1`
+
+## 6.22.0
+
+### Patch Changes
+
+- Updated dependencies:
+  - `@remix-run/router@1.15.0`
+
 ## 6.21.3
@@ -4,0 +46,0 @@

dist/index.d.ts

@@ -1,5 +0,5 @@
-import type { ActionFunction, ActionFunctionArgs, Blocker, BlockerFunction, ErrorResponse, Fetcher, HydrationState, InitialEntry, JsonFunction, LazyRouteFunction, LoaderFunction, LoaderFunctionArgs, Location, Navigation, ParamParseKey, Params, Path, PathMatch, PathParam, PathPattern, RedirectFunction, RelativeRoutingType, Router as RemixRouter, FutureConfig as RouterFutureConfig, ShouldRevalidateFunction, ShouldRevalidateFunctionArgs, To, UIMatch } from "@remix-run/router";
-import { AbortedDeferredError, Action as NavigationType, createPath, defer, generatePath, isRouteErrorResponse, json, matchPath, matchRoutes, parsePath, redirect, redirectDocument, resolvePath } from "@remix-run/router";
+import type { ActionFunction, ActionFunctionArgs, Blocker, BlockerFunction, unstable_DataStrategyFunction, unstable_DataStrategyFunctionArgs, unstable_DataStrategyMatch, ErrorResponse, Fetcher, JsonFunction, LazyRouteFunction, LoaderFunction, LoaderFunctionArgs, Location, Navigation, ParamParseKey, Params, Path, PathMatch, PathParam, PathPattern, RedirectFunction, RelativeRoutingType, ShouldRevalidateFunction, ShouldRevalidateFunctionArgs, To, UIMatch, unstable_HandlerResult } from "./lib/router";
+import { AbortedDeferredError, Action as NavigationType, createPath, defer, generatePath, isRouteErrorResponse, json, matchPath, matchRoutes, parsePath, redirect, redirectDocument, resolvePath, UNSAFE_ErrorResponseImpl } from "./lib/router";
 import type { AwaitProps, FutureConfig, IndexRouteProps, LayoutRouteProps, MemoryRouterProps, NavigateProps, OutletProps, PathRouteProps, RouteProps, RouterProps, RouterProviderProps, RoutesProps } from "./lib/components";
-import { Await, MemoryRouter, Navigate, Outlet, Route, Router, RouterProvider, Routes, createRoutesFromChildren, renderMatches } from "./lib/components";
+import { Await, MemoryRouter, Navigate, Outlet, Route, Router, RouterProvider, Routes, createRoutesFromChildren, renderMatches, createMemoryRouter, mapRouteProperties } from "./lib/components";
 import type { DataRouteMatch, DataRouteObject, IndexRouteObject, NavigateOptions, Navigator, NonIndexRouteObject, RouteMatch, RouteObject } from "./lib/context";
@@ -12,15 +12,33 @@ import { DataRouterContext, DataRouterStateContext, LocationContext, NavigationContext, RouteContext } from "./lib/context";
 type Search = string;
-export type { ActionFunction, ActionFunctionArgs, AwaitProps, DataRouteMatch, DataRouteObject, ErrorResponse, Fetcher, FutureConfig, Hash, IndexRouteObject, IndexRouteProps, JsonFunction, LayoutRouteProps, LazyRouteFunction, LoaderFunction, LoaderFunctionArgs, Location, MemoryRouterProps, NavigateFunction, NavigateOptions, NavigateProps, Navigation, Navigator, NonIndexRouteObject, OutletProps, ParamParseKey, Params, Path, PathMatch, PathParam, PathPattern, PathRouteProps, Pathname, RedirectFunction, RelativeRoutingType, RouteMatch, RouteObject, RouteProps, RouterProps, RouterProviderProps, RoutesProps, Search, ShouldRevalidateFunction, ShouldRevalidateFunctionArgs, To, UIMatch, Blocker, BlockerFunction, };
-export { AbortedDeferredError, Await, MemoryRouter, Navigate, NavigationType, Outlet, Route, Router, RouterProvider, Routes, createPath, createRoutesFromChildren, createRoutesFromChildren as createRoutesFromElements, defer, generatePath, isRouteErrorResponse, json, matchPath, matchRoutes, parsePath, redirect, redirectDocument, renderMatches, resolvePath, useBlocker, useActionData, useAsyncError, useAsyncValue, useHref, useInRouterContext, useLoaderData, useLocation, useMatch, useMatches, useNavigate, useNavigation, useNavigationType, useOutlet, useOutletContext, useParams, useResolvedPath, useRevalidator, useRouteError, useRouteLoaderData, useRoutes, };
-declare function mapRouteProperties(route: RouteObject): Partial<RouteObject> & {
-    hasErrorBoundary: boolean;
-};
-export declare function createMemoryRouter(routes: RouteObject[], opts?: {
-    basename?: string;
-    future?: Partial<Omit<RouterFutureConfig, "v7_prependBasename">>;
-    hydrationData?: HydrationState;
-    initialEntries?: InitialEntry[];
-    initialIndex?: number;
-}): RemixRouter;
+export type { ActionFunction, ActionFunctionArgs, AwaitProps, DataRouteMatch, DataRouteObject, unstable_DataStrategyFunction, unstable_DataStrategyFunctionArgs, unstable_DataStrategyMatch, ErrorResponse, Fetcher, FutureConfig, Hash, IndexRouteObject, IndexRouteProps, JsonFunction, LayoutRouteProps, LazyRouteFunction, LoaderFunction, LoaderFunctionArgs, Location, MemoryRouterProps, NavigateFunction, NavigateOptions, NavigateProps, Navigation, Navigator, NonIndexRouteObject, OutletProps, ParamParseKey, Params, Path, PathMatch, PathParam, PathPattern, PathRouteProps, Pathname, RedirectFunction, RelativeRoutingType, RouteMatch, RouteObject, RouteProps, RouterProps, RouterProviderProps, RoutesProps, Search, ShouldRevalidateFunction, ShouldRevalidateFunctionArgs, To, UIMatch, Blocker, BlockerFunction, unstable_HandlerResult, };
+export { AbortedDeferredError, Await, MemoryRouter, Navigate, NavigationType, Outlet, Route, Router, RouterProvider, Routes, createMemoryRouter, createPath, createRoutesFromChildren, createRoutesFromChildren as createRoutesFromElements, defer, generatePath, isRouteErrorResponse, json, matchPath, matchRoutes, parsePath, redirect, redirectDocument, renderMatches, resolvePath, useBlocker, useActionData, useAsyncError, useAsyncValue, useHref, useInRouterContext, useLoaderData, useLocation, useMatch, useMatches, useNavigate, useNavigation, useNavigationType, useOutlet, useOutletContext, useParams, useResolvedPath, useRevalidator, useRouteError, useRouteLoaderData, useRoutes, };
+export type { AgnosticDataIndexRouteObject, AgnosticDataNonIndexRouteObject, AgnosticDataRouteMatch, AgnosticDataRouteObject, AgnosticIndexRouteObject, AgnosticNonIndexRouteObject, AgnosticRouteMatch, AgnosticRouteObject, HydrationState, InitialEntry, StaticHandler, TrackedPromise, UNSAFE_DeferredData, } from "./lib/router";
+export { getStaticContextFromError, stripBasename, UNSAFE_DEFERRED_SYMBOL, UNSAFE_convertRoutesToDataRoutes, } from "./lib/router";
+export type { FormEncType, FormMethod, GetScrollRestorationKeyFunction, StaticHandlerContext, V7_FormMethod, } from "./lib/router";
+export type { BrowserRouterProps, HashRouterProps, HistoryRouterProps, LinkProps, NavLinkProps, NavLinkRenderProps, FetcherFormProps, FormProps, ScrollRestorationProps, SetURLSearchParams, SubmitFunction, FetcherSubmitFunction, FetcherWithComponents, } from "./lib/dom/lib";
+export { createBrowserRouter, createHashRouter, BrowserRouter, HashRouter, Link, UNSAFE_ViewTransitionContext, UNSAFE_FetchersContext, unstable_HistoryRouter, NavLink, Form, ScrollRestoration, useLinkClickHandler, useSearchParams, useSubmit, useFormAction, useFetcher, useFetchers, UNSAFE_useScrollRestoration, useBeforeUnload, unstable_usePrompt, unstable_useViewTransitionState, } from "./lib/dom/lib";
+export type { ParamKeyValuePair, SubmitOptions, URLSearchParamsInit, } from "./lib/dom/dom";
+export { createSearchParams } from "./lib/dom/dom";
+export type { StaticRouterProps, StaticRouterProviderProps, } from "./lib/dom/server";
+export { createStaticHandler, createStaticRouter, StaticRouter, StaticRouterProvider, } from "./lib/dom/server";
+export { HydratedRouter } from "./lib/dom/ssr/browser";
+export { Meta, Links, Scripts, PrefetchPageLinks, } from "./lib/dom/ssr/components";
+export type { HtmlLinkDescriptor, LinkDescriptor, PrefetchPageDescriptor, } from "./lib/dom/ssr/links";
+export type { ClientActionFunction, ClientActionFunctionArgs, ClientLoaderFunction, ClientLoaderFunctionArgs, MetaArgs, MetaDescriptor, MetaFunction, LinksFunction, } from "./lib/dom/ssr/routeModules";
+export type { RemixServerProps } from "./lib/dom/ssr/server";
+export { RemixServer } from "./lib/dom/ssr/server";
+export type { RemixStubProps } from "./lib/dom/ssr/create-remix-stub";
+export { createRemixStub } from "./lib/dom/ssr/create-remix-stub";
 /** @internal */
-export { DataRouterContext as UNSAFE_DataRouterContext, DataRouterStateContext as UNSAFE_DataRouterStateContext, LocationContext as UNSAFE_LocationContext, NavigationContext as UNSAFE_NavigationContext, RouteContext as UNSAFE_RouteContext, mapRouteProperties as UNSAFE_mapRouteProperties, useRouteId as UNSAFE_useRouteId, useRoutesImpl as UNSAFE_useRoutesImpl, };
+export { DataRouterContext as UNSAFE_DataRouterContext, DataRouterStateContext as UNSAFE_DataRouterStateContext, LocationContext as UNSAFE_LocationContext, NavigationContext as UNSAFE_NavigationContext, RouteContext as UNSAFE_RouteContext, mapRouteProperties as UNSAFE_mapRouteProperties, useRouteId as UNSAFE_useRouteId, useRoutesImpl as UNSAFE_useRoutesImpl, UNSAFE_ErrorResponseImpl, };
+/** @internal */
+export { RemixContext as UNSAFE_RemixContext } from "./lib/dom/ssr/components";
+/** @internal */
+export type { RouteModules as UNSAFE_RouteModules } from "./lib/dom/ssr/routeModules";
+/** @internal */
+export type { FutureConfig as UNSAFE_FutureConfig, AssetsManifest as UNSAFE_AssetsManifest, RemixContextObject as UNSAFE_RemixContextObject, } from "./lib/dom/ssr/entry";
+/** @internal */
+export type { EntryRoute as UNSAFE_EntryRoute, RouteManifest as UNSAFE_RouteManifest, } from "./lib/dom/ssr/routes";
+/** @internal */
+export type { SingleFetchRedirectResult as UNSAFE_SingleFetchRedirectResult, SingleFetchResult as UNSAFE_SingleFetchResult, SingleFetchResults as UNSAFE_SingleFetchResults, } from "./lib/dom/ssr/single-fetch";
+export { decodeViaTurboStream as UNSAFE_decodeViaTurboStream, SingleFetchRedirectSymbol as UNSAFE_SingleFetchRedirectSymbol, } from "./lib/dom/ssr/single-fetch";

dist/lib/components.d.ts

@@ -1,3 +0,3 @@
-import type { InitialEntry, LazyRouteFunction, Location, RelativeRoutingType, Router as RemixRouter, To, TrackedPromise } from "@remix-run/router";
-import { Action as NavigationType } from "@remix-run/router";
+import type { FutureConfig as RouterFutureConfig, HydrationState, InitialEntry, LazyRouteFunction, Location, RelativeRoutingType, Router as RemixRouter, To, TrackedPromise, unstable_DataStrategyFunction } from "./router";
+import { Action as NavigationType } from "./router";
 import * as React from "react";
@@ -9,2 +9,19 @@ import type { IndexRouteObject, Navigator, NonIndexRouteObject, RouteMatch, RouteObject } from "./context";
 }
+/**
+ * @private
+ */
+export declare function mapRouteProperties(route: RouteObject): Partial<RouteObject> & {
+    hasErrorBoundary: boolean;
+};
+/**
+ * @category Routers
+ */
+export declare function createMemoryRouter(routes: RouteObject[], opts?: {
+    basename?: string;
+    future?: Partial<Omit<RouterFutureConfig, "v7_prependBasename">>;
+    hydrationData?: HydrationState;
+    initialEntries?: InitialEntry[];
+    initialIndex?: number;
+    unstable_dataStrategy?: unstable_DataStrategyFunction;
+}): RemixRouter;
 export interface RouterProviderProps {
@@ -17,2 +34,4 @@ fallbackElement?: React.ReactNode;
  * Given a Remix Router instance, render the appropriate UI
+ *
+ * @category Components
  */
@@ -30,3 +49,3 @@ export declare function RouterProvider({ fallbackElement, router, future, }: RouterProviderProps): React.ReactElement;
  *
- * @see https://reactrouter.com/router-components/memory-router
+ * @category Components
  */
@@ -41,18 +60,40 @@ export declare function MemoryRouter({ basename, children, initialEntries, initialIndex, future, }: MemoryRouterProps): React.ReactElement;
 /**
- * Changes the current location.
+ * A component-based version of {@link useNavigate} to use in a [`React.Component
+ * Class`](https://reactjs.org/docs/react-component.html) where hooks are not
+ * able to be used.
  *
- * Note: This API is mostly useful in React.Component subclasses that are not
- * able to use hooks. In functional components, we recommend you use the
- * `useNavigate` hook instead.
+ * It's recommended to avoid using this component in favor of {@link useNavigate}
  *
- * @see https://reactrouter.com/components/navigate
+ * @category Components
  */
 export declare function Navigate({ to, replace, state, relative, }: NavigateProps): null;
 export interface OutletProps {
+    /**
+      Provides a context value to the element tree below the outlet. Use when the parent route needs to provide values to child routes.
+  
+      ```tsx
+      <Outlet context={myContextValue} />
+      ```
+  
+      Access the context with {@link useOutletContext}.
+     */
     context?: unknown;
 }
 /**
- * Renders the child route's element, if there is one.
- *
- * @see https://reactrouter.com/components/outlet
+  Renders the matching child route of a parent route or nothing if no child route matches.
+
+  ```tsx
+  import { Outlet } from "react-router"
+
+  export default function SomeParent() {
+    return (
+      <div>
+        <h1>Parent Content</h1>
+        <Outlet />
+      </div>
+    );
+  }
+  ```
+ 
+  @category Components
  */
@@ -104,3 +145,3 @@ export declare function Outlet(props: OutletProps): React.ReactElement | null;
  *
- * @see https://reactrouter.com/components/route
+ * @category Components
  */
@@ -124,3 +165,3 @@ export declare function Route(_props: RouteProps): React.ReactElement | null;
  *
- * @see https://reactrouter.com/router-components/router
+ * @category Components
  */
@@ -136,3 +177,3 @@ export declare function Router({ basename: basenameProp, children, location: locationProp, navigationType, navigator, static: staticProp, future, }: RouterProps): React.ReactElement | null;
  *
- * @see https://reactrouter.com/components/routes
+ * @category Components
  */
@@ -144,10 +185,141 @@ export declare function Routes({ children, location, }: RoutesProps): React.ReactElement | null;
 export interface AwaitProps {
+    /**
+    When using a function, the resolved value is provided as the parameter.
+  
+    ```tsx [2]
+    <Await resolve={reviewsPromise}>
+      {(resolvedReviews) => <Reviews items={resolvedReviews} />}
+    </Await>
+    ```
+  
+    When using React elements, {@link useAsyncValue} will provide the
+    resolved value:
+  
+    ```tsx [2]
+    <Await resolve={reviewsPromise}>
+      <Reviews />
+    </Await>
+  
+    function Reviews() {
+      const resolvedReviews = useAsyncValue()
+      return <div>...</div>
+    }
+    ```
+    */
     children: React.ReactNode | AwaitResolveRenderFunction;
+    /**
+    The error element renders instead of the children when the promise rejects.
+  
+    ```tsx
+    <Await
+      errorElement={<div>Oops</div>}
+      resolve={reviewsPromise}
+    >
+      <Reviews />
+    </Await>
+    ```
+  
+    To provide a more contextual error, you can use the {@link useAsyncError} in a
+    child component
+  
+    ```tsx
+    <Await
+      errorElement={<ReviewsError />}
+      resolve={reviewsPromise}
+    >
+      <Reviews />
+    </Await>
+  
+    function ReviewsError() {
+      const error = useAsyncError()
+      return <div>Error loading reviews: {error.message}</div>
+    }
+    ```
+  
+    If you do not provide an errorElement, the rejected value will bubble up to
+    the nearest route-level {@link NonIndexRouteObject#ErrorBoundary | ErrorBoundary} and be accessible
+    via {@link useRouteError} hook.
+    */
     errorElement?: React.ReactNode;
+    /**
+    Takes a promise returned from a {@link LoaderFunction | loader} value to be resolved and rendered.
+  
+    ```jsx
+    import { useLoaderData, Await } from "react-router"
+  
+    export async function loader() {
+      let reviews = getReviews() // not awaited
+      let book = await getBook()
+      return {
+        book,
+        reviews, // this is a promise
+      }
+    }
+  
+    export default function Book() {
+      const {
+        book,
+        reviews, // this is the same promise
+      } = useLoaderData()
+  
+      return (
+        <div>
+          <h1>{book.title}</h1>
+          <p>{book.description}</p>
+          <React.Suspense fallback={<ReviewsSkeleton />}>
+            <Await
+              // and is the promise we pass to Await
+              resolve={reviews}
+            >
+              <Reviews />
+            </Await>
+          </React.Suspense>
+        </div>
+      );
+    }
+    ```
+     */
     resolve: TrackedPromise | any;
 }
 /**
- * Component to use for rendering lazily loaded data from returning defer()
- * in a loader function
- */
+Used to render promise values with automatic error handling.
+
+```tsx
+import { Await, useLoaderData } from "react-router";
+
+export function loader() {
+  // not awaited
+  const reviews = getReviews()
+  // awaited (blocks the transition)
+  const book = await fetch("/api/book").then((res) => res.json())
+  return { book, reviews }
+}
+
+function Book() {
+  const { book, reviews } = useLoaderData();
+  return (
+    <div>
+      <h1>{book.title}</h1>
+      <p>{book.description}</p>
+      <React.Suspense fallback={<ReviewsSkeleton />}>
+        <Await
+          resolve={reviews}
+          errorElement={
+            <div>Could not load reviews 😬</div>
+          }
+          children={(resolvedReviews) => (
+            <Reviews items={resolvedReviews} />
+          )}
+        />
+      </React.Suspense>
+    </div>
+  );
+}
+```
+
+**Note:** `<Await>` expects to be rendered inside of a `<React.Suspense>`
+
+@category Components
+
+*/
 export declare function Await({ children, errorElement, resolve }: AwaitProps): React.JSX.Element;
@@ -158,4 +330,2 @@ /**
  * `<Routes>` to create a route config from its children.
- *
- * @see https://reactrouter.com/utils/create-routes-from-children
  */
@@ -162,0 +332,0 @@ export declare function createRoutesFromChildren(children: React.ReactNode, parentPath?: number[]): RouteObject[];

dist/lib/context.d.ts

 import * as React from "react";
-import type { AgnosticIndexRouteObject, AgnosticNonIndexRouteObject, AgnosticRouteMatch, History, LazyRouteFunction, Location, Action as NavigationType, RelativeRoutingType, Router, StaticHandlerContext, To, TrackedPromise } from "@remix-run/router";
+import type { AgnosticIndexRouteObject, AgnosticNonIndexRouteObject, AgnosticRouteMatch, History, LazyRouteFunction, Location, Action as NavigationType, RelativeRoutingType, Router, StaticHandlerContext, To, TrackedPromise } from "./router";
 export interface IndexRouteObject {
@@ -55,3 +55,3 @@ caseSensitive?: AgnosticIndexRouteObject["caseSensitive"];
 export declare const DataRouterContext: React.Context<DataRouterContextObject | null>;
-export declare const DataRouterStateContext: React.Context<import("@remix-run/router").RouterState | null>;
+export declare const DataRouterStateContext: React.Context<import("./router").RouterState | null>;
 export declare const AwaitContext: React.Context<TrackedPromise | null>;
@@ -58,0 +58,0 @@ export interface NavigateOptions {

dist/lib/hooks.d.ts

 import * as React from "react";
-import type { Blocker, BlockerFunction, Location, ParamParseKey, Params, Path, PathMatch, PathPattern, RelativeRoutingType, Router as RemixRouter, RevalidationState, To, UIMatch } from "@remix-run/router";
-import { Action as NavigationType } from "@remix-run/router";
+import type { Blocker, BlockerFunction, Location, ParamParseKey, Params, Path, PathMatch, PathPattern, RelativeRoutingType, Router as RemixRouter, RevalidationState, To, UIMatch } from "./router";
+import { Action as NavigationType } from "./router";
 import type { NavigateOptions, RouteContextObject, RouteMatch, RouteObject } from "./context";
@@ -9,3 +9,3 @@ /**
  *
- * @see https://reactrouter.com/hooks/use-href
+ * @category Hooks
  */
@@ -18,3 +18,3 @@ export declare function useHref(to: To, { relative }?: {
  *
- * @see https://reactrouter.com/hooks/use-in-router-context
+ * @category Hooks
  */
@@ -30,3 +30,3 @@ export declare function useInRouterContext(): boolean;
  *
- * @see https://reactrouter.com/hooks/use-location
+ * @category Hooks
  */
@@ -38,3 +38,3 @@ export declare function useLocation(): Location;
  *
- * @see https://reactrouter.com/hooks/use-navigation-type
+ * @category Hooks
  */
@@ -47,3 +47,3 @@ export declare function useNavigationType(): NavigationType;
  *
- * @see https://reactrouter.com/hooks/use-match
+ * @category Hooks
  */
@@ -53,6 +53,8 @@ export declare function useMatch<ParamKey extends ParamParseKey<Path>, Path extends string>(pattern: PathPattern<Path> | Path): PathMatch<ParamKey> | null;
  * The interface for the navigate() function returned from useNavigate().
+ *
+ * @category Types
  */
 export interface NavigateFunction {
-    (to: To, options?: NavigateOptions): void;
-    (delta: number): void;
+    (to: To, options?: NavigateOptions): void | Promise<void>;
+    (delta: number): void | Promise<void>;
 }
@@ -63,3 +65,3 @@ /**
  *
- * @see https://reactrouter.com/hooks/use-navigate
+ * @category Hooks
  */
@@ -70,3 +72,4 @@ export declare function useNavigate(): NavigateFunction;
  * hierarchy.
- * @see https://reactrouter.com/hooks/use-outlet-context
+ *
+ * @category Hooks
  */
@@ -78,3 +81,3 @@ export declare function useOutletContext<Context = unknown>(): Context;
  *
- * @see https://reactrouter.com/hooks/use-outlet
+ * @category Hooks
  */
@@ -86,3 +89,3 @@ export declare function useOutlet(context?: unknown): React.ReactElement | null;
  *
- * @see https://reactrouter.com/hooks/use-params
+ * @category Hooks
  */
@@ -95,3 +98,3 @@ export declare function useParams<ParamsOrKey extends string | Record<string, string | undefined> = string>(): Readonly<[
  *
- * @see https://reactrouter.com/hooks/use-resolved-path
+ * @category Hooks
  */
@@ -107,5 +110,11 @@ export declare function useResolvedPath(to: To, { relative }?: {
  *
- * @see https://reactrouter.com/hooks/use-routes
+ * @category Hooks
  */
 export declare function useRoutes(routes: RouteObject[], locationArg?: Partial<Location> | string): React.ReactElement | null;
+/**
+ * Internal implementation with accept optional param for RouterProvider usage
+ *
+ * @private
+ * @category Hooks
+ */
 export declare function useRoutesImpl(routes: RouteObject[], locationArg?: Partial<Location> | string, dataRouterState?: RemixRouter["state"], future?: RemixRouter["future"]): React.ReactElement | null;
@@ -145,10 +154,14 @@ type RenderErrorBoundaryProps = React.PropsWithChildren<{
  * no navigation is in progress
+ *
+ * @category Hooks
  */
-export declare function useNavigation(): import("@remix-run/router").Navigation;
+export declare function useNavigation(): import("./router").Navigation;
 /**
  * Returns a revalidate function for manually triggering revalidation, as well
  * as the current state of any manual revalidations
+ *
+ * @category Hooks
  */
 export declare function useRevalidator(): {
-    revalidate: () => void;
+    revalidate(): Promise<void>;
     state: RevalidationState;
@@ -159,2 +172,4 @@ };
  * parent/child routes or the route "handle" property
+ *
+ * @category Hooks
  */
@@ -164,2 +179,4 @@ export declare function useMatches(): UIMatch[];
  * Returns the loader data for the nearest ancestor Route loader
+ *
+ * @category Hooks
  */
@@ -169,2 +186,4 @@ export declare function useLoaderData(): unknown;
  * Returns the loaderData for the given routeId
+ *
+ * @category Hooks
  */
@@ -174,2 +193,4 @@ export declare function useRouteLoaderData(routeId: string): unknown;
  * Returns the action data for the nearest ancestor Route action
+ *
+ * @category Hooks
  */
@@ -181,2 +202,4 @@ export declare function useActionData(): unknown;
  * ErrorBoundary/errorElement to display a proper error message.
+ *
+ * @category Hooks
  */
@@ -186,2 +209,4 @@ export declare function useRouteError(): unknown;
  * Returns the happy-path data from the nearest ancestor `<Await />` value
+ *
+ * @category Hooks
  */
@@ -191,2 +216,4 @@ export declare function useAsyncValue(): unknown;
  * Returns the error from the nearest ancestor `<Await />` value
+ *
+ * @category Hooks
  */
@@ -199,4 +226,6 @@ export declare function useAsyncError(): unknown;
  * cross-origin navigations.
+ *
+ * @category Hooks
  */
 export declare function useBlocker(shouldBlock: boolean | BlockerFunction): Blocker;
 export {};

dist/main.js

 /**
- * React Router v0.0.0-experimental-c9f8a7b2
+ * React Router v0.0.0-experimental-cb25a21e1
  *
@@ -4,0 +4,0 @@ * Copyright (c) Remix Software Inc.

package.json

 {
   "name": "react-router",
-  "version": "0.0.0-experimental-c9f8a7b2",
+  "version": "0.0.0-experimental-cb25a21e1",
   "description": "Declarative routing for React",
@@ -26,10 +26,17 @@ "keywords": [
   "dependencies": {
-    "@remix-run/router": "0.0.0-experimental-c9f8a7b2"
+    "turbo-stream": "^2.0.0"
   },
   "devDependencies": {
-    "react": "^18.2.0"
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
   "peerDependencies": {
-    "react": ">=16.8"
+    "react": ">=16.8",
+    "react-dom": ">=16.8"
   },
+  "peerDependenciesMeta": {
+    "react-dom": {
+      "optional": true
+    }
+  },
   "files": [
@@ -44,2 +51,2 @@ "dist/",
   }
-}
+}

README.md

 # React Router
 
-The `react-router` package is the heart of [React Router](https://github.com/remix-run/react-router) and provides all
-the core functionality for both
-[`react-router-dom`](https://github.com/remix-run/react-router/tree/main/packages/react-router-dom)
-and
-[`react-router-native`](https://github.com/remix-run/react-router/tree/main/packages/react-router-native).
+The `react-router` package is the heart of [React Router](https://github.com/remix-run/react-router) and provides all the core functionality.
 
-If you're using React Router, you should never `import` anything directly from
-the `react-router` package, but you should have everything you need in either
-`react-router-dom` or `react-router-native`. Both of those packages re-export
-everything from `react-router`.
-
 If you'd like to extend React Router and you know what you're doing, you should
 add `react-router` **as a peer dependency, not a regular dependency** in your
 package.

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5505042

increased by590.74%

Number of package files

41

increased by115.79%

Lines of code

34045

increased by603.7%

Worsened metrics

Dependency count

3

increased by50%

Dev dependency count

2

increased by100%

Number of lines in readme file

8

decreased by-52.94%

Number of low supply chain risk alerts

98

increased by139.02%

Number of medium supply chain risk alerts

9

increased byInfinity%

Dependency changes

• + Addedturbo-stream@^2.0.0

• + Addedreact-dom@18.3.1(transitive)

• + Addedscheduler@0.23.2(transitive)

• + Addedturbo-stream@2.2.0(transitive)

• - Removed@remix-run/router@0.0.0-experimental-c9f8a7b2

• - Removed@remix-run/router@0.0.0-experimental-c9f8a7b2(transitive)