@tanstack/react-router 1.17.4 → 1.17.5

package/src/link.tsx

@@ -4,7 +4,7 @@ import { useRouterState } from './useRouterState'
 import { useRouter } from './useRouter'
 import { Trim } from './fileRoute'
 import { AnyRoute, ReactNode, RootSearchSchema } from './route'
-import { RouteByPath, RouteIds, RoutePaths } from './routeInfo'
+import { RouteByPath, RoutePaths, RoutePathsAutoComplete } from './routeInfo'
 import { RegisteredRouter } from './router'
 import { LinkProps, UseLinkPropsOptions } from './useNavigate'
 import {
@@ -14,7 +14,6 @@ import {
   NoInfer,
   NonNullableUpdater,
   PickRequired,
-  StringLiteral,
   Updater,
   WithoutEmpty,
   deepEqual,
@@ -70,62 +69,81 @@ export type Join<T, Delimiter extends string = '/'> = T extends []
 
 export type Last<T extends any[]> = T extends [...infer _, infer L] ? L : never
 
+export type RemoveTrailingSlashes<T> = T extends `${infer R}/`
+  ? RemoveTrailingSlashes<R>
+  : T
+
+export type RemoveLeadingSlashes<T> = T extends `/${infer R}`
+  ? RemoveLeadingSlashes<R>
+  : T
+
+export type SearchPaths<
+  TPaths,
+  TSearchPath extends string,
+> = TPaths extends `${TSearchPath}/${infer TRest}` ? TRest : never
+
+export type SearchRelativePathAutoComplete<
+  TTo extends string,
+  TSearchPath extends string,
+  TPaths,
+  SearchedPaths = SearchPaths<TPaths, TSearchPath>,
+> = SearchedPaths extends string ? `${TTo}/${SearchedPaths}` : never
+
+export type RelativeToParentPathAutoComplete<
+  TFrom extends string,
+  TTo extends string,
+  TPaths,
+  TResolvedPath extends string = RemoveTrailingSlashes<
+    ResolveRelativePath<TFrom, TTo>
+  >,
+> =
+  | SearchRelativePathAutoComplete<TTo, TResolvedPath, TPaths>
+  | (TResolvedPath extends '' ? never : `${TTo}/../`)
+
+export type RelativeToCurrentPathAutoComplete<
+  TFrom extends string,
+  TTo extends string,
+  TRestTo extends string,
+  TPaths,
+  TResolvedPath extends
+    string = RemoveTrailingSlashes<`${RemoveTrailingSlashes<TFrom>}/${RemoveLeadingSlashes<TRestTo>}`>,
+> = SearchRelativePathAutoComplete<TTo, TResolvedPath, TPaths>
+
+export type AbsolutePathAutoComplete<TFrom extends string, TPaths> =
+  | (string extends TFrom
+      ? never
+      : TFrom extends `/`
+        ? never
+        : SearchPaths<
+              TPaths,
+              RemoveTrailingSlashes<TFrom>
+            > extends infer SearchedPaths
+          ? SearchedPaths extends ''
+            ? never
+            : './'
+          : never)
+  | (string extends TFrom ? never : TFrom extends `/` ? never : '../')
+  | TPaths
+
 export type RelativeToPathAutoComplete<
-  AllPaths extends string,
+  TRouteTree extends AnyRoute,
   TFrom extends string,
   TTo extends string,
-> = TTo extends `..${infer _}`
-  ? Split<AllPaths, false> extends infer SplitPaths
-    ? SplitPaths extends [
-        ...Split<ResolveRelativePath<TFrom, TTo>, false>,
-        ...infer TToRest,
-      ]
-      ? `${CleanPath<
-          Join<
-            [
-              ...Split<TTo, false>,
-              ...(
-                | TToRest
-                | (Split<
-                    ResolveRelativePath<TFrom, TTo>,
-                    false
-                  >['length'] extends 1
-                    ? never
-                    : ['../'])
-              ),
-            ]
-          >
-        >}`
-      : never
-    : never
-  : TTo extends `./${infer RestTTo}`
-    ? Split<AllPaths, false> extends infer SplitPaths
-      ? SplitPaths extends [
-          ...Split<TFrom, false>,
-          ...Split<RestTTo, false>,
-          ...infer RestPath,
-        ]
-        ? `${TTo}${Join<RestPath>}`
-        : never
-      : never
-    :
-        | (string extends TFrom
-            ? '/'
-            : TFrom extends `/`
-              ? never
-              : Split<AllPaths, false> extends infer SplitPaths
-                ? SplitPaths extends [...Split<TFrom, false>, ...infer RestPath]
-                  ? Join<RestPath> extends { length: 0 }
-                    ? never
-                    : './'
-                  : never
-                : never)
-        | (string extends TFrom ? '../' : TFrom extends `/` ? never : '../')
-        | AllPaths
+  TPaths = RoutePaths<TRouteTree>,
+> = TTo extends `..${string}`
+  ? RelativeToParentPathAutoComplete<TFrom, RemoveTrailingSlashes<TTo>, TPaths>
+  : TTo extends `./${infer TRestTTo}`
+    ? RelativeToCurrentPathAutoComplete<
+        TFrom,
+        RemoveTrailingSlashes<TTo>,
+        TRestTTo,
+        TPaths
+      >
+    : AbsolutePathAutoComplete<TFrom, TPaths>
 
 export type NavigateOptions<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TFrom extends RoutePaths<TRouteTree> | string = RoutePaths<TRouteTree>,
+  TFrom extends RoutePaths<TRouteTree> | string = string,
   TTo extends string = '',
   TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom,
   TMaskTo extends string = '',
@@ -139,7 +157,7 @@ export type NavigateOptions<
 
 export type ToOptions<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TFrom extends RoutePaths<TRouteTree> | string = RoutePaths<TRouteTree>,
+  TFrom extends RoutePaths<TRouteTree> | string = string,
   TTo extends string = '',
   TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom,
   TMaskTo extends string = '',
@@ -149,7 +167,7 @@ export type ToOptions<
 
 export type ToMaskOptions<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TMaskFrom extends RoutePaths<TRouteTree> | string = RoutePaths<TRouteTree>,
+  TMaskFrom extends RoutePaths<TRouteTree> | string = string,
   TMaskTo extends string = '',
 > = ToSubOptions<TRouteTree, TMaskFrom, TMaskTo> & {
   unmaskOnReload?: boolean
@@ -157,9 +175,8 @@ export type ToMaskOptions<
 
 export type ToSubOptions<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TFrom extends RoutePaths<TRouteTree> | string = RoutePaths<TRouteTree>,
+  TFrom extends RoutePaths<TRouteTree> | string = string,
   TTo extends string = '',
-  TResolved = ResolveRelativePath<TFrom, NoInfer<TTo>>,
 > = {
   to?: ToPathOption<TRouteTree, TFrom, TTo>
   // The new has string or a function to update it
@@ -167,11 +184,11 @@ export type ToSubOptions<
   // State to pass to the history stack
   state?: true | NonNullableUpdater<HistoryState>
   // The source route path. This is automatically set when using route-level APIs, but for type-safe relative routing on the router itself, this is required
-  from?: StringLiteral<TFrom>
+  from?: RoutePathsAutoComplete<TRouteTree, TFrom>
   // // When using relative route paths, this option forces resolution from the current path, instead of the route API's path or `from` path
-} & CheckPath<TRouteTree, NoInfer<TResolved>, {}> &
-  SearchParamOptions<TRouteTree, TFrom, TTo, TResolved> &
-  PathParamOptions<TRouteTree, TFrom, TTo, TResolved>
+} & CheckPath<TRouteTree, {}, TFrom, TTo> &
+  SearchParamOptions<TRouteTree, TFrom, TTo> &
+  PathParamOptions<TRouteTree, TFrom, TTo>
 
 type ParamsReducer<TFrom, TTo> = TTo | ((current: TFrom) => TTo)
 
@@ -182,6 +199,18 @@ type ExcludeRootSearchSchema<T, Excluded = Exclude<T, RootSearchSchema>> = [
   ? {}
   : Excluded
 
+export type ResolveRoute<
+  TRouteTree extends AnyRoute,
+  TFrom,
+  TTo,
+  TPath = RemoveTrailingSlashes<
+    string extends TTo ? TFrom : ResolveRelativePath<TFrom, TTo>
+  >,
+> =
+  RouteByPath<TRouteTree, `${TPath & string}/`> extends never
+    ? RouteByPath<TRouteTree, TPath>
+    : RouteByPath<TRouteTree, `${TPath & string}/`>
+
 type PostProcessParams<
   T,
   TParamVariant extends ParamVariant,
@@ -191,7 +220,6 @@ export type ParamOptions<
   TRouteTree extends AnyRoute,
   TFrom,
   TTo extends string,
-  TResolved,
   TParamVariant extends ParamVariant,
   TFromRouteType extends
     | 'allParams'
@@ -207,25 +235,10 @@ export type ParamOptions<
     RouteByPath<TRouteTree, TFrom>['types'][TFromRouteType],
     TParamVariant
   >,
-  TToIndex = TTo extends ''
-    ? ''
-    : RouteByPath<TRouteTree, `${TTo}/`> extends never
-      ? TTo
-      : `${TTo}/`,
-  TToParams = TToIndex extends ''
-    ? PostProcessParams<
-        RouteByPath<TRouteTree, TFrom>['types'][TToRouteType],
-        TParamVariant
-      >
-    : [TResolved] extends [never]
-      ? PostProcessParams<
-          RouteByPath<TRouteTree, TToIndex>['types'][TToRouteType],
-          TParamVariant
-        >
-      : PostProcessParams<
-          RouteByPath<TRouteTree, TResolved>['types'][TToRouteType],
-          TParamVariant
-        >,
+  TToParams = PostProcessParams<
+    ResolveRoute<TRouteTree, TFrom, TTo>['types'][TToRouteType],
+    TParamVariant
+  >,
   TRelativeToParams = TParamVariant extends 'SEARCH'
     ? TToParams
     : true extends IsUnion<TFromParams>
@@ -252,15 +265,13 @@ export type SearchParamOptions<
   TRouteTree extends AnyRoute,
   TFrom,
   TTo extends string,
-  TResolved,
-> = ParamOptions<TRouteTree, TFrom, TTo, TResolved, 'SEARCH'>
+> = ParamOptions<TRouteTree, TFrom, TTo, 'SEARCH'>
 
 export type PathParamOptions<
   TRouteTree extends AnyRoute,
   TFrom,
   TTo extends string,
-  TResolved,
-> = ParamOptions<TRouteTree, TFrom, TTo, TResolved, 'PATH'>
+> = ParamOptions<TRouteTree, TFrom, TTo, 'PATH'>
 
 export type ToPathOption<
   TRouteTree extends AnyRoute = AnyRoute,
@@ -269,7 +280,7 @@ export type ToPathOption<
 > =
   | TTo
   | RelativeToPathAutoComplete<
-      RoutePaths<TRouteTree>,
+      TRouteTree,
       NoInfer<TFrom> extends string ? NoInfer<TFrom> : '',
       NoInfer<TTo> & string
     >
@@ -299,12 +310,12 @@ export type LinkOptions<
   disabled?: boolean
 }
 
-export type CheckPath<TRouteTree extends AnyRoute, TPath, TPass> =
-  Exclude<TPath, RoutePaths<TRouteTree>> extends never
-    ? TPass
-    : CheckPathError<TRouteTree, Exclude<TPath, RoutePaths<TRouteTree>>>
+export type CheckPath<TRouteTree extends AnyRoute, TPass, TFrom, TTo> =
+  ResolveRoute<TRouteTree, TFrom, TTo> extends never
+    ? CheckPathError<TRouteTree>
+    : TPass
 
-export type CheckPathError<TRouteTree extends AnyRoute, TInvalids> = {
+export type CheckPathError<TRouteTree extends AnyRoute> = {
   to: RoutePaths<TRouteTree>
 }
 
@@ -321,7 +332,7 @@ export type ResolveRelativePath<TFrom, TTo = '.'> = TFrom extends string
             : Split<TTo> extends ['..', ...infer ToRest]
               ? Split<TFrom> extends [...infer FromRest, infer FromTail]
                 ? ToRest extends ['/']
-                  ? Join<[...FromRest, '/']>
+                  ? Join<['/', ...FromRest, '/']>
                   : ResolveRelativePath<Join<FromRest>, Join<ToRest>>
                 : never
               : Split<TTo> extends ['.', ...infer ToRest]

package/src/route.ts

@@ -1,6 +1,6 @@
 import * as React from 'react'
 import invariant from 'tiny-invariant'
-import { useLoaderData, useLoaderDeps, useMatch } from './Matches'
+import { useLoaderData, useLoaderDeps, useMatch, RouteMatch } from './Matches'
 import { AnyRouteMatch } from './Matches'
 import { NavigateOptions, ParsePathParams, ToSubOptions } from './link'
 import { ParsedLocation } from './location'
@@ -180,7 +180,7 @@ type BeforeLoadFn<
   params: TAllParams
   context: TContext
   location: ParsedLocation
-  navigate: NavigateFn<AnyRoute>
+  navigate: NavigateFn
   buildLocation: BuildLocationFn<TParentRoute>
   cause: 'preload' | 'enter' | 'stay'
 }) => Promise<TRouteContextReturn> | TRouteContextReturn | void
@@ -551,8 +551,12 @@ export class RouteApi<
     this.id = id as any
   }
 
-  useMatch = <TSelected = TAllContext>(opts?: {
-    select?: (s: TAllContext) => TSelected
+  useMatch = <
+    TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
+    TRouteMatchState = RouteMatch<TRouteTree, TId>,
+    TSelected = TRouteMatchState,
+  >(opts?: {
+    select?: (match: TRouteMatchState) => TSelected
   }): TSelected => {
     return useMatch({ select: opts?.select, from: this.id })
   }
@@ -600,7 +604,7 @@ export class RouteApi<
  */
 export class Route<
   TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute,
-  TPath extends RouteConstraints['TPath'] = '/',
+  in out TPath extends RouteConstraints['TPath'] = '/',
   TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath<
     TParentRoute,
     TPath
@@ -636,12 +640,12 @@ export class Route<
     TParams
   >,
   TRouteContextReturn extends RouteConstraints['TRouteContext'] = RouteContext,
-  TRouteContext extends RouteConstraints['TRouteContext'] = [
+  in out TRouteContext extends RouteConstraints['TRouteContext'] = [
     TRouteContextReturn,
   ] extends [never]
     ? RouteContext
     : TRouteContextReturn,
-  TAllContext extends Expand<
+  in out TAllContext extends Expand<
     Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>
   > = Expand<
     Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>
@@ -886,8 +890,12 @@ export class Route<
     return this
   }
 
-  useMatch = <TSelected = TAllContext>(opts?: {
-    select?: (search: TAllContext) => TSelected
+  useMatch = <
+    TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
+    TRouteMatchState = RouteMatch<TRouteTree, TId>,
+    TSelected = TRouteMatchState,
+  >(opts?: {
+    select?: (match: TRouteMatchState) => TSelected
   }): TSelected => {
     return useMatch({ ...opts, from: this.id })
   }

package/src/routeInfo.ts

@@ -1,51 +1,21 @@
-import { AnyRoute, Route } from './route'
+import { AnyRoute } from './route'
 import { Expand, UnionToIntersection, UnionToTuple } from './utils'
 
-export type ParseRoute<TRouteTree extends AnyRoute> =
-  | TRouteTree
-  | ParseRouteChildren<TRouteTree>
-
-export type ParseRouteChildren<TRouteTree extends AnyRoute> =
-  TRouteTree extends Route<
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    infer TChildren,
-    any
-  >
-    ? unknown extends TChildren
-      ? never
-      : TChildren extends AnyRoute[]
-        ? {
-            [TId in TChildren[number]['id'] as string]: ParseRoute<
-              TChildren[number]
-            >
-          }[string]
-        : never
-    : never
+export type ParseRoute<TRouteTree, TAcc = TRouteTree> = TRouteTree extends {
+  types: { children: infer TChildren }
+}
+  ? TChildren extends unknown[]
+    ? ParseRoute<TChildren[number], TAcc | TChildren[number]>
+    : TAcc
+  : TAcc
 
 export type RoutesById<TRouteTree extends AnyRoute> = {
   [K in ParseRoute<TRouteTree> as K['id']]: K
 }
 
 export type RouteById<TRouteTree extends AnyRoute, TId> = Extract<
-  ParseRoute<TRouteTree>,
-  { id: TId }
+  Extract<ParseRoute<TRouteTree>, { id: TId }>,
+  AnyRoute
 >
 
 export type RouteIds<TRouteTree extends AnyRoute> = ParseRoute<TRouteTree>['id']
@@ -55,14 +25,18 @@ export type RoutesByPath<TRouteTree extends AnyRoute> = {
 }
 
 export type RouteByPath<TRouteTree extends AnyRoute, TPath> = Extract<
-  ParseRoute<TRouteTree>,
-  { fullPath: TPath }
+  Extract<ParseRoute<TRouteTree>, { fullPath: TPath }>,
+  AnyRoute
 >
-
 export type RoutePaths<TRouteTree extends AnyRoute> =
   | ParseRoute<TRouteTree>['fullPath']
   | '/'
 
+export type RoutePathsAutoComplete<TRouteTree extends AnyRoute, T> =
+  | T
+  | RoutePaths<TRouteTree>
+  | (string & {})
+
 type UnionizeCollisions<T, U> = {
   [P in keyof T & keyof U]: T[P] extends U[P] ? T[P] : T[P] | U[P]
 }

package/src/router.ts

@@ -1067,7 +1067,7 @@ export class Router<
     })
   }
 
-  navigate: NavigateFn<TRouteTree> = ({ from, to, ...rest }) => {
+  navigate: NavigateFn = ({ from, to, ...rest }) => {
     // If this link simply reloads the current route,
     // make sure it has a new key so it will trigger a data refresh
 

package/src/useNavigate.tsx

@@ -3,13 +3,13 @@ import { useMatch } from './Matches'
 import { useRouter } from './useRouter'
 import { LinkOptions, NavigateOptions } from './link'
 import { AnyRoute } from './route'
-import { RoutePaths } from './routeInfo'
+import { RoutePaths, RoutePathsAutoComplete } from './routeInfo'
 import { RegisteredRouter } from './router'
 
 export type UseNavigateResult<TDefaultFrom extends string> = <
+  TTo extends string,
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
   TFrom extends RoutePaths<TRouteTree> | string = TDefaultFrom,
-  TTo extends string = '',
   TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom,
   TMaskTo extends string = '',
 >({
@@ -20,10 +20,7 @@ export type UseNavigateResult<TDefaultFrom extends string> = <
 export function useNavigate<
   TDefaultFrom extends string = string,
 >(_defaultOpts?: {
-  from?:
-    | TDefaultFrom
-    | RoutePaths<RegisteredRouter['routeTree']>
-    | (string & {})
+  from?: RoutePathsAutoComplete<RegisteredRouter['routeTree'], TDefaultFrom>
 }) {
   const { navigate } = useRouter()