@tanstack/router-core 1.108.0 → 1.111.3

package/src/route.ts

@@ -1,11 +1,15 @@
 import type { ParsePathParams } from './link'
 import type { RootRouteId } from './root'
-import type { Assign } from './utils'
+import type { ParseRoute } from './routeInfo'
+import type { RegisteredRouter } from './router'
+import type { Assign, Expand, IntersectAssign } from './utils'
 import type {
   AnySchema,
   AnyStandardSchemaValidator,
   AnyValidatorAdapter,
   AnyValidatorObj,
+  ResolveSearchValidatorInput,
+  ResolveValidatorOutput,
   StandardSchemaValidator,
   ValidatorAdapter,
   ValidatorFn,
@@ -213,6 +217,38 @@ export type DefaultSearchValidator = SearchValidator<
   AnySchema
 >
 
+export type RoutePrefix<
+  TPrefix extends string,
+  TPath extends string,
+> = string extends TPath
+  ? RootRouteId
+  : TPath extends string
+    ? TPrefix extends RootRouteId
+      ? TPath extends '/'
+        ? '/'
+        : `/${TrimPath<TPath>}`
+      : `${TPrefix}/${TPath}` extends '/'
+        ? '/'
+        : `/${TrimPathLeft<`${TrimPathRight<TPrefix>}/${TrimPath<TPath>}`>}`
+    : never
+
+export type TrimPath<T extends string> = '' extends T
+  ? ''
+  : TrimPathRight<TrimPathLeft<T>>
+
+export type TrimPathLeft<T extends string> =
+  T extends `${RootRouteId}/${infer U}`
+    ? TrimPathLeft<U>
+    : T extends `/${infer U}`
+      ? TrimPathLeft<U>
+      : T
+
+export type TrimPathRight<T extends string> = T extends '/'
+  ? '/'
+  : T extends `${infer U}/`
+    ? TrimPathRight<U>
+    : T
+
 export type LooseReturnType<T> = T extends (
   ...args: Array<any>
 ) => infer TReturn
@@ -250,36 +286,222 @@ export type ResolveLoaderData<TLoaderFn> = unknown extends TLoaderFn
     ? undefined
     : LooseAsyncReturnType<TLoaderFn>
 
-export type RoutePrefix<
-  TPrefix extends string,
+export type ResolveFullSearchSchema<
+  TParentRoute extends AnyRoute,
+  TSearchValidator,
+> = unknown extends TParentRoute
+  ? ResolveValidatorOutput<TSearchValidator>
+  : IntersectAssign<
+      InferFullSearchSchema<TParentRoute>,
+      ResolveValidatorOutput<TSearchValidator>
+    >
+
+export type ResolveFullSearchSchemaInput<
+  TParentRoute extends AnyRoute,
+  TSearchValidator,
+> = IntersectAssign<
+  InferFullSearchSchemaInput<TParentRoute>,
+  ResolveSearchValidatorInput<TSearchValidator>
+>
+
+export type ResolveAllParamsFromParent<
+  TParentRoute extends AnyRoute,
+  TParams,
+> = Assign<InferAllParams<TParentRoute>, TParams>
+
+export type RouteContextParameter<
+  TParentRoute extends AnyRoute,
+  TRouterContext,
+> = unknown extends TParentRoute
+  ? TRouterContext
+  : Assign<TRouterContext, InferAllContext<TParentRoute>>
+
+export type BeforeLoadContextParameter<
+  TParentRoute extends AnyRoute,
+  TRouterContext,
+  TRouteContextFn,
+> = Assign<
+  RouteContextParameter<TParentRoute, TRouterContext>,
+  ContextReturnType<TRouteContextFn>
+>
+
+export type ResolveAllContext<
+  TParentRoute extends AnyRoute,
+  TRouterContext,
+  TRouteContextFn,
+  TBeforeLoadFn,
+> = Assign<
+  BeforeLoadContextParameter<TParentRoute, TRouterContext, TRouteContextFn>,
+  ContextAsyncReturnType<TBeforeLoadFn>
+>
+export interface FullSearchSchemaOption<
+  in out TParentRoute extends AnyRoute,
+  in out TSearchValidator,
+> {
+  search: Expand<ResolveFullSearchSchema<TParentRoute, TSearchValidator>>
+}
+
+export interface RemountDepsOptions<
+  in out TRouteId,
+  in out TFullSearchSchema,
+  in out TAllParams,
+  in out TLoaderDeps,
+> {
+  routeId: TRouteId
+  search: TFullSearchSchema
+  params: TAllParams
+  loaderDeps: TLoaderDeps
+}
+
+export type MakeRemountDepsOptionsUnion<
+  TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
+  TRoute extends AnyRoute = ParseRoute<TRouteTree>,
+> = TRoute extends any
+  ? RemountDepsOptions<
+      TRoute['id'],
+      TRoute['types']['fullSearchSchema'],
+      TRoute['types']['allParams'],
+      TRoute['types']['loaderDeps']
+    >
+  : never
+
+export interface RouteTypes<
+  in out TParentRoute extends AnyRoute,
+  in out TPath extends string,
+  in out TFullPath extends string,
+  in out TCustomId extends string,
+  in out TId extends string,
+  in out TSearchValidator,
+  in out TParams,
+  in out TRouterContext,
+  in out TRouteContextFn,
+  in out TBeforeLoadFn,
+  in out TLoaderDeps,
+  in out TLoaderFn,
+  in out TChildren,
+  in out TFileRouteTypes,
+> {
+  parentRoute: TParentRoute
+  path: TPath
+  to: TrimPathRight<TFullPath>
+  fullPath: TFullPath
+  customId: TCustomId
+  id: TId
+  searchSchema: ResolveValidatorOutput<TSearchValidator>
+  searchSchemaInput: ResolveSearchValidatorInput<TSearchValidator>
+  searchValidator: TSearchValidator
+  fullSearchSchema: ResolveFullSearchSchema<TParentRoute, TSearchValidator>
+  fullSearchSchemaInput: ResolveFullSearchSchemaInput<
+    TParentRoute,
+    TSearchValidator
+  >
+  params: TParams
+  allParams: ResolveAllParamsFromParent<TParentRoute, TParams>
+  routerContext: TRouterContext
+  routeContext: ResolveRouteContext<TRouteContextFn, TBeforeLoadFn>
+  routeContextFn: TRouteContextFn
+  beforeLoadFn: TBeforeLoadFn
+  allContext: ResolveAllContext<
+    TParentRoute,
+    TRouterContext,
+    TRouteContextFn,
+    TBeforeLoadFn
+  >
+  children: TChildren
+  loaderData: ResolveLoaderData<TLoaderFn>
+  loaderDeps: TLoaderDeps
+  fileRouteTypes: TFileRouteTypes
+}
+
+export type ResolveFullPath<
+  TParentRoute extends AnyRoute,
   TPath extends string,
-> = string extends TPath
-  ? RootRouteId
-  : TPath extends string
-    ? TPrefix extends RootRouteId
-      ? TPath extends '/'
-        ? '/'
-        : `/${TrimPath<TPath>}`
-      : `${TPrefix}/${TPath}` extends '/'
-        ? '/'
-        : `/${TrimPathLeft<`${TrimPathRight<TPrefix>}/${TrimPath<TPath>}`>}`
-    : never
+  TPrefixed = RoutePrefix<TParentRoute['fullPath'], TPath>,
+> = TPrefixed extends RootRouteId ? '/' : TPrefixed
+
+export interface Route<
+  in out TParentRoute extends AnyRoute,
+  in out TPath extends string,
+  in out TFullPath extends string,
+  in out TCustomId extends string,
+  in out TId extends string,
+  in out TSearchValidator,
+  in out TParams,
+  in out TRouterContext,
+  in out TRouteContextFn,
+  in out TBeforeLoadFn,
+  in out TLoaderDeps,
+  in out TLoaderFn,
+  in out TChildren,
+  in out TFileRouteTypes,
+> {
+  fullPath: TFullPath
+  path: TPath
+  id: TId
+  types: RouteTypes<
+    TParentRoute,
+    TPath,
+    TFullPath,
+    TCustomId,
+    TId,
+    TSearchValidator,
+    TParams,
+    TRouterContext,
+    TRouteContextFn,
+    TBeforeLoadFn,
+    TLoaderDeps,
+    TLoaderFn,
+    TChildren,
+    TFileRouteTypes
+  >
+}
 
-export type TrimPath<T extends string> = '' extends T
-  ? ''
-  : TrimPathRight<TrimPathLeft<T>>
+export type AnyRoute = Route<
+  any,
+  any,
+  any,
+  any,
+  any,
+  any,
+  any,
+  any,
+  any,
+  any,
+  any,
+  any,
+  any,
+  any
+>
 
-export type TrimPathLeft<T extends string> =
-  T extends `${RootRouteId}/${infer U}`
-    ? TrimPathLeft<U>
-    : T extends `/${infer U}`
-      ? TrimPathLeft<U>
-      : T
-export type TrimPathRight<T extends string> = T extends '/'
-  ? '/'
-  : T extends `${infer U}/`
-    ? TrimPathRight<U>
-    : T
+export interface RootRoute<
+  in out TSearchValidator,
+  in out TRouterContext,
+  in out TRouteContextFn,
+  in out TBeforeLoadFn,
+  in out TLoaderDeps extends Record<string, any>,
+  in out TLoaderFn,
+  in out TChildren,
+  in out TFileRouteTypes,
+> extends Route<
+    any, // TParentRoute
+    '/', // TPath
+    '/', // TFullPath
+    string, // TCustomId
+    RootRouteId, // TId
+    TSearchValidator, // TSearchValidator
+    {}, // TParams
+    TRouterContext,
+    TRouteContextFn,
+    TBeforeLoadFn,
+    TLoaderDeps,
+    TLoaderFn,
+    TChildren, // TChildren
+    TFileRouteTypes
+  > {}
+
+export type AnyRouteWithContext<TContext> = AnyRoute & {
+  types: { allContext: TContext }
+}
 
 /**
  * @deprecated Use `ErrorComponentProps` instead.

package/src/routeInfo.ts

@@ -0,0 +1,235 @@
+import type { InferFileRouteTypes } from './fileRoute'
+import type { AddTrailingSlash, RemoveTrailingSlashes } from './link'
+import type { AnyRoute } from './route'
+import type { AnyRouter, TrailingSlashOption } from './router'
+import type { PartialMergeAll } from './utils'
+
+export type ParseRoute<TRouteTree, TAcc = TRouteTree> = TRouteTree extends {
+  types: { children: infer TChildren }
+}
+  ? 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
+      ? 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
+
+export type CodeRoutesById<TRouteTree extends AnyRoute> =
+  ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute
+    ? {
+        [K in TRoutes as K['id']]: K
+      }
+    : never
+
+export type RoutesById<TRouteTree extends AnyRoute> =
+  InferFileRouteTypes<TRouteTree> extends never
+    ? CodeRoutesById<TRouteTree>
+    : InferFileRouteTypes<TRouteTree>['fileRoutesById']
+
+export type RouteById<TRouteTree extends AnyRoute, TId> = Extract<
+  RoutesById<TRouteTree>[TId & keyof RoutesById<TRouteTree>],
+  AnyRoute
+>
+
+export type CodeRouteIds<TRouteTree extends AnyRoute> =
+  ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute
+    ? TRoutes['id']
+    : never
+
+export type RouteIds<TRouteTree extends AnyRoute> =
+  InferFileRouteTypes<TRouteTree> extends never
+    ? CodeRouteIds<TRouteTree>
+    : InferFileRouteTypes<TRouteTree>['id']
+
+export type ParentPath<TRouter extends AnyRouter> =
+  TrailingSlashOptionByRouter<TRouter> extends 'always'
+    ? '../'
+    : TrailingSlashOptionByRouter<TRouter> extends 'never'
+      ? '..'
+      : '../' | '..'
+
+export type CurrentPath<TRouter extends AnyRouter> =
+  TrailingSlashOptionByRouter<TRouter> extends 'always'
+    ? './'
+    : TrailingSlashOptionByRouter<TRouter> extends 'never'
+      ? '.'
+      : './' | '.'
+
+export type ToPath<TRouter extends AnyRouter, TTo extends string> =
+  TrailingSlashOptionByRouter<TRouter> extends 'always'
+    ? AddTrailingSlash<TTo>
+    : TrailingSlashOptionByRouter<TRouter> extends 'never'
+      ? RemoveTrailingSlashes<TTo>
+      : AddTrailingSlash<TTo> | RemoveTrailingSlashes<TTo>
+
+export type CatchAllPaths<TRouter extends AnyRouter> =
+  | CurrentPath<TRouter>
+  | ParentPath<TRouter>
+
+export type CodeRoutesByPath<TRouteTree extends AnyRoute> =
+  ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute
+    ? {
+        [K in TRoutes as K['fullPath']]: K
+      }
+    : never
+
+export type RoutesByPath<TRouteTree extends AnyRoute> =
+  InferFileRouteTypes<TRouteTree> extends never
+    ? CodeRoutesByPath<TRouteTree>
+    : InferFileRouteTypes<TRouteTree>['fileRoutesByFullPath']
+
+export type RouteByPath<TRouteTree extends AnyRoute, TPath> = Extract<
+  RoutesByPath<TRouteTree>[TPath & keyof RoutesByPath<TRouteTree>],
+  AnyRoute
+>
+
+export type CodeRoutePaths<TRouteTree extends AnyRoute> =
+  ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute
+    ? TRoutes['fullPath']
+    : never
+
+export type RoutePaths<TRouteTree extends AnyRoute> = unknown extends TRouteTree
+  ? string
+  :
+      | (InferFileRouteTypes<TRouteTree> extends never
+          ? CodeRoutePaths<TRouteTree>
+          : InferFileRouteTypes<TRouteTree>['fullPaths'])
+      | '/'
+
+export type RouteToPathAlwaysTrailingSlash<TRoute extends AnyRoute> =
+  TRoute['path'] extends '/'
+    ? TRoute['fullPath']
+    : TRoute['fullPath'] extends '/'
+      ? TRoute['fullPath']
+      : `${TRoute['fullPath']}/`
+
+export type RouteToPathNeverTrailingSlash<TRoute extends AnyRoute> =
+  TRoute['path'] extends '/'
+    ? TRoute['fullPath'] extends '/'
+      ? TRoute['fullPath']
+      : RemoveTrailingSlashes<TRoute['fullPath']>
+    : TRoute['fullPath']
+
+export type RouteToPathPreserveTrailingSlash<TRoute extends AnyRoute> =
+  | RouteToPathNeverTrailingSlash<TRoute>
+  | RouteToPathAlwaysTrailingSlash<TRoute>
+
+export type RouteToPathByTrailingSlashOption<TRoute extends AnyRoute> = {
+  always: RouteToPathAlwaysTrailingSlash<TRoute>
+  preserve: RouteToPathPreserveTrailingSlash<TRoute>
+  never: RouteToPathNeverTrailingSlash<TRoute>
+}
+
+export type TrailingSlashOptionByRouter<TRouter extends AnyRouter> =
+  TrailingSlashOption extends TRouter['options']['trailingSlash']
+    ? 'never'
+    : NonNullable<TRouter['options']['trailingSlash']>
+
+export type RouteToByRouter<
+  TRouter extends AnyRouter,
+  TRoute extends AnyRoute,
+> = RouteToPathByTrailingSlashOption<TRoute>[TrailingSlashOptionByRouter<TRouter>]
+
+export type CodeRouteToPath<TRouter extends AnyRouter> =
+  ParseRouteWithoutBranches<TRouter['routeTree']> extends infer TRoute extends
+    AnyRoute
+    ? TRoute extends any
+      ? RouteToByRouter<TRouter, TRoute>
+      : never
+    : never
+
+export type FileRouteToPath<
+  TRouter extends AnyRouter,
+  TTo = InferFileRouteTypes<TRouter['routeTree']>['to'],
+  TTrailingSlashOption = TrailingSlashOptionByRouter<TRouter>,
+> = 'never' extends TTrailingSlashOption
+  ? TTo
+  : 'always' extends TTrailingSlashOption
+    ? AddTrailingSlash<TTo>
+    : TTo | AddTrailingSlash<TTo>
+
+export type RouteToPath<TRouter extends AnyRouter> = unknown extends TRouter
+  ? string
+  : InferFileRouteTypes<TRouter['routeTree']> extends never
+    ? CodeRouteToPath<TRouter>
+    : FileRouteToPath<TRouter>
+
+export type CodeRoutesByToPath<TRouter extends AnyRouter> =
+  ParseRouteWithoutBranches<TRouter['routeTree']> extends infer TRoutes extends
+    AnyRoute
+    ? {
+        [TRoute in TRoutes as RouteToByRouter<TRouter, TRoute>]: TRoute
+      }
+    : never
+
+export type RoutesByToPath<TRouter extends AnyRouter> =
+  InferFileRouteTypes<TRouter['routeTree']> extends never
+    ? CodeRoutesByToPath<TRouter>
+    : InferFileRouteTypes<TRouter['routeTree']>['fileRoutesByTo']
+
+export type CodeRouteByToPath<TRouter extends AnyRouter, TTo> = Extract<
+  RoutesByToPath<TRouter>[TTo & keyof RoutesByToPath<TRouter>],
+  AnyRoute
+>
+
+export type FileRouteByToPath<TRouter extends AnyRouter, TTo> =
+  'never' extends TrailingSlashOptionByRouter<TRouter>
+    ? CodeRouteByToPath<TRouter, TTo>
+    : 'always' extends TrailingSlashOptionByRouter<TRouter>
+      ? TTo extends '/'
+        ? CodeRouteByToPath<TRouter, TTo>
+        : TTo extends `${infer TPath}/`
+          ? CodeRouteByToPath<TRouter, TPath>
+          : never
+      : CodeRouteByToPath<
+          TRouter,
+          TTo extends '/' ? TTo : RemoveTrailingSlashes<TTo>
+        >
+
+export type RouteByToPath<TRouter extends AnyRouter, TTo> =
+  InferFileRouteTypes<TRouter['routeTree']> extends never
+    ? CodeRouteByToPath<TRouter, TTo>
+    : FileRouteByToPath<TRouter, TTo>
+
+export type FullSearchSchema<TRouteTree extends AnyRoute> =
+  ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute
+    ? PartialMergeAll<TRoutes['types']['fullSearchSchema']>
+    : never
+
+export type FullSearchSchemaInput<TRouteTree extends AnyRoute> =
+  ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute
+    ? PartialMergeAll<TRoutes['types']['fullSearchSchemaInput']>
+    : never
+
+export type AllParams<TRouteTree extends AnyRoute> =
+  ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute
+    ? PartialMergeAll<TRoutes['types']['allParams']>
+    : never
+
+export type AllContext<TRouteTree extends AnyRoute> =
+  ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute
+    ? PartialMergeAll<TRoutes['types']['allContext']>
+    : never
+
+export type AllLoaderData<TRouteTree extends AnyRoute> =
+  ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute
+    ? PartialMergeAll<TRoutes['types']['loaderData']>
+    : never

package/src/router.ts

@@ -1,6 +1,38 @@
 import type { ParsedLocation } from './location'
 import type { DeferredPromiseState } from './defer'
 import type { ControlledPromise } from './utils'
+import type { AnyRoute, AnyRouteWithContext } from './route'
+
+export interface Register {
+  // router: Router
+}
+
+export type RegisteredRouter = Register extends {
+  router: infer TRouter extends AnyRouter
+}
+  ? TRouter
+  : AnyRouter
+
+export interface RouterOptions<
+  in out TTrailingSlashOption extends TrailingSlashOption,
+> {
+  trailingSlash?: TTrailingSlashOption
+}
+
+export interface Router<
+  in out TRouteTree extends AnyRoute,
+  in out TTrailingSlashOption extends TrailingSlashOption,
+> {
+  routeTree: TRouteTree
+  options: RouterOptions<TTrailingSlashOption>
+}
+
+export type AnyRouterWithContext<TContext> = Router<
+  AnyRouteWithContext<TContext>,
+  any
+>
+
+export type AnyRouter = Router<any, any>
 
 export interface ViewTransitionOptions {
   types: Array<string>