react-router 0.0.0-experimental-078ef8de9 → 0.0.0-experimental-ecd35cd60

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/README.md +1 -10
  2. package/dist/index.d.ts +64 -21
  3. package/dist/index.js +11550 -1238
  4. package/dist/index.js.map +1 -1
  5. package/dist/lib/components.d.ts +243 -36
  6. package/dist/lib/context.d.ts +3 -5
  7. package/dist/lib/dom/dom.d.ts +122 -0
  8. package/dist/lib/dom/global.d.ts +36 -0
  9. package/dist/lib/dom/lib.d.ts +965 -0
  10. package/dist/lib/dom/server.d.ts +40 -0
  11. package/dist/lib/dom/ssr/browser.d.ts +6 -0
  12. package/dist/lib/dom/ssr/components.d.ts +123 -0
  13. package/dist/lib/dom/ssr/data.d.ts +7 -0
  14. package/dist/lib/dom/ssr/entry.d.ts +50 -0
  15. package/dist/lib/dom/ssr/errorBoundaries.d.ts +36 -0
  16. package/dist/lib/dom/ssr/errors.d.ts +2 -0
  17. package/dist/lib/dom/ssr/fallback.d.ts +2 -0
  18. package/dist/lib/dom/ssr/fog-of-war.d.ts +37 -0
  19. package/dist/lib/dom/ssr/invariant.d.ts +2 -0
  20. package/dist/lib/dom/ssr/links.d.ts +126 -0
  21. package/dist/lib/dom/ssr/markup.d.ts +5 -0
  22. package/dist/lib/dom/ssr/routeModules.d.ts +141 -0
  23. package/dist/lib/dom/ssr/routes-test-stub.d.ts +59 -0
  24. package/dist/lib/dom/ssr/routes.d.ts +32 -0
  25. package/dist/lib/dom/ssr/server.d.ts +16 -0
  26. package/dist/lib/dom/ssr/single-fetch.d.ts +37 -0
  27. package/dist/lib/hooks.d.ts +282 -55
  28. package/dist/lib/router/define-route.d.ts +102 -0
  29. package/dist/lib/router/history.d.ts +253 -0
  30. package/dist/lib/router/index.d.ts +9 -0
  31. package/dist/lib/router/router.d.ts +540 -0
  32. package/dist/lib/router/utils.d.ts +487 -0
  33. package/dist/lib/server-runtime/build.d.ts +38 -0
  34. package/dist/lib/server-runtime/cookies.d.ts +69 -0
  35. package/dist/lib/server-runtime/crypto.d.ts +2 -0
  36. package/dist/lib/server-runtime/data.d.ts +31 -0
  37. package/dist/lib/server-runtime/dev.d.ts +8 -0
  38. package/dist/lib/server-runtime/entry.d.ts +3 -0
  39. package/dist/lib/server-runtime/errors.d.ts +51 -0
  40. package/dist/lib/server-runtime/formData.d.ts +15 -0
  41. package/dist/lib/server-runtime/invariant.d.ts +2 -0
  42. package/dist/lib/server-runtime/jsonify.d.ts +33 -0
  43. package/dist/lib/server-runtime/links.d.ts +104 -0
  44. package/dist/lib/server-runtime/markup.d.ts +1 -0
  45. package/dist/lib/server-runtime/mode.d.ts +9 -0
  46. package/dist/lib/server-runtime/responses.d.ts +30 -0
  47. package/dist/lib/server-runtime/routeMatching.d.ts +8 -0
  48. package/dist/lib/server-runtime/routeModules.d.ts +214 -0
  49. package/dist/lib/server-runtime/routes.d.ts +31 -0
  50. package/dist/lib/server-runtime/server.d.ts +5 -0
  51. package/dist/lib/server-runtime/serverHandoff.d.ts +12 -0
  52. package/dist/lib/server-runtime/sessions/cookieStorage.d.ts +23 -0
  53. package/dist/lib/server-runtime/sessions/memoryStorage.d.ts +20 -0
  54. package/dist/lib/server-runtime/sessions.d.ts +143 -0
  55. package/dist/lib/server-runtime/single-fetch.d.ts +56 -0
  56. package/dist/lib/server-runtime/typecheck.d.ts +4 -0
  57. package/dist/lib/server-runtime/upload/errors.d.ts +5 -0
  58. package/dist/lib/server-runtime/upload/memoryUploadHandler.d.ts +21 -0
  59. package/dist/lib/server-runtime/warnings.d.ts +1 -0
  60. package/dist/main.js +1 -1
  61. package/dist/react-router.development.js +12436 -1149
  62. package/dist/react-router.development.js.map +1 -1
  63. package/dist/react-router.production.min.js +2 -2
  64. package/dist/react-router.production.min.js.map +1 -1
  65. package/dist/umd/react-router.development.js +12727 -1258
  66. package/dist/umd/react-router.development.js.map +1 -1
  67. package/dist/umd/react-router.production.min.js +2 -2
  68. package/dist/umd/react-router.production.min.js.map +1 -1
  69. package/package.json +16 -5
package/README.md CHANGED
@@ -1,15 +1,6 @@
1
1
  # React Router
2
2
 
3
- The `react-router` package is the heart of [React Router](https://github.com/remix-run/react-router) and provides all
4
- the core functionality for both
5
- [`react-router-dom`](https://github.com/remix-run/react-router/tree/main/packages/react-router-dom)
6
- and
7
- [`react-router-native`](https://github.com/remix-run/react-router/tree/main/packages/react-router-native).
8
-
9
- If you're using React Router, you should never `import` anything directly from
10
- the `react-router` package, but you should have everything you need in either
11
- `react-router-dom` or `react-router-native`. Both of those packages re-export
12
- everything from `react-router`.
3
+ The `react-router` package is the heart of [React Router](https://github.com/remix-run/react-router) and provides all the core functionality.
13
4
 
14
5
  If you'd like to extend React Router and you know what you're doing, you should
15
6
  add `react-router` **as a peer dependency, not a regular dependency** in your
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
- import type { ActionFunction, ActionFunctionArgs, Blocker, BlockerFunction, unstable_DataStrategyFunction, unstable_DataStrategyFunctionArgs, unstable_DataStrategyMatch, 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, unstable_HandlerResult, unstable_AgnosticPatchRoutesOnMissFunction } from "@remix-run/router";
2
- import { AbortedDeferredError, Action as NavigationType, createPath, defer, generatePath, isRouteErrorResponse, json, matchPath, matchRoutes, parsePath, redirect, redirectDocument, resolvePath } from "@remix-run/router";
3
- import type { AwaitProps, FutureConfig, IndexRouteProps, LayoutRouteProps, MemoryRouterProps, NavigateProps, OutletProps, PathRouteProps, RouteProps, RouterProps, RouterProviderProps, RoutesProps } from "./lib/components";
4
- import { Await, MemoryRouter, Navigate, Outlet, Route, Router, RouterProvider, Routes, createRoutesFromChildren, renderMatches } from "./lib/components";
1
+ import type { ActionFunction, ActionFunctionArgs, Blocker, BlockerFunction, unstable_DataStrategyFunction, unstable_DataStrategyFunctionArgs, unstable_DataStrategyMatch, ErrorResponse, Fetcher, JsonFunction, LazyRouteFunction, LoaderFunction, LoaderFunctionArgs, Location, Navigation, NavigationStates, ParamParseKey, Params, Path, PathMatch, PathParam, PathPattern, RedirectFunction, RelativeRoutingType, ShouldRevalidateFunction, ShouldRevalidateFunctionArgs, To, UIMatch, unstable_HandlerResult } from "./lib/router";
2
+ import { Action as NavigationType, createPath, generatePath, isRouteErrorResponse, json, matchPath, matchRoutes, parsePath, redirect, redirectDocument, resolvePath, UNSAFE_ErrorResponseImpl } from "./lib/router";
3
+ import type { AwaitProps, IndexRouteProps, LayoutRouteProps, MemoryRouterProps, NavigateProps, OutletProps, PathRouteProps, RouteProps, RouterProps, RoutesProps, unstable_PatchRoutesOnMissFunction } from "./lib/components";
4
+ import { Await, MemoryRouter, Navigate, Outlet, Route, Router, Routes, createRoutesFromChildren, renderMatches, createMemoryRouter, mapRouteProperties } from "./lib/components";
5
5
  import type { DataRouteMatch, DataRouteObject, IndexRouteObject, NavigateOptions, Navigator, NonIndexRouteObject, RouteMatch, RouteObject } from "./lib/context";
6
6
  import { DataRouterContext, DataRouterStateContext, LocationContext, NavigationContext, RouteContext } from "./lib/context";
7
7
  import type { NavigateFunction } from "./lib/hooks";
@@ -9,21 +9,64 @@ import { useActionData, useAsyncError, useAsyncValue, useBlocker, useHref, useIn
9
9
  type Hash = string;
10
10
  type Pathname = string;
11
11
  type Search = string;
12
- 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, };
13
- 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, };
14
- declare function mapRouteProperties(route: RouteObject): Partial<RouteObject> & {
15
- hasErrorBoundary: boolean;
16
- };
17
- export interface unstable_PatchRoutesOnMissFunction extends unstable_AgnosticPatchRoutesOnMissFunction<RouteMatch> {
18
- }
19
- export declare function createMemoryRouter(routes: RouteObject[], opts?: {
20
- basename?: string;
21
- future?: Partial<Omit<RouterFutureConfig, "v7_prependBasename">>;
22
- hydrationData?: HydrationState;
23
- initialEntries?: InitialEntry[];
24
- initialIndex?: number;
25
- unstable_dataStrategy?: unstable_DataStrategyFunction;
26
- unstable_patchRoutesOnMiss?: unstable_PatchRoutesOnMissFunction;
27
- }): RemixRouter;
12
+ export type { ActionFunction, ActionFunctionArgs, AwaitProps, DataRouteMatch, DataRouteObject, unstable_DataStrategyFunction, unstable_DataStrategyFunctionArgs, unstable_DataStrategyMatch, ErrorResponse, Fetcher, Hash, IndexRouteObject, IndexRouteProps, JsonFunction, LayoutRouteProps, LazyRouteFunction, LoaderFunction, LoaderFunctionArgs, Location, MemoryRouterProps, NavigateFunction, NavigateOptions, NavigateProps, Navigation, NavigationStates, Navigator, NonIndexRouteObject, OutletProps, ParamParseKey, Params, Path, PathMatch, PathParam, PathPattern, PathRouteProps, Pathname, RedirectFunction, RelativeRoutingType, RouteMatch, RouteObject, RouteProps, RouterProps, RoutesProps, Search, ShouldRevalidateFunction, ShouldRevalidateFunctionArgs, To, UIMatch, Blocker, BlockerFunction, unstable_HandlerResult, unstable_PatchRoutesOnMissFunction, };
13
+ export { Await, MemoryRouter, Navigate, NavigationType, Outlet, Route, Router, Routes, createMemoryRouter, createPath, createRoutesFromChildren, createRoutesFromChildren as createRoutesFromElements, 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, };
14
+ export type { AgnosticDataIndexRouteObject, AgnosticDataNonIndexRouteObject, AgnosticDataRouteMatch, AgnosticDataRouteObject, AgnosticIndexRouteObject, AgnosticNonIndexRouteObject, AgnosticRouteMatch, AgnosticRouteObject, HydrationState, InitialEntry, LowerCaseFormMethod, StaticHandler, TrackedPromise, FetcherStates, UpperCaseFormMethod, } from "./lib/router";
15
+ export { getStaticContextFromError, stripBasename, UNSAFE_convertRoutesToDataRoutes, } from "./lib/router";
16
+ export type { FormEncType, FormMethod, GetScrollRestorationKeyFunction, StaticHandlerContext, Submission, } from "./lib/router";
17
+ export type { BrowserRouterProps, HashRouterProps, HistoryRouterProps, LinkProps, NavLinkProps, NavLinkRenderProps, FetcherFormProps, FormProps, ScrollRestorationProps, SetURLSearchParams, SubmitFunction, FetcherSubmitFunction, FetcherWithComponents, RouterProviderProps, } from "./lib/dom/lib";
18
+ export { createBrowserRouter, createHashRouter, BrowserRouter, HashRouter, Link, UNSAFE_ViewTransitionContext, UNSAFE_FetchersContext, unstable_HistoryRouter, NavLink, Form, RouterProvider, ScrollRestoration, useLinkClickHandler, useSearchParams, useSubmit, useFormAction, useFetcher, useFetchers, UNSAFE_useScrollRestoration, useBeforeUnload, unstable_usePrompt, unstable_useViewTransitionState, } from "./lib/dom/lib";
19
+ export type { ParamKeyValuePair, SubmitOptions, URLSearchParamsInit, SubmitTarget, } from "./lib/dom/dom";
20
+ export { createSearchParams } from "./lib/dom/dom";
21
+ export type { StaticRouterProps, StaticRouterProviderProps, } from "./lib/dom/server";
22
+ export { createStaticHandler, createStaticRouter, StaticRouter, StaticRouterProvider, } from "./lib/dom/server";
23
+ export { HydratedRouter } from "./lib/dom/ssr/browser";
24
+ export { Meta, Links, Scripts, PrefetchPageLinks, } from "./lib/dom/ssr/components";
25
+ export type { ScriptsProps } from "./lib/dom/ssr/components";
26
+ export type { EntryContext } from "./lib/dom/ssr/entry";
27
+ export type { HtmlLinkDescriptor, LinkDescriptor, PrefetchPageDescriptor, } from "./lib/dom/ssr/links";
28
+ export type { ClientActionFunction, ClientActionFunctionArgs, ClientLoaderFunction, ClientLoaderFunctionArgs, MetaArgs, MetaDescriptor, MetaFunction, LinksFunction, } from "./lib/dom/ssr/routeModules";
29
+ export type { ServerRouterProps } from "./lib/dom/ssr/server";
30
+ export { ServerRouter } from "./lib/dom/ssr/server";
31
+ export type { RoutesTestStubProps } from "./lib/dom/ssr/routes-test-stub";
32
+ export { createRoutesStub } from "./lib/dom/ssr/routes-test-stub";
33
+ export { defineRoute, type Match, type MetaMatch, } from "./lib/router/define-route";
34
+ export { createCookieFactory, isCookie } from "./lib/server-runtime/cookies";
35
+ export { composeUploadHandlers as unstable_composeUploadHandlers, parseMultipartFormData as unstable_parseMultipartFormData, } from "./lib/server-runtime/formData";
36
+ export { createRequestHandler } from "./lib/server-runtime/server";
37
+ export { createSession, createSessionStorageFactory, isSession, } from "./lib/server-runtime/sessions";
38
+ export { createCookieSessionStorageFactory } from "./lib/server-runtime/sessions/cookieStorage";
39
+ export { createMemorySessionStorageFactory } from "./lib/server-runtime/sessions/memoryStorage";
40
+ export { createMemoryUploadHandler as unstable_createMemoryUploadHandler } from "./lib/server-runtime/upload/memoryUploadHandler";
41
+ export { MaxPartSizeExceededError } from "./lib/server-runtime/upload/errors";
42
+ export { setDevServerHooks as unstable_setDevServerHooks } from "./lib/server-runtime/dev";
43
+ export type { CreateCookieFunction, IsCookieFunction, } from "./lib/server-runtime/cookies";
44
+ export type { CreateRequestHandlerFunction } from "./lib/server-runtime/server";
45
+ export type { CreateSessionFunction, CreateSessionStorageFunction, IsSessionFunction, } from "./lib/server-runtime/sessions";
46
+ export type { CreateCookieSessionStorageFunction } from "./lib/server-runtime/sessions/cookieStorage";
47
+ export type { CreateMemorySessionStorageFunction } from "./lib/server-runtime/sessions/memoryStorage";
48
+ export type { HandleDataRequestFunction, HandleDocumentRequestFunction, HandleErrorFunction, ServerBuild, ServerEntryModule, } from "./lib/server-runtime/build";
49
+ export type { UploadHandlerPart, UploadHandler, } from "./lib/server-runtime/formData";
50
+ export type { MemoryUploadHandlerOptions, MemoryUploadHandlerFilterArgs, } from "./lib/server-runtime/upload/memoryUploadHandler";
51
+ export type { Cookie, CookieOptions, CookieParseOptions, CookieSerializeOptions, CookieSignatureOptions, } from "./lib/server-runtime/cookies";
52
+ export type { SignFunction, UnsignFunction } from "./lib/server-runtime/crypto";
53
+ export type { AppLoadContext } from "./lib/server-runtime/data";
54
+ export type { PageLinkDescriptor, } from "./lib/server-runtime/links";
55
+ export type { TypedResponse } from "./lib/server-runtime/responses";
56
+ export type { DataFunctionArgs, HeadersArgs, HeadersFunction, } from "./lib/server-runtime/routeModules";
57
+ export type { RequestHandler } from "./lib/server-runtime/server";
58
+ export type { Session, SessionData, SessionIdStorageStrategy, SessionStorage, FlashSessionData, } from "./lib/server-runtime/sessions";
59
+ export { ServerMode as UNSAFE_ServerMode } from "./lib/server-runtime/mode";
28
60
  /** @internal */
29
- 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, };
61
+ 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, };
62
+ /** @internal */
63
+ export { FrameworkContext as UNSAFE_FrameworkContext } from "./lib/dom/ssr/components";
64
+ /** @internal */
65
+ export type { RouteModules as UNSAFE_RouteModules } from "./lib/dom/ssr/routeModules";
66
+ /** @internal */
67
+ export type { FutureConfig as UNSAFE_FutureConfig, AssetsManifest as UNSAFE_AssetsManifest, FrameworkContextObject as UNSAFE_FrameworkContextObject, } from "./lib/dom/ssr/entry";
68
+ /** @internal */
69
+ export type { EntryRoute as UNSAFE_EntryRoute, RouteManifest as UNSAFE_RouteManifest, } from "./lib/dom/ssr/routes";
70
+ /** @internal */
71
+ export type { SingleFetchRedirectResult as UNSAFE_SingleFetchRedirectResult, SingleFetchResult as UNSAFE_SingleFetchResult, SingleFetchResults as UNSAFE_SingleFetchResults, } from "./lib/dom/ssr/single-fetch";
72
+ export { decodeViaTurboStream as UNSAFE_decodeViaTurboStream, SingleFetchRedirectSymbol as UNSAFE_SingleFetchRedirectSymbol, } from "./lib/dom/ssr/single-fetch";