@tanstack/react-router 1.31.29 → 1.32.2

package/src/route.ts

@@ -57,16 +57,16 @@ export type RouteOptions<
   TParentRoute extends AnyRoute = AnyRoute,
   TCustomId extends string = string,
   TPath extends string = string,
-  TSearchSchemaInput extends Record<string, any> = {},
-  TSearchSchema extends Record<string, any> = {},
+  TSearchSchemaInput = {},
+  TSearchSchema = {},
   TSearchSchemaUsed = {},
   TFullSearchSchemaInput = TSearchSchemaUsed,
   TFullSearchSchema = TSearchSchema,
   TParams = AnyPathParams,
   TAllParams = TParams,
-  TRouteContextReturn extends RouteContext = RouteContext,
+  TRouteContextReturn = RouteContext,
   TRouteContext = RouteContext,
-  TRouterContext extends RouteConstraints['TRouterContext'] = AnyContext,
+  TRouterContext = AnyContext,
   TAllContext = AnyContext,
   TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = unknown,
@@ -109,14 +109,14 @@ export type ParamsFallback<
 export type FileBaseRouteOptions<
   TParentRoute extends AnyRoute = AnyRoute,
   TPath extends string = string,
-  TSearchSchemaInput extends Record<string, any> = {},
-  TSearchSchema extends Record<string, any> = {},
+  TSearchSchemaInput = {},
+  TSearchSchema = {},
   TFullSearchSchema = TSearchSchema,
   TParams = {},
   TAllParams = ParamsFallback<TPath, TParams>,
-  TRouteContextReturn extends RouteContext = RouteContext,
+  TRouteContextReturn = RouteContext,
   TRouteContext = RouteContext,
-  TRouterContext extends RouteConstraints['TRouterContext'] = AnyContext,
+  TRouterContext = AnyContext,
   TAllContext = AnyContext,
   TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = unknown,
@@ -173,16 +173,16 @@ export type BaseRouteOptions<
   TParentRoute extends AnyRoute = AnyRoute,
   TCustomId extends string = string,
   TPath extends string = string,
-  TSearchSchemaInput extends Record<string, any> = {},
-  TSearchSchema extends Record<string, any> = {},
+  TSearchSchemaInput = {},
+  TSearchSchema = {},
   TSearchSchemaUsed = {},
   TFullSearchSchemaInput = TSearchSchemaUsed,
   TFullSearchSchema = TSearchSchema,
   TParams = {},
   TAllParams = ParamsFallback<TPath, TParams>,
-  TRouteContextReturn extends RouteContext = RouteContext,
+  TRouteContextReturn = RouteContext,
   TRouteContext = RouteContext,
-  TRouterContext extends RouteConstraints['TRouterContext'] = AnyContext,
+  TRouterContext = AnyContext,
   TAllContext = AnyContext,
   TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = unknown,
@@ -209,8 +209,8 @@ type BeforeLoadFn<
   in out TFullSearchSchema,
   in out TParentRoute extends AnyRoute,
   in out TAllParams,
-  TRouteContextReturn extends RouteContext,
-  in out TRouterContext extends RouteConstraints['TRouterContext'] = AnyContext,
+  TRouteContextReturn,
+  in out TRouterContext = AnyContext,
   in out TContext = IsAny<TParentRoute['types']['allContext'], TRouterContext>,
 > = (opts: {
   search: TFullSearchSchema
@@ -393,25 +393,54 @@ export type InferFullSearchSchemaInput<TRoute> = TRoute extends {
   ? TFullSearchSchemaInput
   : {}
 
+export type ResolveSearchSchemaUsed<TSearchSchemaInput, TSearchSchema> =
+  TSearchSchemaInput extends SearchSchemaInput
+    ? Omit<TSearchSchemaInput, keyof SearchSchemaInput>
+    : TSearchSchema
+
 export type ResolveFullSearchSchema<
   TParentRoute extends AnyRoute,
   TSearchSchema,
-> = Assign<
-  TParentRoute['id'] extends RootRouteId
-    ? Omit<TParentRoute['types']['searchSchema'], keyof RootSearchSchema>
-    : TParentRoute['types']['fullSearchSchema'],
-  TSearchSchema
->
+> = unknown extends TParentRoute
+  ? Omit<TSearchSchema, keyof RootSearchSchema>
+  : Assign<
+      TParentRoute['id'] extends RootRouteId
+        ? Omit<TParentRoute['types']['searchSchema'], keyof RootSearchSchema>
+        : TParentRoute['types']['fullSearchSchema'],
+      TSearchSchema
+    >
 
 export type ResolveFullSearchSchemaInput<
   TParentRoute extends AnyRoute,
   TSearchSchemaUsed,
-> = Assign<
-  TParentRoute['id'] extends RootRouteId
-    ? Omit<TParentRoute['types']['searchSchemaInput'], keyof RootSearchSchema>
-    : TParentRoute['types']['fullSearchSchemaInput'],
-  TSearchSchemaUsed
->
+> = unknown extends TParentRoute
+  ? Omit<TSearchSchemaUsed, keyof RootSearchSchema>
+  : Assign<
+      TParentRoute['id'] extends RootRouteId
+        ? Omit<
+            TParentRoute['types']['searchSchemaInput'],
+            keyof RootSearchSchema
+          >
+        : TParentRoute['types']['fullSearchSchemaInput'],
+      TSearchSchemaUsed
+    >
+
+export type ResolveRouteContext<TRouteContextReturn> = [
+  TRouteContextReturn,
+] extends [never]
+  ? RouteContext
+  : TRouteContextReturn
+
+export type ResolveAllContext<
+  TParentRoute extends AnyRoute,
+  TRouteContext,
+> = Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>
+
+export type ResolveLoaderData<TLoaderDataReturn> = [TLoaderDataReturn] extends [
+  never,
+]
+  ? undefined
+  : TLoaderDataReturn
 
 export interface AnyRoute
   extends Route<
@@ -437,8 +466,12 @@ export interface AnyRoute
     any
   > {}
 
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export type MergeFromFromParent<T, U> = IsAny<T, U, T & U>
+export type ResolveAllParamsFromParent<
+  TParentRoute extends AnyRoute,
+  TParams,
+> = unknown extends TParentRoute
+  ? TParams
+  : Assign<TParentRoute['types']['allParams'], TParams>
 
 export type ResolveAllParams<TParentRoute extends AnyRoute, TParams> =
   Record<never, string> extends TParentRoute['types']['allParams']
@@ -566,11 +599,12 @@ export class Route<
     TCustomId,
     TPath
   >,
-  in out TSearchSchemaInput extends RouteConstraints['TSearchSchema'] = {},
-  in out TSearchSchema extends RouteConstraints['TSearchSchema'] = {},
-  in out TSearchSchemaUsed = TSearchSchemaInput extends SearchSchemaInput
-    ? Omit<TSearchSchemaInput, keyof SearchSchemaInput>
-    : TSearchSchema,
+  in out TSearchSchemaInput = {},
+  in out TSearchSchema = {},
+  in out TSearchSchemaUsed = ResolveSearchSchemaUsed<
+    TSearchSchemaInput,
+    TSearchSchema
+  >,
   in out TFullSearchSchemaInput = ResolveFullSearchSchemaInput<
     TParentRoute,
     TSearchSchemaUsed
@@ -581,21 +615,17 @@ export class Route<
   >,
   in out TParams = Record<ParsePathParams<TPath>, string>,
   in out TAllParams = ResolveAllParams<TParentRoute, TParams>,
-  TRouteContextReturn extends RouteConstraints['TRouteContext'] = RouteContext,
-  in out TRouteContext = [TRouteContextReturn] extends [never]
-    ? RouteContext
-    : TRouteContextReturn,
+  TRouteContextReturn = RouteContext,
+  in out TRouteContext = ResolveRouteContext<TRouteContextReturn>,
   in out TAllContext = Assign<
     IsAny<TParentRoute['types']['allContext'], {}>,
     TRouteContext
   >,
-  in out TRouterContext extends RouteConstraints['TRouterContext'] = AnyContext,
+  in out TRouterContext = AnyContext,
   in out TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = unknown,
-  in out TLoaderData = [TLoaderDataReturn] extends [never]
-    ? undefined
-    : TLoaderDataReturn,
-  in out TChildren extends RouteConstraints['TChildren'] = unknown,
+  in out TLoaderData = ResolveLoaderData<TLoaderDataReturn>,
+  in out TChildren = unknown,
 > {
   isRoot: TParentRoute extends Route<any> ? true : false
   options: RouteOptions<
@@ -764,7 +794,11 @@ export class Route<
     this.to = fullPath as TrimPathRight<TFullPath>
   }
 
-  addChildren = <const TNewChildren extends ReadonlyArray<AnyRoute>>(
+  addChildren = <
+    const TNewChildren extends
+      | Record<string, AnyRoute>
+      | ReadonlyArray<AnyRoute>,
+  >(
     children: TNewChildren,
   ): Route<
     TParentRoute,
@@ -788,7 +822,9 @@ export class Route<
     TLoaderData,
     TNewChildren
   > => {
-    this.children = children as any
+    this.children = (
+      Array.isArray(children) ? children : Object.values(children)
+    ) as any
     return this as any
   }
 
@@ -907,11 +943,12 @@ export function createRoute<
     TCustomId,
     TPath
   >,
-  TSearchSchemaInput extends RouteConstraints['TSearchSchema'] = {},
-  TSearchSchema extends RouteConstraints['TSearchSchema'] = {},
-  TSearchSchemaUsed = TSearchSchemaInput extends SearchSchemaInput
-    ? Omit<TSearchSchemaInput, keyof SearchSchemaInput>
-    : TSearchSchema,
+  TSearchSchemaInput = {},
+  TSearchSchema = {},
+  TSearchSchemaUsed = ResolveSearchSchemaUsed<
+    TSearchSchemaInput,
+    TSearchSchema
+  >,
   TFullSearchSchemaInput = ResolveFullSearchSchemaInput<
     TParentRoute,
     TSearchSchemaUsed
@@ -919,21 +956,17 @@ export function createRoute<
   TFullSearchSchema = ResolveFullSearchSchema<TParentRoute, TSearchSchema>,
   TParams = Record<ParsePathParams<TPath>, string>,
   TAllParams = ResolveAllParams<TParentRoute, TParams>,
-  TRouteContextReturn extends RouteConstraints['TRouteContext'] = RouteContext,
-  TRouteContext = [TRouteContextReturn] extends [never]
-    ? RouteContext
-    : TRouteContextReturn,
+  TRouteContextReturn = RouteContext,
+  TRouteContext = ResolveRouteContext<TRouteContextReturn>,
   TAllContext = Assign<
     IsAny<TParentRoute['types']['allContext'], {}>,
     TRouteContext
   >,
-  TRouterContext extends RouteConstraints['TRouterContext'] = AnyContext,
+  TRouterContext = AnyContext,
   TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = unknown,
-  TLoaderData = [TLoaderDataReturn] extends [never]
-    ? undefined
-    : TLoaderDataReturn,
-  TChildren extends RouteConstraints['TChildren'] = unknown,
+  TLoaderData = ResolveLoaderData<TLoaderDataReturn>,
+  TChildren = unknown,
 >(
   options: RouteOptions<
     TParentRoute,
@@ -982,19 +1015,15 @@ export function createRoute<
 export type AnyRootRoute = RootRoute<any, any, any, any, any, any, any, any>
 
 export type RootRouteOptions<
-  TSearchSchemaInput extends Record<string, any> = RootSearchSchema,
-  TSearchSchema extends Record<string, any> = RootSearchSchema,
-  TSearchSchemaUsed extends Record<string, any> = RootSearchSchema,
-  TRouteContextReturn extends RouteContext = RouteContext,
-  TRouteContext extends RouteContext = [TRouteContextReturn] extends [never]
-    ? RouteContext
-    : TRouteContextReturn,
-  TRouterContext extends {} = {},
+  TSearchSchemaInput = RootSearchSchema,
+  TSearchSchema = RootSearchSchema,
+  TSearchSchemaUsed = RootSearchSchema,
+  TRouteContextReturn = RouteContext,
+  TRouteContext = ResolveRouteContext<TRouteContextReturn>,
+  TRouterContext = {},
   TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = unknown,
-  TLoaderData = [TLoaderDataReturn] extends [never]
-    ? undefined
-    : TLoaderDataReturn,
+  TLoaderData = ResolveLoaderData<TLoaderDataReturn>,
 > = Omit<
   RouteOptions<
     any, // TParentRoute
@@ -1073,21 +1102,15 @@ export type RootSearchSchema = {
 }
 
 export class RootRoute<
-  in out TSearchSchemaInput extends Record<string, any> = RootSearchSchema,
-  in out TSearchSchema extends Record<string, any> = RootSearchSchema,
-  in out TSearchSchemaUsed extends Record<string, any> = RootSearchSchema,
-  TRouteContextReturn extends RouteContext = RouteContext,
-  in out TRouteContext extends RouteContext = [TRouteContextReturn] extends [
-    never,
-  ]
-    ? RouteContext
-    : TRouteContextReturn,
-  in out TRouterContext extends {} = {},
+  in out TSearchSchemaInput = RootSearchSchema,
+  in out TSearchSchema = RootSearchSchema,
+  in out TSearchSchemaUsed = RootSearchSchema,
+  TRouteContextReturn = RouteContext,
+  in out TRouteContext = ResolveRouteContext<TRouteContextReturn>,
+  in out TRouterContext = {},
   TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = unknown,
-  in out TLoaderData = [TLoaderDataReturn] extends [never]
-    ? undefined
-    : TLoaderDataReturn,
+  in out TLoaderData = ResolveLoaderData<TLoaderDataReturn>,
 > extends Route<
   any, // TParentRoute
   '/', // TPath
@@ -1131,19 +1154,15 @@ export class RootRoute<
 }
 
 export function createRootRoute<
-  TSearchSchemaInput extends Record<string, any> = RootSearchSchema,
-  TSearchSchema extends Record<string, any> = RootSearchSchema,
-  TSearchSchemaUsed extends Record<string, any> = RootSearchSchema,
-  TRouteContextReturn extends RouteContext = RouteContext,
-  TRouteContext extends RouteContext = [TRouteContextReturn] extends [never]
-    ? RouteContext
-    : TRouteContextReturn,
-  TRouterContext extends {} = {},
+  TSearchSchemaInput = RootSearchSchema,
+  TSearchSchema = RootSearchSchema,
+  TSearchSchemaUsed = RootSearchSchema,
+  TRouteContextReturn = RouteContext,
+  TRouteContext = ResolveRouteContext<TRouteContextReturn>,
+  TRouterContext = {},
   TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = unknown,
-  TLoaderData = [TLoaderDataReturn] extends [never]
-    ? undefined
-    : TLoaderDataReturn,
+  TLoaderData = ResolveLoaderData<TLoaderDataReturn>,
 >(
   options?: Omit<
     RouteOptions<
@@ -1276,8 +1295,7 @@ export type AsyncRouteComponent<TProps> = SyncRouteComponent<TProps> & {
   preload?: () => Promise<void>
 }
 
-export type RouteComponent<TProps = any> = SyncRouteComponent<TProps> &
-  AsyncRouteComponent<TProps>
+export type RouteComponent<TProps = any> = AsyncRouteComponent<TProps>
 
 export type ErrorRouteComponent = RouteComponent<ErrorComponentProps>
 
@@ -1286,27 +1304,24 @@ export type NotFoundRouteComponent = SyncRouteComponent<NotFoundRouteProps>
 export class NotFoundRoute<
   TParentRoute extends AnyRootRoute,
   TSearchSchemaInput extends Record<string, any> = {},
-  TSearchSchema extends RouteConstraints['TSearchSchema'] = {},
-  TSearchSchemaUsed extends RouteConstraints['TSearchSchema'] = {},
-  TFullSearchSchemaInput extends
-    RouteConstraints['TFullSearchSchema'] = ResolveFullSearchSchemaInput<
+  TSearchSchema = {},
+  TSearchSchemaUsed = {},
+  TFullSearchSchemaInput = ResolveFullSearchSchemaInput<
     TParentRoute,
     TSearchSchemaUsed
   >,
   TFullSearchSchema = ResolveFullSearchSchema<TParentRoute, TSearchSchema>,
-  TRouteContextReturn extends RouteConstraints['TRouteContext'] = AnyContext,
-  TRouteContext extends RouteConstraints['TRouteContext'] = RouteContext,
+  TRouteContextReturn = AnyContext,
+  TRouteContext = RouteContext,
   TAllContext = Assign<
     IsAny<TParentRoute['types']['allContext'], {}>,
     TRouteContext
   >,
-  TRouterContext extends RouteConstraints['TRouterContext'] = AnyContext,
+  TRouterContext = AnyContext,
   TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = unknown,
-  TLoaderData = [TLoaderDataReturn] extends [never]
-    ? undefined
-    : TLoaderDataReturn,
-  TChildren extends RouteConstraints['TChildren'] = unknown,
+  TLoaderData = ResolveLoaderData<TLoaderDataReturn>,
+  TChildren = unknown,
 > extends Route<
   TParentRoute,
   '/404',

package/src/routeInfo.ts

@@ -5,19 +5,28 @@ import type { UnionToIntersection, UnionToTuple } from './utils'
 export type ParseRoute<TRouteTree, TAcc = TRouteTree> = TRouteTree extends {
   types: { children: infer TChildren }
 }
-  ? TChildren extends ReadonlyArray<any>
-    ? ParseRoute<TChildren[number], TAcc | TChildren[number]>
-    : TAcc
+  ? unknown extends TChildren
+    ? TAcc
+    : TChildren extends ReadonlyArray<any>
+      ? ParseRoute<TChildren[number], TAcc | TChildren[number]>
+      : ParseRoute<
+          TChildren[keyof TChildren],
+          TAcc | TChildren[keyof TChildren]
+        >
   : TAcc
 
 export type ParseRouteWithoutBranches<TRouteTree> =
   ParseRoute<TRouteTree> extends infer TRoute extends AnyRoute
     ? TRoute extends any
-      ? TRoute['types']['children'] extends ReadonlyArray<any>
-        ? '/' extends TRoute['types']['children'][number]['path']
-          ? never
-          : TRoute
-        : TRoute
+      ? unknown extends TRoute['types']['children']
+        ? TRoute
+        : TRoute['types']['children'] extends ReadonlyArray<any>
+          ? '/' extends TRoute['types']['children'][number]['path']
+            ? never
+            : TRoute
+          : '/' extends TRoute['types']['children'][keyof TRoute['types']['children']]['path']
+            ? never
+            : TRoute
       : never
     : never
 
@@ -32,19 +41,14 @@ export type RouteById<TRouteTree extends AnyRoute, TId> = Extract<
 
 export type RouteIds<TRouteTree extends AnyRoute> = ParseRoute<TRouteTree>['id']
 
-export type CatchAllPaths<TRouteTree extends AnyRoute> = Record<
-  '.' | '..' | '',
-  ParseRoute<TRouteTree>
->
+export type CatchAllPaths = '.' | '..' | ''
 
 export type RoutesByPath<TRouteTree extends AnyRoute> = {
   [K in ParseRoute<TRouteTree> as K['fullPath']]: K
-} & CatchAllPaths<TRouteTree>
+}
 
 export type RouteByPath<TRouteTree extends AnyRoute, TPath> = Extract<
-  string extends TPath
-    ? ParseRoute<TRouteTree>
-    : RoutesByPath<TRouteTree>[TPath],
+  RoutesByPath<TRouteTree>[TPath],
   AnyRoute
 >
 
@@ -103,18 +107,16 @@ export type RoutesByToPath<TRouter extends AnyRouter> = {
     TRouter,
     TRoute
   >]: TRoute
-} & CatchAllPaths<TRouter['routeTree']>
+}
 
 export type RouteByToPath<TRouter extends AnyRouter, TTo> = Extract<
-  string extends TTo
-    ? ParseRouteWithoutBranches<TRouter['routeTree']>
-    : RoutesByToPath<TRouter>[TTo],
+  RoutesByToPath<TRouter>[TTo],
   AnyRoute
 >
 
-export type RoutePathsAutoComplete<TRouteTree extends AnyRoute, T> =
+export type RoutePathsAutoComplete<TRouter extends AnyRouter, T> =
   | (string extends T ? T & {} : T)
-  | RoutePaths<TRouteTree>
+  | RoutePaths<TRouter['routeTree']>
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 type UnionizeCollisions<T, U> = {

package/src/useLocation.tsx

@@ -0,0 +1,15 @@
+import { useRouterState } from './useRouterState'
+import type { AnyRouter, RegisteredRouter, RouterState } from './router'
+
+export function useLocation<
+  TRouter extends AnyRouter = RegisteredRouter,
+  TLocationState = RouterState<TRouter['routeTree']>['location'],
+  TSelected = TLocationState,
+>(opts?: { select?: (state: TLocationState) => TSelected }): TSelected {
+  return useRouterState({
+    select: (state) =>
+      opts?.select
+        ? opts.select(state.location as TLocationState)
+        : (state.location as TSelected),
+  })
+}

package/src/useNavigate.tsx

@@ -20,7 +20,7 @@ export type UseNavigateResult<TDefaultFrom extends string> = <
 export function useNavigate<
   TDefaultFrom extends string = string,
 >(_defaultOpts?: {
-  from?: RoutePathsAutoComplete<RegisteredRouter['routeTree'], TDefaultFrom>
+  from?: RoutePathsAutoComplete<RegisteredRouter, TDefaultFrom>
 }): UseNavigateResult<TDefaultFrom> {
   const router = useRouter()
 
@@ -32,7 +32,7 @@ export function useNavigate<
       })
     },
     [router],
-  )
+  ) as UseNavigateResult<TDefaultFrom>
 }
 
 // NOTE: I don't know of anyone using this. It's undocumented, so let's wait until someone needs it