@tanstack/solid-router 1.112.11 → 1.112.12

package/src/route.ts

@@ -9,26 +9,33 @@ import { useNavigate } from './useNavigate'
 import { useMatch } from './useMatch'
 import type {
   AnyContext,
-  AnySchema,
+  AnyRoute,
+  AnyRouter,
   Constrain,
   ConstrainLiteral,
-  RootRoute as CoreRootRoute,
+  LazyRoute as CoreLazyRoute,
   Route as CoreRoute,
   ErrorComponentProps,
   NotFoundRouteProps,
+  RegisteredRouter,
+  ResolveFullPath,
   ResolveId,
   ResolveParams,
   RootRouteId,
   RootRouteOptions,
-  RouteById,
-  RouteContext,
+  RouteAddChildrenFn,
+  RouteAddFileChildrenFn,
+  RouteAddFileTypesFn,
+  RouteConstraints,
   RouteIds,
+  RouteLazyFn,
   RouteLoaderFn,
+  RouteMask,
   RouteOptions,
   RoutePathOptionsIntersection,
-  RoutePaths,
-  RoutePrefix,
   RouteTypes,
+  RouteTypesById,
+  Router,
   ToMaskOptions,
   TrimPathRight,
   UpdatableRouteOptions,
@@ -40,9 +47,7 @@ import type { UseLoaderDepsRoute } from './useLoaderDeps'
 import type { UseParamsRoute } from './useParams'
 import type { UseSearchRoute } from './useSearch'
 import type * as Solid from 'solid-js'
-import type { AnyRouter, RegisteredRouter, Router } from './router'
 import type { NotFoundError } from './not-found'
-import type { LazyRoute } from './fileRoute'
 import type { UseRouteContextRoute } from './useRouteContext'
 
 declare module '@tanstack/router-core' {
@@ -52,53 +57,21 @@ declare module '@tanstack/router-core' {
     notFoundComponent?: NotFoundRouteComponent
     pendingComponent?: RouteComponent
   }
-}
-
-export interface AnyRoute
-  extends Route<
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any,
-    any
-  > {}
-
-export type AnyRouteWithContext<TContext> = AnyRoute & {
-  types: { allContext: TContext }
-}
 
-export type RouteConstraints = {
-  TParentRoute: AnyRoute
-  TPath: string
-  TFullPath: string
-  TCustomId: string
-  TId: string
-  TSearchSchema: AnySchema
-  TFullSearchSchema: AnySchema
-  TParams: Record<string, any>
-  TAllParams: Record<string, any>
-  TParentContext: AnyContext
-  TRouteContext: RouteContext
-  TAllContext: AnyContext
-  TRouterContext: AnyContext
-  TChildren: unknown
-  TRouteTree: AnyRoute
+  export interface RouteExtensions<
+    TId extends string,
+    TFullPath extends string,
+  > {
+    useMatch: UseMatchRoute<TId>
+    useRouteContext: UseRouteContextRoute<TId>
+    useSearch: UseSearchRoute<TId>
+    useParams: UseParamsRoute<TId>
+    useLoaderDeps: UseLoaderDepsRoute<TId>
+    useLoaderData: UseLoaderDataRoute<TId>
+    useNavigate: () => UseNavigateResult<TFullPath>
+  }
 }
 
-export type RouteTypesById<TRouter extends AnyRouter, TId> = RouteById<
-  TRouter['routeTree'],
-  TId
->['types']
-
 export function getRouteApi<
   const TId,
   TRouter extends AnyRouter = RegisteredRouter,
@@ -203,7 +176,7 @@ export class Route<
       TFileRouteTypes
     >
 {
-  isRoot: TParentRoute extends Route<any> ? true : false
+  isRoot: TParentRoute extends AnyRoute ? true : false
   options: RouteOptions<
     TParentRoute,
     TId,
@@ -268,7 +241,7 @@ export class Route<
   children?: TChildren
   originalIndex?: number
   rank!: number
-  lazyFn?: () => Promise<LazyRoute<any>>
+  lazyFn?: () => Promise<CoreLazyRoute>
   _lazyPromise?: Promise<void>
   _componentsPromise?: Promise<Array<void>>
 
@@ -387,12 +360,7 @@ export class Route<
     this._ssr = options?.ssr ?? opts.defaultSsr ?? true
   }
 
-  addChildren<const TNewChildren>(
-    children: Constrain<
-      TNewChildren,
-      ReadonlyArray<AnyRoute> | Record<string, AnyRoute>
-    >,
-  ): Route<
+  addChildren: RouteAddChildrenFn<
     TParentRoute,
     TPath,
     TFullPath,
@@ -405,30 +373,12 @@ export class Route<
     TBeforeLoadFn,
     TLoaderDeps,
     TLoaderFn,
-    TNewChildren,
     TFileRouteTypes
-  > {
-    return this._addFileChildren(children) as Route<
-      TParentRoute,
-      TPath,
-      TFullPath,
-      TCustomId,
-      TId,
-      TSearchValidator,
-      TParams,
-      TRouterContext,
-      TRouteContextFn,
-      TBeforeLoadFn,
-      TLoaderDeps,
-      TLoaderFn,
-      TNewChildren,
-      TFileRouteTypes
-    >
+  > = (children) => {
+    return this._addFileChildren(children) as any
   }
 
-  _addFileChildren<const TNewChildren>(
-    children: TNewChildren,
-  ): Route<
+  _addFileChildren: RouteAddFileChildrenFn<
     TParentRoute,
     TPath,
     TFullPath,
@@ -441,9 +391,8 @@ export class Route<
     TBeforeLoadFn,
     TLoaderDeps,
     TLoaderFn,
-    TNewChildren,
     TFileRouteTypes
-  > {
+  > = (children) => {
     if (Array.isArray(children)) {
       this.children = children as TChildren
     }
@@ -452,22 +401,25 @@ export class Route<
       this.children = Object.values(children) as TChildren
     }
 
-    return this as unknown as Route<
-      TParentRoute,
-      TPath,
-      TFullPath,
-      TCustomId,
-      TId,
-      TSearchValidator,
-      TParams,
-      TRouterContext,
-      TRouteContextFn,
-      TBeforeLoadFn,
-      TLoaderDeps,
-      TLoaderFn,
-      TNewChildren,
-      TFileRouteTypes
-    >
+    return this as any
+  }
+
+  _addFileTypes: RouteAddFileTypesFn<
+    TParentRoute,
+    TPath,
+    TFullPath,
+    TCustomId,
+    TId,
+    TSearchValidator,
+    TParams,
+    TRouterContext,
+    TRouteContextFn,
+    TBeforeLoadFn,
+    TLoaderDeps,
+    TLoaderFn,
+    TChildren
+  > = () => {
+    return this as any
   }
 
   updateLoader = <TNewLoaderFn>(options: {
@@ -521,7 +473,7 @@ export class Route<
     return this
   }
 
-  lazy = (lazyFn: () => Promise<LazyRoute<any>>): this => {
+  lazy: RouteLazyFn<this> = (lazyFn) => {
     this.lazyFn = lazyFn
     return this
   }
@@ -603,7 +555,22 @@ export function createRoute<
     TRouteContextFn,
     TBeforeLoadFn
   >,
-) {
+): CoreRoute<
+  TParentRoute,
+  TPath,
+  TFullPath,
+  TCustomId,
+  TId,
+  TSearchValidator,
+  TParams,
+  AnyContext,
+  TRouteContextFn,
+  TBeforeLoadFn,
+  TLoaderDeps,
+  TLoaderFn,
+  TChildren,
+  unknown
+> {
   return new Route<
     TParentRoute,
     TPath,
@@ -657,43 +624,30 @@ export function createRootRouteWithContext<TRouterContext extends {}>() {
 export const rootRouteWithContext = createRootRouteWithContext
 
 export class RootRoute<
-    in out TSearchValidator = undefined,
-    in out TRouterContext = {},
-    in out TRouteContextFn = AnyContext,
-    in out TBeforeLoadFn = AnyContext,
-    in out TLoaderDeps extends Record<string, any> = {},
-    in out TLoaderFn = undefined,
-    in out TChildren = unknown,
-    in out TFileRouteTypes = unknown,
-  >
-  extends Route<
-    any, // TParentRoute
-    '/', // TPath
-    '/', // TFullPath
-    string, // TCustomId
-    RootRouteId, // TId
-    TSearchValidator, // TSearchValidator
-    {}, // TParams
-    TRouterContext,
-    TRouteContextFn,
-    TBeforeLoadFn,
-    TLoaderDeps,
-    TLoaderFn,
-    TChildren, // TChildren
-    TFileRouteTypes
-  >
-  implements
-    CoreRootRoute<
-      TSearchValidator,
-      TRouterContext,
-      TRouteContextFn,
-      TBeforeLoadFn,
-      TLoaderDeps,
-      TLoaderFn,
-      TChildren,
-      TFileRouteTypes
-    >
-{
+  in out TSearchValidator = undefined,
+  in out TRouterContext = {},
+  in out TRouteContextFn = AnyContext,
+  in out TBeforeLoadFn = AnyContext,
+  in out TLoaderDeps extends Record<string, any> = {},
+  in out TLoaderFn = undefined,
+  in out TChildren = unknown,
+  in out TFileRouteTypes = unknown,
+> extends Route<
+  any, // TParentRoute
+  '/', // TPath
+  '/', // TFullPath
+  string, // TCustomId
+  RootRouteId, // TId
+  TSearchValidator, // TSearchValidator
+  {}, // TParams
+  TRouterContext,
+  TRouteContextFn,
+  TBeforeLoadFn,
+  TLoaderDeps,
+  TLoaderFn,
+  TChildren, // TChildren
+  TFileRouteTypes
+> {
   /**
    * @deprecated `RootRoute` is now an internal implementation detail. Use `createRootRoute()` instead.
    */
@@ -709,72 +663,6 @@ export class RootRoute<
   ) {
     super(options as any)
   }
-
-  addChildren<const TNewChildren>(
-    children: Constrain<
-      TNewChildren,
-      ReadonlyArray<AnyRoute> | Record<string, AnyRoute>
-    >,
-  ): RootRoute<
-    TSearchValidator,
-    TRouterContext,
-    TRouteContextFn,
-    TBeforeLoadFn,
-    TLoaderDeps,
-    TLoaderFn,
-    TNewChildren,
-    TFileRouteTypes
-  > {
-    super.addChildren(children)
-    return this as unknown as RootRoute<
-      TSearchValidator,
-      TRouterContext,
-      TRouteContextFn,
-      TBeforeLoadFn,
-      TLoaderDeps,
-      TLoaderFn,
-      TNewChildren,
-      TFileRouteTypes
-    >
-  }
-
-  _addFileChildren<const TNewChildren>(
-    children: TNewChildren,
-  ): RootRoute<
-    TSearchValidator,
-    TRouterContext,
-    TRouteContextFn,
-    TBeforeLoadFn,
-    TLoaderDeps,
-    TLoaderFn,
-    TNewChildren,
-    TFileRouteTypes
-  > {
-    super._addFileChildren(children)
-    return this as unknown as RootRoute<
-      TSearchValidator,
-      TRouterContext,
-      TRouteContextFn,
-      TBeforeLoadFn,
-      TLoaderDeps,
-      TLoaderFn,
-      TNewChildren,
-      TFileRouteTypes
-    >
-  }
-
-  _addFileTypes<TFileRouteTypes>(): RootRoute<
-    TSearchValidator,
-    TRouterContext,
-    TRouteContextFn,
-    TBeforeLoadFn,
-    TLoaderDeps,
-    TLoaderFn,
-    TChildren,
-    TFileRouteTypes
-  > {
-    return this as any
-  }
 }
 
 export function createRootRoute<
@@ -804,23 +692,6 @@ export function createRootRoute<
   >(options)
 }
 
-export type ResolveFullPath<
-  TParentRoute extends AnyRoute,
-  TPath extends string,
-  TPrefixed = RoutePrefix<TParentRoute['fullPath'], TPath>,
-> = TPrefixed extends RootRouteId ? '/' : TPrefixed
-
-export type RouteMask<TRouteTree extends AnyRoute> = {
-  routeTree: TRouteTree
-  from: RoutePaths<TRouteTree>
-  to?: any
-  params?: any
-  search?: any
-  hash?: any
-  state?: any
-  unmaskOnReload?: boolean
-}
-
 export function createRouteMask<
   TRouteTree extends AnyRoute,
   TFrom extends string,
@@ -828,7 +699,7 @@ export function createRouteMask<
 >(
   opts: {
     routeTree: TRouteTree
-  } & ToMaskOptions<Router<TRouteTree, 'never'>, TFrom, TTo>,
+  } & ToMaskOptions<Router<TRouteTree, 'never', false>, TFrom, TTo>,
 ): RouteMask<TRouteTree> {
   return opts as any
 }