@tanstack/react-router 1.22.9 → 1.24.0

package/src/index.tsx

@@ -1,32 +1,283 @@
 //
-export * from '@tanstack/history'
+export {
+  createHistory,
+  createBrowserHistory,
+  createHashHistory,
+  createMemoryHistory,
+  type BlockerFn,
+  type HistoryLocation,
+  type RouterHistory,
+  type ParsedPath,
+  type HistoryState,
+} from '@tanstack/history'
 export { default as invariant } from 'tiny-invariant'
 export { default as warning } from 'tiny-warning'
-export * from './awaited'
-export * from './defer'
-export * from './CatchBoundary'
-export * from './fileRoute'
+export { useAwaited, Await, type AwaitOptions } from './awaited'
+export {
+  defer,
+  isDehydratedDeferred,
+  type DeferredPromiseState,
+  type DeferredPromise,
+} from './defer'
+export {
+  CatchBoundary,
+  CatchBoundaryImpl,
+  ErrorComponent,
+} from './CatchBoundary'
+export {
+  FileRoute,
+  createFileRoute,
+  FileRouteLoader,
+  LazyRoute,
+  createLazyRoute,
+  createLazyFileRoute,
+  type FileRoutesByPath,
+  type Trim,
+  type TrimLeft,
+  type TrimRight,
+  type RemoveUnderScores,
+  type ResolveFilePath,
+  type FileRoutePath,
+  type LazyRouteOptions,
+} from './fileRoute'
 export * from './history'
-export * from './lazyRouteComponent'
-export * from './link'
-export * from './location'
-export * from './Matches'
-export * from './path'
-export * from './qss'
-export * from './redirects'
-export * from './route'
-export * from './routeInfo'
-export * from './router'
-export * from './RouterProvider'
-export * from './scroll-restoration'
-export * from './searchParams'
-export * from './useBlocker'
-export * from './useNavigate'
-export * from './useParams'
-export * from './useSearch'
-export * from './routerContext'
-export * from './useRouteContext'
-export * from './useRouter'
-export * from './useRouterState'
-export * from './utils'
-export * from './not-found'
+export { lazyRouteComponent } from './lazyRouteComponent'
+export {
+  useLinkProps,
+  createLink,
+  Link,
+  type CleanPath,
+  type Split,
+  type ParsePathParams,
+  type Join,
+  type Last,
+  type RemoveTrailingSlashes,
+  type RemoveLeadingSlashes,
+  type SearchPaths,
+  type SearchRelativePathAutoComplete,
+  type RelativeToParentPathAutoComplete,
+  type RelativeToCurrentPathAutoComplete,
+  type AbsolutePathAutoComplete,
+  type RelativeToPathAutoComplete,
+  type NavigateOptions,
+  type ToOptions,
+  type ToMaskOptions,
+  type ToSubOptions,
+  type ResolveRoute,
+  type ParamOptions,
+  type SearchParamOptions,
+  type PathParamOptions,
+  type ToPathOption,
+  type ActiveOptions,
+  type LinkOptions,
+  type CheckPath,
+  type CheckPathError,
+  type ResolveRelativePath,
+  type UseLinkPropsOptions,
+  type ActiveLinkOptions,
+  type LinkProps,
+  type LinkComponent,
+} from './link'
+export { type ParsedLocation } from './location'
+export {
+  matchContext,
+  Matches,
+  Match,
+  Outlet,
+  useMatchRoute,
+  MatchRoute,
+  useMatch,
+  useMatches,
+  useParentMatches,
+  useChildMatches,
+  useLoaderDeps,
+  useLoaderData,
+  isServerSideError,
+  defaultDeserializeError,
+  getRenderedMatches,
+  type RouteMatch,
+  type AnyRouteMatch,
+  type MatchRouteOptions,
+  type UseMatchRouteOptions,
+  type MakeMatchRouteOptions,
+} from './Matches'
+export {
+  joinPaths,
+  cleanPath,
+  trimPathLeft,
+  trimPathRight,
+  trimPath,
+  resolvePath,
+  parsePathname,
+  interpolatePath,
+  matchPathname,
+  removeBasepath,
+  matchByPath,
+  type Segment,
+} from './path'
+export { encode, decode } from './qss'
+export {
+  redirect,
+  isRedirect,
+  type AnyRedirect,
+  type Redirect,
+  type ResolvedRedirect,
+} from './redirects'
+export {
+  rootRouteId,
+  RouteApi,
+  getRouteApi,
+  Route,
+  createRoute,
+  RootRoute,
+  rootRouteWithContext,
+  createRootRoute,
+  createRootRouteWithContext,
+  createRouteMask,
+  NotFoundRoute,
+  type RootRouteId,
+  type AnyPathParams,
+  type SearchSchemaInput,
+  type AnySearchSchema,
+  type AnyContext,
+  type RouteContext,
+  type PreloadableObj,
+  type RoutePathOptions,
+  type StaticDataRouteOption,
+  type RoutePathOptionsIntersection,
+  type RouteOptions,
+  type ParamsFallback,
+  type FileBaseRouteOptions,
+  type BaseRouteOptions,
+  type UpdatableRouteOptions,
+  type UpdatableStaticRouteOption,
+  type MetaDescriptor,
+  type RouteLinkEntry,
+  type ParseParamsOption,
+  type ParseParamsFn,
+  type ParseParamsObj,
+  type SearchSchemaValidator,
+  type SearchSchemaValidatorObj,
+  type SearchSchemaValidatorFn,
+  type RouteLoaderFn,
+  type LoaderFnContext,
+  type SearchFilter,
+  type ResolveId,
+  type InferFullSearchSchema,
+  type InferFullSearchSchemaInput,
+  type ResolveFullSearchSchema,
+  type ResolveFullSearchSchemaInput,
+  type AnyRoute,
+  type MergeFromFromParent,
+  type ResolveAllParams,
+  type RouteConstraints,
+  type AnyRootRoute,
+  type RootSearchSchema,
+  type ResolveFullPath,
+  type RouteMask,
+  type ErrorRouteProps,
+  type ErrorComponentProps,
+  type NotFoundRouteProps,
+  type ReactNode,
+  type SyncRouteComponent,
+  type AsyncRouteComponent,
+  type RouteComponent,
+  type ErrorRouteComponent,
+  type NotFoundRouteComponent,
+  type TrimPath,
+  type TrimPathLeft,
+  type TrimPathRight,
+} from './route'
+export {
+  type ParseRoute,
+  type RoutesById,
+  type RouteById,
+  type RouteIds,
+  type RoutesByPath,
+  type RouteByPath,
+  type RoutePaths,
+  type RoutePathsAutoComplete,
+  type FullSearchSchema,
+  type AllParams,
+} from './routeInfo'
+export {
+  componentTypes,
+  createRouter,
+  Router,
+  lazyFn,
+  SearchParamError,
+  PathParamError,
+  getInitialRouterState,
+  defaultSerializeError,
+  type Register,
+  type AnyRouter,
+  type RegisteredRouter,
+  type HydrationCtx,
+  type RouterContextOptions,
+  type RouterOptions,
+  type RouterTransformer,
+  type RouterErrorSerializer,
+  type RouterState,
+  type ListenerFn,
+  type BuildNextOptions,
+  type DehydratedRouterState,
+  type DehydratedRouteMatch,
+  type DehydratedRouter,
+  type RouterConstructorOptions,
+  type RouterEvents,
+  type RouterEvent,
+  type RouterListener,
+} from './router'
+export {
+  RouterProvider,
+  getRouteMatch,
+  type RouterProps,
+  type CommitLocationOptions,
+  type MatchLocation,
+  type NavigateFn,
+  type BuildLocationFn,
+  type InjectedHtmlEntry,
+} from './RouterProvider'
+export {
+  useScrollRestoration,
+  useElementScrollRestoration,
+  ScrollRestoration,
+  type ScrollRestorationOptions,
+} from './scroll-restoration'
+export {
+  defaultParseSearch,
+  defaultStringifySearch,
+  parseSearchWith,
+  stringifySearchWith,
+  type SearchSerializer,
+  type SearchParser,
+} from './searchParams'
+export { useBlocker, Block } from './useBlocker'
+export { useNavigate, Navigate, type UseNavigateResult } from './useNavigate'
+export { useParams } from './useParams'
+export { useSearch } from './useSearch'
+export {
+  getRouterContext, // SSR
+} from './routerContext'
+export { useRouteContext } from './useRouteContext'
+export { useRouter } from './useRouter'
+export { useRouterState } from './useRouterState'
+export {
+  escapeJSON, // SSR
+  useLayoutEffect, // SSR
+  pick,
+  functionalUpdate,
+  replaceEqualDeep,
+  isPlainObject,
+  isPlainArray,
+  deepEqual,
+  useStableCallback,
+  shallow,
+} from './utils'
+export {
+  notFound,
+  isNotFound,
+  CatchNotFound,
+  DefaultGlobalNotFound,
+  type NotFoundError,
+} from './not-found'

package/src/redirects.ts

@@ -2,7 +2,7 @@ import type { NavigateOptions } from './link'
 import type { AnyRoute } from './route'
 import type { RoutePaths } from './routeInfo'
 import type { RegisteredRouter } from './router'
-import type { PickAsRequired } from '.'
+import type { PickAsRequired } from './utils'
 
 export type AnyRedirect = Redirect<any, any, any, any, any>
 

package/src/route.ts

@@ -887,6 +887,10 @@ export class Route<
   }): TSelected => {
     return useLoaderData({ ...opts, from: this.id } as any)
   }
+
+  useNavigate = () => {
+    return useNavigate({ from: this.id })
+  }
 }
 
 export function createRoute<