@tanstack/react-router 1.109.2 → 1.111.6

package/src/index.tsx

@@ -106,6 +106,7 @@ export type {
   IntersectAssign,
   ResolveValidatorInput,
   ResolveValidatorOutput,
+  Register,
   AnyValidator,
   DefaultValidator,
   ValidatorFn,
@@ -120,6 +121,8 @@ export type {
   Validator,
   ValidatorAdapter,
   ValidatorObj,
+  FileRoutesByPath,
+  RouteById,
 } from '@tanstack/router-core'
 
 export {
@@ -150,11 +153,7 @@ export {
   createLazyRoute,
   createLazyFileRoute,
 } from './fileRoute'
-export type {
-  FileRoutesByPath,
-  FileRouteTypes,
-  LazyRouteOptions,
-} from './fileRoute'
+export type { LazyRouteOptions } from './fileRoute'
 
 export * from './history'
 
@@ -177,13 +176,37 @@ export type {
   PathParamOptions,
   ToPathOption,
   LinkOptions,
+  MakeOptionalPathParams,
+  FileRouteTypes,
+  RouteContextParameter,
+  BeforeLoadContextParameter,
+  ResolveAllContext,
+  ResolveAllParamsFromParent,
+  ResolveFullSearchSchema,
+  ResolveFullSearchSchemaInput,
+  RouteIds,
+  NavigateFn,
+  BuildLocationFn,
+  FullSearchSchemaOption,
+  MakeRemountDepsOptionsUnion,
+  RemountDepsOptions,
+  ResolveFullPath,
+  AnyRouteWithContext,
+  AnyRouterWithContext,
+  CommitLocationOptions,
+  MatchLocation,
+  UseNavigateResult,
+  AnyRedirect,
+  Redirect,
+  ResolvedRedirect,
+} from '@tanstack/router-core'
+export type {
   UseLinkPropsOptions,
   ActiveLinkOptions,
   LinkProps,
   LinkComponent,
   LinkComponentProps,
   CreateLinkProps,
-  MakeOptionalPathParams,
 } from './link'
 
 export {
@@ -213,7 +236,6 @@ export { useLoaderDeps } from './useLoaderDeps'
 export { useLoaderData } from './useLoaderData'
 
 export { redirect, isRedirect } from './redirects'
-export type { AnyRedirect, Redirect, ResolvedRedirect } from './redirects'
 
 export {
   RouteApi,
@@ -234,12 +256,9 @@ export type {
   UpdatableRouteOptions,
   RouteLoaderFn,
   LoaderFnContext,
-  ResolveFullSearchSchema,
-  ResolveFullSearchSchemaInput,
   AnyRoute,
   RouteConstraints,
   AnyRootRoute,
-  ResolveFullPath,
   RouteMask,
   ReactNode,
   SyncRouteComponent,
@@ -248,36 +267,13 @@ export type {
   ErrorRouteComponent,
   NotFoundRouteComponent,
   RootRouteOptions,
-  AnyRouteWithContext,
-  FullSearchSchemaOption,
   RouteContextFn,
   RouteContextOptions,
   BeforeLoadFn,
   BeforeLoadContextOptions,
   ContextOptions,
-  RouteContextParameter,
-  BeforeLoadContextParameter,
-  ResolveAllContext,
-  ResolveAllParamsFromParent,
-  MakeRemountDepsOptionsUnion,
-  RemountDepsOptions,
 } from './route'
 
-export type {
-  ParseRoute,
-  RoutesById,
-  RouteById,
-  RouteIds,
-  RoutesByPath,
-  RouteByPath,
-  RoutePaths,
-  FullSearchSchema,
-  AllParams,
-  AllLoaderData,
-  FullSearchSchemaInput,
-  AllContext,
-} from './routeInfo'
-
 export {
   componentTypes,
   createRouter,
@@ -289,7 +285,6 @@ export {
 } from './router'
 
 export type {
-  Register,
   AnyRouter,
   RegisteredRouter,
   RouterContextOptions,
@@ -302,19 +297,12 @@ export type {
   RouterEvents,
   RouterEvent,
   RouterListener,
-  AnyRouterWithContext,
   ControllablePromise,
   InjectedHtmlEntry,
 } from './router'
 
 export { RouterProvider, RouterContextProvider } from './RouterProvider'
-export type {
-  RouterProps,
-  CommitLocationOptions,
-  MatchLocation,
-  NavigateFn,
-  BuildLocationFn,
-} from './RouterProvider'
+export type { RouterProps } from './RouterProvider'
 
 export {
   useElementScrollRestoration,
@@ -325,7 +313,6 @@ export type { UseBlockerOpts, ShouldBlockFn } from './useBlocker'
 export { useBlocker, Block } from './useBlocker'
 
 export { useNavigate, Navigate } from './useNavigate'
-export type { UseNavigateResult } from './useNavigate'
 
 export { useParams } from './useParams'
 export { useSearch } from './useSearch'

package/src/link.tsx

@@ -19,35 +19,11 @@ import {
 import { useMatch } from './useMatch'
 import type {
   Constrain,
-  ConstrainLiteral,
-  Expand,
-  IsRequiredParams,
-  LinkOptionsProps,
-  MakeDifferenceOptional,
-  NoInfer,
-  NonNullableUpdater,
-  ParsedLocation,
-  PickRequired,
-  RemoveTrailingSlashes,
-  ResolveRelativePath,
-  Updater,
-  ViewTransitionOptions,
-  WithoutEmpty,
-} from '@tanstack/router-core'
-import type { HistoryState, ParsedHistoryState } from '@tanstack/history'
-import type {
-  AllParams,
-  CatchAllPaths,
-  CurrentPath,
-  FullSearchSchema,
-  FullSearchSchemaInput,
-  ParentPath,
-  RouteByPath,
-  RouteByToPath,
+  LinkCurrentTargetElement,
+  LinkOptions,
   RoutePaths,
-  RouteToPath,
-  ToPath,
-} from './routeInfo'
+} from '@tanstack/router-core'
+
 import type { AnyRouter, RegisteredRouter } from './router'
 import type { ReactNode } from 'react'
 import type {
@@ -55,405 +31,6 @@ import type {
   ValidateLinkOptionsArray,
 } from './typePrimitives'
 
-export type FindDescendantToPaths<
-  TRouter extends AnyRouter,
-  TPrefix extends string,
-> = `${TPrefix}/${string}` & RouteToPath<TRouter>
-
-export type InferDescendantToPaths<
-  TRouter extends AnyRouter,
-  TPrefix extends string,
-  TPaths = FindDescendantToPaths<TRouter, TPrefix>,
-> = TPaths extends `${TPrefix}/`
-  ? never
-  : TPaths extends `${TPrefix}/${infer TRest}`
-    ? TRest
-    : never
-
-export type RelativeToPath<
-  TRouter extends AnyRouter,
-  TTo extends string,
-  TResolvedPath extends string,
-> =
-  | (TResolvedPath & RouteToPath<TRouter> extends never
-      ? never
-      : ToPath<TRouter, TTo>)
-  | `${RemoveTrailingSlashes<TTo>}/${InferDescendantToPaths<TRouter, RemoveTrailingSlashes<TResolvedPath>>}`
-
-export type RelativeToParentPath<
-  TRouter extends AnyRouter,
-  TFrom extends string,
-  TTo extends string,
-  TResolvedPath extends string = ResolveRelativePath<TFrom, TTo>,
-> =
-  | RelativeToPath<TRouter, TTo, TResolvedPath>
-  | (TTo extends `${string}..` | `${string}../`
-      ? TResolvedPath extends '/' | ''
-        ? never
-        : FindDescendantToPaths<
-              TRouter,
-              RemoveTrailingSlashes<TResolvedPath>
-            > extends never
-          ? never
-          : `${RemoveTrailingSlashes<TTo>}/${ParentPath<TRouter>}`
-      : never)
-
-export type RelativeToCurrentPath<
-  TRouter extends AnyRouter,
-  TFrom extends string,
-  TTo extends string,
-  TResolvedPath extends string = ResolveRelativePath<TFrom, TTo>,
-> = RelativeToPath<TRouter, TTo, TResolvedPath> | CurrentPath<TRouter>
-
-export type AbsoluteToPath<TRouter extends AnyRouter, TFrom extends string> =
-  | (string extends TFrom
-      ? CurrentPath<TRouter>
-      : TFrom extends `/`
-        ? never
-        : CurrentPath<TRouter>)
-  | (string extends TFrom
-      ? ParentPath<TRouter>
-      : TFrom extends `/`
-        ? never
-        : ParentPath<TRouter>)
-  | RouteToPath<TRouter>
-  | (TFrom extends '/'
-      ? never
-      : string extends TFrom
-        ? never
-        : InferDescendantToPaths<TRouter, RemoveTrailingSlashes<TFrom>>)
-
-export type RelativeToPathAutoComplete<
-  TRouter extends AnyRouter,
-  TFrom extends string,
-  TTo extends string,
-> = string extends TTo
-  ? string
-  : string extends TFrom
-    ? AbsoluteToPath<TRouter, TFrom>
-    : TTo & `..${string}` extends never
-      ? TTo & `.${string}` extends never
-        ? AbsoluteToPath<TRouter, TFrom>
-        : RelativeToCurrentPath<TRouter, TFrom, TTo>
-      : RelativeToParentPath<TRouter, TFrom, TTo>
-
-export type NavigateOptions<
-  TRouter extends AnyRouter = RegisteredRouter,
-  TFrom extends string = string,
-  TTo extends string | undefined = '.',
-  TMaskFrom extends string = TFrom,
-  TMaskTo extends string = '.',
-> = ToOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo> & NavigateOptionProps
-
-export interface NavigateOptionProps {
-  // if set to `true`, the router will scroll the element with an id matching the hash into view with default ScrollIntoViewOptions.
-  // if set to `false`, the router will not scroll the element with an id matching the hash into view.
-  // if set to `ScrollIntoViewOptions`, the router will scroll the element with an id matching the hash into view with the provided options.
-  hashScrollIntoView?: boolean | ScrollIntoViewOptions
-  // `replace` is a boolean that determines whether the navigation should replace the current history entry or push a new one.
-  replace?: boolean
-  resetScroll?: boolean
-  /** @deprecated All navigations now use startTransition under the hood */
-  startTransition?: boolean
-  // if set to `true`, the router will wrap the resulting navigation in a document.startViewTransition() call.
-  // if set to `ViewTransitionOptions`, the router will pass the `types` field to document.startViewTransition({update: fn, types: viewTransition.types}) call
-  viewTransition?: boolean | ViewTransitionOptions
-  ignoreBlocker?: boolean
-  reloadDocument?: boolean
-  href?: string
-}
-
-export type ToOptions<
-  TRouter extends AnyRouter = RegisteredRouter,
-  TFrom extends string = string,
-  TTo extends string | undefined = '.',
-  TMaskFrom extends string = TFrom,
-  TMaskTo extends string = '.',
-> = ToSubOptions<TRouter, TFrom, TTo> & MaskOptions<TRouter, TMaskFrom, TMaskTo>
-
-export interface MaskOptions<
-  in out TRouter extends AnyRouter,
-  in out TMaskFrom extends string,
-  in out TMaskTo extends string,
-> {
-  _fromLocation?: ParsedLocation
-  mask?: ToMaskOptions<TRouter, TMaskFrom, TMaskTo>
-}
-
-export type ToMaskOptions<
-  TRouter extends AnyRouter = RegisteredRouter,
-  TMaskFrom extends string = string,
-  TMaskTo extends string = '.',
-> = ToSubOptions<TRouter, TMaskFrom, TMaskTo> & {
-  unmaskOnReload?: boolean
-}
-
-export type ToSubOptions<
-  TRouter extends AnyRouter = RegisteredRouter,
-  TFrom extends string = string,
-  TTo extends string | undefined = '.',
-> = ToSubOptionsProps<TRouter, TFrom, TTo> &
-  SearchParamOptions<TRouter, TFrom, TTo> &
-  PathParamOptions<TRouter, TFrom, TTo>
-
-export interface RequiredToOptions<
-  in out TRouter extends AnyRouter,
-  in out TFrom extends string,
-  in out TTo extends string | undefined,
-> {
-  to: ToPathOption<TRouter, TFrom, TTo> & {}
-}
-
-export interface OptionalToOptions<
-  in out TRouter extends AnyRouter,
-  in out TFrom extends string,
-  in out TTo extends string | undefined,
-> {
-  to?: ToPathOption<TRouter, TFrom, TTo> & {}
-}
-
-export type MakeToRequired<
-  TRouter extends AnyRouter,
-  TFrom extends string,
-  TTo extends string | undefined,
-> = string extends TFrom
-  ? string extends TTo
-    ? OptionalToOptions<TRouter, TFrom, TTo>
-    : TTo & CatchAllPaths<TRouter> extends never
-      ? RequiredToOptions<TRouter, TFrom, TTo>
-      : OptionalToOptions<TRouter, TFrom, TTo>
-  : OptionalToOptions<TRouter, TFrom, TTo>
-
-export type ToSubOptionsProps<
-  TRouter extends AnyRouter = RegisteredRouter,
-  TFrom extends RoutePaths<TRouter['routeTree']> | string = string,
-  TTo extends string | undefined = '.',
-> = MakeToRequired<TRouter, TFrom, TTo> & {
-  hash?: true | Updater<string>
-  state?: true | NonNullableUpdater<ParsedHistoryState, HistoryState>
-  from?: FromPathOption<TRouter, TFrom> & {}
-}
-
-export type ParamsReducerFn<
-  in out TRouter extends AnyRouter,
-  in out TParamVariant extends ParamVariant,
-  in out TFrom,
-  in out TTo,
-> = (
-  current: Expand<ResolveFromParams<TRouter, TParamVariant, TFrom>>,
-) => Expand<ResolveRelativeToParams<TRouter, TParamVariant, TFrom, TTo>>
-
-type ParamsReducer<
-  TRouter extends AnyRouter,
-  TParamVariant extends ParamVariant,
-  TFrom,
-  TTo,
-> =
-  | Expand<ResolveRelativeToParams<TRouter, TParamVariant, TFrom, TTo>>
-  | (ParamsReducerFn<TRouter, TParamVariant, TFrom, TTo> & {})
-
-type ParamVariant = 'PATH' | 'SEARCH'
-
-export type ResolveRoute<
-  TRouter extends AnyRouter,
-  TFrom,
-  TTo,
-  TPath = ResolveRelativePath<TFrom, TTo>,
-> = TPath extends string
-  ? TFrom extends TPath
-    ? RouteByPath<TRouter['routeTree'], TPath>
-    : RouteByToPath<TRouter, TPath>
-  : never
-
-type ResolveFromParamType<TParamVariant extends ParamVariant> =
-  TParamVariant extends 'PATH' ? 'allParams' : 'fullSearchSchema'
-
-type ResolveFromAllParams<
-  TRouter extends AnyRouter,
-  TParamVariant extends ParamVariant,
-> = TParamVariant extends 'PATH'
-  ? AllParams<TRouter['routeTree']>
-  : FullSearchSchema<TRouter['routeTree']>
-
-type ResolveFromParams<
-  TRouter extends AnyRouter,
-  TParamVariant extends ParamVariant,
-  TFrom,
-> = string extends TFrom
-  ? ResolveFromAllParams<TRouter, TParamVariant>
-  : RouteByPath<
-      TRouter['routeTree'],
-      TFrom
-    >['types'][ResolveFromParamType<TParamVariant>]
-
-type ResolveToParamType<TParamVariant extends ParamVariant> =
-  TParamVariant extends 'PATH' ? 'allParams' : 'fullSearchSchemaInput'
-
-type ResolveAllToParams<
-  TRouter extends AnyRouter,
-  TParamVariant extends ParamVariant,
-> = TParamVariant extends 'PATH'
-  ? AllParams<TRouter['routeTree']>
-  : FullSearchSchemaInput<TRouter['routeTree']>
-
-export type ResolveToParams<
-  TRouter extends AnyRouter,
-  TParamVariant extends ParamVariant,
-  TFrom,
-  TTo,
-> =
-  ResolveRelativePath<TFrom, TTo> extends infer TPath
-    ? undefined extends TPath
-      ? never
-      : string extends TPath
-        ? ResolveAllToParams<TRouter, TParamVariant>
-        : TPath extends CatchAllPaths<TRouter>
-          ? ResolveAllToParams<TRouter, TParamVariant>
-          : ResolveRoute<
-              TRouter,
-              TFrom,
-              TTo
-            >['types'][ResolveToParamType<TParamVariant>]
-    : never
-
-type ResolveRelativeToParams<
-  TRouter extends AnyRouter,
-  TParamVariant extends ParamVariant,
-  TFrom,
-  TTo,
-  TToParams = ResolveToParams<TRouter, TParamVariant, TFrom, TTo>,
-> = TParamVariant extends 'SEARCH'
-  ? TToParams
-  : string extends TFrom
-    ? TToParams
-    : MakeDifferenceOptional<
-        ResolveFromParams<TRouter, TParamVariant, TFrom>,
-        TToParams
-      >
-
-export interface MakeOptionalSearchParams<
-  in out TRouter extends AnyRouter,
-  in out TFrom,
-  in out TTo,
-> {
-  search?: true | (ParamsReducer<TRouter, 'SEARCH', TFrom, TTo> & {})
-}
-
-export interface MakeOptionalPathParams<
-  in out TRouter extends AnyRouter,
-  in out TFrom,
-  in out TTo,
-> {
-  params?: true | (ParamsReducer<TRouter, 'PATH', TFrom, TTo> & {})
-}
-
-type MakeRequiredParamsReducer<
-  TRouter extends AnyRouter,
-  TParamVariant extends ParamVariant,
-  TFrom,
-  TTo,
-> =
-  | (string extends TFrom
-      ? never
-      : ResolveFromParams<TRouter, TParamVariant, TFrom> extends WithoutEmpty<
-            PickRequired<
-              ResolveRelativeToParams<TRouter, TParamVariant, TFrom, TTo>
-            >
-          >
-        ? true
-        : never)
-  | (ParamsReducer<TRouter, TParamVariant, TFrom, TTo> & {})
-
-export interface MakeRequiredPathParams<
-  in out TRouter extends AnyRouter,
-  in out TFrom,
-  in out TTo,
-> {
-  params: MakeRequiredParamsReducer<TRouter, 'PATH', TFrom, TTo> & {}
-}
-
-export interface MakeRequiredSearchParams<
-  in out TRouter extends AnyRouter,
-  in out TFrom,
-  in out TTo,
-> {
-  search: MakeRequiredParamsReducer<TRouter, 'SEARCH', TFrom, TTo> & {}
-}
-
-export type IsRequired<
-  TRouter extends AnyRouter,
-  TParamVariant extends ParamVariant,
-  TFrom,
-  TTo,
-> =
-  ResolveRelativePath<TFrom, TTo> extends infer TPath
-    ? undefined extends TPath
-      ? never
-      : TPath extends CatchAllPaths<TRouter>
-        ? never
-        : IsRequiredParams<
-            ResolveRelativeToParams<TRouter, TParamVariant, TFrom, TTo>
-          >
-    : never
-
-export type SearchParamOptions<TRouter extends AnyRouter, TFrom, TTo> =
-  IsRequired<TRouter, 'SEARCH', TFrom, TTo> extends never
-    ? MakeOptionalSearchParams<TRouter, TFrom, TTo>
-    : MakeRequiredSearchParams<TRouter, TFrom, TTo>
-
-export type PathParamOptions<TRouter extends AnyRouter, TFrom, TTo> =
-  IsRequired<TRouter, 'PATH', TFrom, TTo> extends never
-    ? MakeOptionalPathParams<TRouter, TFrom, TTo>
-    : MakeRequiredPathParams<TRouter, TFrom, TTo>
-
-export type ToPathOption<
-  TRouter extends AnyRouter = AnyRouter,
-  TFrom extends string = string,
-  TTo extends string | undefined = string,
-> = ConstrainLiteral<
-  TTo,
-  RelativeToPathAutoComplete<
-    TRouter,
-    NoInfer<TFrom> extends string ? NoInfer<TFrom> : '',
-    NoInfer<TTo> & string
-  >
->
-
-export type FromPathOption<TRouter extends AnyRouter, TFrom> = ConstrainLiteral<
-  TFrom,
-  RoutePaths<TRouter['routeTree']>
->
-
-export type LinkOptions<
-  TRouter extends AnyRouter = RegisteredRouter,
-  TFrom extends string = string,
-  TTo extends string | undefined = '.',
-  TMaskFrom extends string = TFrom,
-  TMaskTo extends string = '.',
-> = NavigateOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo> & LinkOptionsProps
-
-// type Test1 = ResolveRelativePath<'/', '/posts'>
-// //   ^?
-// type Test4 = ResolveRelativePath<'/posts/1/comments', '../..'>
-// //   ^?
-// type Test5 = ResolveRelativePath<'/posts/1/comments', '../../..'>
-// //   ^?
-// type Test6 = ResolveRelativePath<'/posts/1/comments', './1'>
-// //   ^?
-// type Test7 = ResolveRelativePath<'/posts/1/comments', './1/2'>
-// //   ^?
-// type Test8 = ResolveRelativePath<'/posts/1/comments', '../edit'>
-// //   ^?
-// type Test9 = ResolveRelativePath<'/posts/1/comments', '1'>
-// //   ^?
-// type Test10 = ResolveRelativePath<'/posts/1/comments', './1'>
-// //   ^?
-// type Test11 = ResolveRelativePath<'/posts/1/comments', './1/2'>
-// //   ^?
-type LinkCurrentTargetElement = {
-  preloadTimeout?: null | ReturnType<typeof setTimeout>
-}
-
 export function useLinkProps<
   TRouter extends AnyRouter = RegisteredRouter,
   const TFrom extends string = string,

package/src/not-found.tsx

@@ -3,7 +3,7 @@ import { CatchBoundary } from './CatchBoundary'
 import { useRouterState } from './useRouterState'
 import type { ErrorInfo } from 'react'
 import type { RegisteredRouter } from './router'
-import type { RouteIds } from './routeInfo'
+import type { RouteIds } from '@tanstack/router-core'
 
 export type NotFoundError = {
   /**

package/src/redirects.ts

@@ -1,39 +1,9 @@
-import type { NavigateOptions } from './link'
-import type { RoutePaths } from './routeInfo'
-import type { AnyRouter, RegisteredRouter } from './router'
-import type { PickAsRequired } from '@tanstack/router-core'
-
-export type AnyRedirect = Redirect<any, any, any, any, any>
-
-export type Redirect<
-  TRouter extends AnyRouter = RegisteredRouter,
-  TFrom extends RoutePaths<TRouter['routeTree']> | string = '/',
-  TTo extends string | undefined = '.',
-  TMaskFrom extends RoutePaths<TRouter['routeTree']> | string = TFrom,
-  TMaskTo extends string = '.',
-> = {
-  href?: string
-  /**
-   * @deprecated Use `statusCode` instead
-   **/
-  code?: number
-  statusCode?: number
-  throw?: any
-  headers?: HeadersInit
-} & NavigateOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>
-
-export type ResolvedRedirect<
-  TRouter extends AnyRouter = RegisteredRouter,
-  TFrom extends RoutePaths<TRouter['routeTree']> = '/',
-  TTo extends string = '',
-  TMaskFrom extends RoutePaths<TRouter['routeTree']> = TFrom,
-  TMaskTo extends string = '',
-> = PickAsRequired<
-  Redirect<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>,
-  'code' | 'statusCode' | 'headers'
-> & {
-  href: string
-}
+import type {
+  AnyRedirect,
+  Redirect,
+  ResolvedRedirect,
+} from '@tanstack/router-core'
+import type { RegisteredRouter } from './router'
 
 export function redirect<
   TRouter extends RegisteredRouter,