@tanstack/router-core 0.0.1-beta.151 → 0.0.1-beta.153

package/src/route.ts

@@ -1,9 +1,8 @@
 import { ParsePathParams } from './link'
-import { AnyRouter, Router, RouteMatch } from './router'
+import { AnyRouter, Router, RouteMatch, RegisteredRouter } from './router'
 import { IsAny, NoInfer, PickRequired, UnionToIntersection } from './utils'
 import invariant from 'tiny-invariant'
 import { joinPaths, trimPath } from './path'
-import { AnyRoutesInfo, DefaultRoutesInfo } from './routeInfo'
 
 export const rootRouteId = '__root__' as const
 export type RootRouteId = typeof rootRouteId
@@ -72,7 +71,7 @@ export type ComponentPropsFromRoute<TRoute> = TRoute extends Route<
   infer TContext,
   infer TRouterContext,
   infer TChildren,
-  infer TRoutesInfo
+  infer TRouteTree
 >
   ? RouteProps<TLoader, TFullSearchSchema, TAllParams, TRouteContext, TContext>
   : never
@@ -93,11 +92,11 @@ export type RouteLoaderFromRoute<TRoute extends AnyRoute> = LoaderFn<
 export type RouteProps<
   TLoader = unknown,
   TFullSearchSchema extends AnySearchSchema = AnySearchSchema,
-  TAllParams = AnyPathParams,
-  TRouteContext = AnyContext,
-  TContext = AnyContext,
+  TAllParams extends AnyPathParams = AnyPathParams,
+  TRouteContext extends AnyContext = AnyContext,
+  TContext extends AnyContext = AnyContext,
 > = {
-  useMatch: () => RouteMatch<AnyRoutesInfo, AnyRoute>
+  useMatch: () => RouteMatch<any, any>
   useLoader: () => UseLoaderResult<TLoader>
   useSearch: <
     TStrict extends boolean = true,
@@ -135,24 +134,12 @@ export type RouteOptions<
   TParentSearchSchema extends AnySearchSchema = {},
   TSearchSchema extends AnySearchSchema = {},
   TFullSearchSchema extends AnySearchSchema = TSearchSchema,
-  TParentParams extends AnyPathParams = AnyPathParams,
-  TParams extends AnyPathParams = Record<ParsePathParams<TPath>, string>,
+  TParams extends AnyPathParams = AnyPathParams,
   TAllParams extends AnyPathParams = TParams,
   TParentContext extends AnyContext = AnyContext,
-  TAllParentContext extends IsAny<
-    TParentRoute['__types']['allParams'],
-    TParentContext,
-    TParentRoute['__types']['allParams'] & TParentContext
-  > = IsAny<
-    TParentRoute['__types']['allParams'],
-    TParentContext,
-    TParentRoute['__types']['allParams'] & TParentContext
-  >,
+  TAllParentContext extends AnyContext = AnyContext,
   TRouteContext extends RouteContext = RouteContext,
-  TContext extends MergeParamsFromParent<
-    TAllParentContext,
-    TRouteContext
-  > = MergeParamsFromParent<TAllParentContext, TRouteContext>,
+  TContext extends AnyContext = AnyContext,
 > = BaseRouteOptions<
   TParentRoute,
   TCustomId,
@@ -161,7 +148,6 @@ export type RouteOptions<
   TParentSearchSchema,
   TSearchSchema,
   TFullSearchSchema,
-  TParentParams,
   TParams,
   TAllParams,
   TParentContext,
@@ -183,6 +169,14 @@ export type ParamsFallback<
   TParams,
 > = unknown extends TParams ? Record<ParsePathParams<TPath>, string> : TParams
 
+type Prefix<T extends string, U extends string> = U extends `${T}${infer _}`
+  ? U
+  : never
+
+type PrefixOrExact<T extends string, U extends string> = U extends T
+  ? U
+  : Prefix<T, U>
+
 export type BaseRouteOptions<
   TParentRoute extends AnyRoute = AnyRoute,
   TCustomId extends string = string,
@@ -191,25 +185,14 @@ export type BaseRouteOptions<
   TParentSearchSchema extends AnySearchSchema = {},
   TSearchSchema extends AnySearchSchema = {},
   TFullSearchSchema extends AnySearchSchema = TSearchSchema,
-  TParentParams extends AnyPathParams = AnyPathParams,
   TParams = unknown,
   TAllParams = ParamsFallback<TPath, TParams>,
   TParentContext extends AnyContext = AnyContext,
-  TAllParentContext extends IsAny<
-    TParentRoute['__types']['allParams'],
-    TParentContext,
-    TParentRoute['__types']['allParams'] & TParentContext
-  > = IsAny<
-    TParentRoute['__types']['allParams'],
-    TParentContext,
-    TParentRoute['__types']['allParams'] & TParentContext
-  >,
+  TAllParentContext extends AnyContext = AnyContext,
   TRouteContext extends RouteContext = RouteContext,
-  TContext extends MergeParamsFromParent<
-    TAllParentContext,
-    TRouteContext
-  > = MergeParamsFromParent<TAllParentContext, TRouteContext>,
+  TContext extends AnyContext = AnyContext,
 > = RoutePathOptions<TCustomId, TPath> & {
+  layoutLimit?: string
   getParentRoute: () => TParentRoute
   validateSearch?: SearchSchemaValidator<TSearchSchema, TParentSearchSchema>
   loader?: LoaderFn<
@@ -515,27 +498,6 @@ export interface AnyRoute
     any
   > {}
 
-export type AnyRouteWithRouterContext<TRouterContext extends AnyContext> =
-  Route<
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    TRouterContext,
-    any,
-    any
-  >
-
 export type MergeParamsFromParent<T, U> = IsAny<T, U, T & U>
 
 export type UseLoaderResult<T> = T extends Record<PropertyKey, infer U>
@@ -555,43 +517,62 @@ export type StreamedPromise<T> = {
   resolve: (value: T) => void
 }
 
+export type RouteConstraints = {
+  TParentRoute: AnyRoute
+  TPath: string
+  TFullPath: string
+  TCustomId: string
+  TId: string
+  TSearchSchema: AnySearchSchema
+  TFullSearchSchema: AnySearchSchema
+  TParams: Record<string, any>
+  TAllParams: Record<string, any>
+  TParentContext: AnyContext
+  TAllParentContext: AnyContext
+  TRouteContext: RouteContext
+  TContext: AnyContext
+  TRouterContext: AnyContext
+  TChildren: unknown
+  TRouteTree: AnyRoute
+}
+
 export class Route<
-  TParentRoute extends AnyRoute = AnyRoute,
-  TPath extends string = '/',
-  TFullPath extends ResolveFullPath<TParentRoute, TPath> = ResolveFullPath<
+  TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute,
+  TPath extends RouteConstraints['TPath'] = '/',
+  TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath<
     TParentRoute,
     TPath
   >,
-  TCustomId extends string = string,
-  TId extends ResolveId<TParentRoute, TCustomId, TPath> = ResolveId<
+  TCustomId extends RouteConstraints['TCustomId'] = string,
+  TId extends RouteConstraints['TId'] = ResolveId<
     TParentRoute,
     TCustomId,
     TPath
   >,
   TLoader = unknown,
-  TSearchSchema extends AnySearchSchema = {},
-  TFullSearchSchema extends AnySearchSchema = ResolveFullSearchSchema<
+  TSearchSchema extends RouteConstraints['TSearchSchema'] = {},
+  TFullSearchSchema extends RouteConstraints['TFullSearchSchema'] = ResolveFullSearchSchema<
     TParentRoute,
     TSearchSchema
   >,
-  TParams extends Record<ParsePathParams<TPath>, any> = Record<
+  TParams extends RouteConstraints['TParams'] = Record<
     ParsePathParams<TPath>,
     string
   >,
-  TAllParams extends MergeParamsFromParent<
+  TAllParams extends RouteConstraints['TAllParams'] = MergeParamsFromParent<
     TParentRoute['__types']['allParams'],
     TParams
-  > = MergeParamsFromParent<TParentRoute['__types']['allParams'], TParams>,
-  TParentContext extends TParentRoute['__types']['routeContext'] = TParentRoute['__types']['routeContext'],
-  TAllParentContext extends TParentRoute['__types']['context'] = TParentRoute['__types']['context'],
-  TRouteContext extends RouteContext = RouteContext,
-  TContext extends MergeParamsFromParent<
+  >,
+  TParentContext extends RouteConstraints['TParentContext'] = TParentRoute['__types']['routeContext'],
+  TAllParentContext extends RouteConstraints['TAllParentContext'] = TParentRoute['__types']['context'],
+  TRouteContext extends RouteConstraints['TRouteContext'] = RouteContext,
+  TContext extends RouteConstraints['TContext'] = MergeParamsFromParent<
     TParentRoute['__types']['context'],
     TRouteContext
-  > = MergeParamsFromParent<TParentRoute['__types']['context'], TRouteContext>,
-  TRouterContext extends AnyContext = AnyContext,
-  TChildren extends unknown = unknown,
-  TRoutesInfo extends DefaultRoutesInfo = DefaultRoutesInfo,
+  >,
+  TRouterContext extends RouteConstraints['TRouterContext'] = AnyContext,
+  TChildren extends RouteConstraints['TChildren'] = unknown,
+  TRouteTree extends RouteConstraints['TRouteTree'] = AnyRoute,
 > {
   __types!: {
     parentRoute: TParentRoute
@@ -610,7 +591,7 @@ export class Route<
     routeContext: TRouteContext
     context: TContext
     children: TChildren
-    routesInfo: TRoutesInfo
+    routeTree: TRouteTree
     routerContext: TRouterContext
   }
   isRoot: TParentRoute extends Route<any> ? true : false
@@ -622,7 +603,6 @@ export class Route<
     InferFullSearchSchema<TParentRoute>,
     TSearchSchema,
     TFullSearchSchema,
-    TParentRoute['__types']['allParams'],
     TParams,
     TAllParams,
     TParentContext,
@@ -650,7 +630,7 @@ export class Route<
   // Optional
   children?: TChildren
   originalIndex?: number
-  router?: Router<TRoutesInfo['routeTree'], TRoutesInfo>
+  router?: AnyRouter
   rank!: number
 
   constructor(
@@ -662,7 +642,6 @@ export class Route<
       InferFullSearchSchema<TParentRoute>,
       TSearchSchema,
       TFullSearchSchema,
-      TParentRoute['__types']['allParams'],
       TParams,
       TAllParams,
       TParentContext,
@@ -694,7 +673,6 @@ export class Route<
       TPath,
       InferFullSearchSchema<TParentRoute>,
       TSearchSchema,
-      TParentRoute['__types']['allParams'],
       TParams
     > &
       RoutePathOptionsIntersection<TCustomId, TPath>
@@ -768,7 +746,7 @@ export class Route<
     TContext,
     TRouterContext,
     TNewChildren,
-    TRoutesInfo
+    TRouteTree
   > => {
     this.children = children as any
     return this as any
@@ -805,7 +783,7 @@ export class RouterContext<TRouterContext extends {}> {
     TContext extends RouteContext = RouteContext,
   >(
     options?: Omit<
-      RouteOptions<AnyRoute, RootRouteId, '', {}, TSearchSchema, {}, {}>,
+      RouteOptions<AnyRoute, RootRouteId, '', {}, TSearchSchema, {}>,
       | 'path'
       | 'id'
       | 'getParentRoute'
@@ -846,7 +824,7 @@ export class RootRoute<
 > {
   constructor(
     options?: Omit<
-      RouteOptions<AnyRoute, RootRouteId, '', TLoader, TSearchSchema, {}, {}>,
+      RouteOptions<AnyRoute, RootRouteId, '', TLoader, TSearchSchema, {}>,
       | 'path'
       | 'id'
       | 'getParentRoute'
@@ -862,10 +840,7 @@ export class RootRoute<
 export type ResolveFullPath<
   TParentRoute extends AnyRoute,
   TPath extends string,
-  TPrefixed extends RoutePrefix<TParentRoute['fullPath'], TPath> = RoutePrefix<
-    TParentRoute['fullPath'],
-    TPath
-  >,
+  TPrefixed = RoutePrefix<TParentRoute['fullPath'], TPath>,
 > = TPrefixed extends RootRouteId ? '/' : TPrefixed
 
 type RoutePrefix<

package/src/routeInfo.ts

@@ -1,152 +1,71 @@
 import { AnyRoute, Route } from './route'
-import { AnyPathParams, AnySearchSchema, RootRouteId } from './route'
-import { IsAny, MergeUnion, Values } from './utils'
+import { MergeUnion } from './utils'
 
-export interface AnyRoutesInfo {
-  routeTree: AnyRoute
-  routeUnion: AnyRoute
-  routesById: Record<string, AnyRoute>
-  routesByFullPath: Record<string, AnyRoute>
-  routeIds: any
-  routePaths: any
-  routeIntersection: AnyRoute
-  fullSearchSchema: Record<string, any>
-  allParams: Record<string, any>
-}
-
-export interface DefaultRoutesInfo {
-  routeTree: AnyRoute
-  routeUnion: AnyRoute
-  routesById: Record<string, Route>
-  routesByFullPath: Record<string, Route>
-  routeIds: string
-  routePaths: string
-  routeIntersection: AnyRoute
-  fullSearchSchema: AnySearchSchema
-  allParams: AnyPathParams
-}
+export type ParseRoute<TRouteTree extends AnyRoute> =
+  | TRouteTree
+  | ParseRouteChildren<TRouteTree>
 
-export interface RoutesInfo<TRouteTree extends AnyRoute = Route>
-  extends RoutesInfoInner<TRouteTree, ParseRoute<TRouteTree>> {}
-
-export interface RoutesInfoInner<
-  TRouteTree extends AnyRoute,
-  TRouteUnion extends AnyRoute = Route,
-  TRoutesById = { '/': TRouteUnion } & {
-    [TRoute in TRouteUnion as TRoute['id']]: TRoute
-  },
-  // RoutePaths should always use index routes if possible, but not
-  // force trailing slashes. To do this, we check if each route
-  // has an index route registered and if it does, we omit the layout
-  // route. Then for any index routes, we remove the trailing slash
-  TRoutesByFullPath = { '/': TRouteUnion } & {
-    [TRoute in TRouteUnion as TRoute['fullPath'] extends RootRouteId
-      ? never
-      : string extends TRoute['fullPath']
-      ? never
-      : `${TRoute['fullPath']}/` extends keyof TRoutesById
-      ? never
-      : TRoute['fullPath'] extends `${infer Trimmed}/`
-      ? Trimmed
-      : TRoute['fullPath']]: TRoute
-  },
-> {
-  routeTree: TRouteTree
-  routeUnion: TRouteUnion
-  routesById: TRoutesById
-  routesByFullPath: TRoutesByFullPath
-  routeIds: keyof TRoutesById
-  routePaths: keyof TRoutesByFullPath
-  routeIntersection: Route<
-    TRouteUnion['__types']['parentRoute'], // TParentRoute,
-    TRouteUnion['__types']['path'], // TPath,
-    TRouteUnion['__types']['fullPath'], // TFullPath,
-    TRouteUnion['__types']['customId'], // TCustomId,
-    TRouteUnion['__types']['id'], // TId,
-    TRouteUnion['__types']['loader'], // TId,
-    MergeUnion<TRouteUnion['__types']['searchSchema']> & {}, // TSearchSchema,
-    MergeUnion<TRouteUnion['__types']['fullSearchSchema']> & {}, // TFullSearchSchema,
-    MergeUnion<TRouteUnion['__types']['params']>, // TParams,
-    MergeUnion<TRouteUnion['__types']['allParams']>, // TAllParams,
-    MergeUnion<TRouteUnion['__types']['parentContext']>, // TParentContext,
-    MergeUnion<TRouteUnion['__types']['allParentContext']>, // TAllParentContext,
-    MergeUnion<TRouteUnion['__types']['routeContext']> & {}, // TRouteContext,
-    MergeUnion<TRouteUnion['__types']['context']> & {}, // TContext,
-    MergeUnion<TRouteUnion['__types']['routerContext']> & {}, // TRouterContext,
-    TRouteUnion['__types']['children'], // TChildren,
-    TRouteUnion['__types']['routesInfo'] // TRoutesInfo,
+export type ParseRouteChildren<TRouteTree extends AnyRoute> =
+  TRouteTree extends Route<
+    any,
+    any,
+    any,
+    any,
+    any,
+    any,
+    any,
+    any,
+    any,
+    any,
+    any,
+    any,
+    any,
+    any,
+    any,
+    infer TChildren,
+    any
   >
-  fullSearchSchema: Partial<
-    MergeUnion<TRouteUnion['__types']['fullSearchSchema']>
-  >
-  allParams: Partial<MergeUnion<TRouteUnion['__types']['allParams']>>
-}
+    ? unknown extends TChildren
+      ? never
+      : TChildren extends AnyRoute[]
+      ? {
+          [TId in TChildren[number]['id'] as string]: ParseRoute<
+            TChildren[number]
+          >
+        }[string]
+      : never
+    : never
 
-export type ParseRoute<TRouteTree> = TRouteTree extends AnyRoute
-  ? TRouteTree | ParseRouteChildren<TRouteTree>
-  : never
+export type RoutesById<TRouteTree extends AnyRoute> = {
+  [K in ParseRoute<TRouteTree>['id'] as K['id']]: K
+}
 
-export type ParseRouteChildren<TRouteTree> = TRouteTree extends Route<
-  any,
-  any,
-  any,
-  any,
-  any,
-  any,
-  any,
-  any,
-  any,
-  any,
-  any,
-  any,
-  any,
-  any,
-  any,
-  infer TChildren,
-  any
+export type RouteById<TRouteTree extends AnyRoute, TId> = Extract<
+  ParseRoute<TRouteTree>,
+  { id: TId }
 >
-  ? unknown extends TChildren
-    ? never
-    : TChildren extends AnyRoute[]
-    ? Values<{
-        [TId in TChildren[number]['id']]: ParseRouteChild<
-          TChildren[number],
-          TId
-        >
-      }>
-    : never
-  : never
 
-export type ParseRouteChild<TRoute, TId> = TRoute extends AnyRoute
-  ? ParseRoute<TRoute>
-  : never
+export type RouteIds<TRouteTree extends AnyRoute> = AnyRoute extends TRouteTree
+  ? string
+  : ParseRoute<TRouteTree>['id']
 
-export type RoutesById<TRoutesInfo extends AnyRoutesInfo> = {
-  [K in keyof TRoutesInfo['routesById']]: TRoutesInfo['routesById'][K]
+export type RoutesByPath<TRouteTree extends AnyRoute> = {
+  [K in ParseRoute<TRouteTree>['fullPath'] as K['fullPath']]: K
 }
 
-export type RouteById<
-  TRoutesInfo extends AnyRoutesInfo,
-  TId,
-> = TId extends keyof TRoutesInfo['routesById']
-  ? IsAny<
-      TRoutesInfo['routesById'][TId]['id'],
-      Route,
-      TRoutesInfo['routesById'][TId]
-    >
-  : never
+export type RouteByPath<TRouteTree extends AnyRoute, TPath> = Extract<
+  ParseRoute<TRouteTree>,
+  { fullPath: TPath }
+>
 
-export type RoutesByPath<TRoutesInfo extends AnyRoutesInfo> = {
-  [K in keyof TRoutesInfo['routesByFullPath']]: TRoutesInfo['routesByFullPath'][K]
-}
+export type RoutePaths<TRouteTree extends AnyRoute> =
+  | ParseRoute<TRouteTree>['fullPath']
+  | '/'
 
-export type RouteByPath<
-  TRoutesInfo extends AnyRoutesInfo,
-  TPath,
-> = TPath extends keyof TRoutesInfo['routesByFullPath']
-  ? IsAny<
-      TRoutesInfo['routesByFullPath'][TPath]['id'],
-      Route,
-      TRoutesInfo['routesByFullPath'][TPath]
-    >
-  : never
+export type FullSearchSchema<TRouteTree extends AnyRoute> = MergeUnion<
+  ParseRoute<TRouteTree>['__types']['fullSearchSchema']
+> & {}
+
+export type AllParams<TRouteTree extends AnyRoute> = MergeUnion<
+  ParseRoute<TRouteTree>['__types']['allParams']
+>