@tanstack/router-core 1.132.0-alpha.8 → 1.132.0

package/src/route.ts

@@ -378,6 +378,7 @@ export type MakeRemountDepsOptionsUnion<
     : never
 
 export interface RouteTypes<
+  in out TRegister,
   in out TParentRoute extends AnyRoute,
   in out TPath extends string,
   in out TFullPath extends string,
@@ -393,6 +394,8 @@ export interface RouteTypes<
   in out TChildren,
   in out TFileRouteTypes,
   in out TSSR,
+  in out TServerMiddlewares,
+  in out THandlers,
 > {
   parentRoute: TParentRoute
   path: TPath
@@ -457,7 +460,7 @@ export type RouteLazyFn<TRoute extends AnyRoute> = (
 ) => TRoute
 
 export type RouteAddChildrenFn<
-  in out TRegister extends Register,
+  in out TRegister,
   in out TParentRoute extends AnyRoute,
   in out TPath extends string,
   in out TFullPath extends string,
@@ -472,6 +475,8 @@ export type RouteAddChildrenFn<
   in out TLoaderFn,
   in out TFileRouteTypes,
   in out TSSR,
+  in out TServerMiddlewares,
+  in out THandlers,
 > = <const TNewChildren>(
   children: Constrain<
     TNewChildren,
@@ -493,11 +498,13 @@ export type RouteAddChildrenFn<
   TLoaderFn,
   TNewChildren,
   TFileRouteTypes,
-  TSSR
+  TSSR,
+  TServerMiddlewares,
+  THandlers
 >
 
 export type RouteAddFileChildrenFn<
-  in out TRegister extends Register,
+  in out TRegister,
   in out TParentRoute extends AnyRoute,
   in out TPath extends string,
   in out TFullPath extends string,
@@ -512,6 +519,8 @@ export type RouteAddFileChildrenFn<
   in out TLoaderFn,
   in out TFileRouteTypes,
   in out TSSR,
+  in out TServerMiddlewares,
+  in out THandlers,
 > = <const TNewChildren>(
   children: TNewChildren,
 ) => Route<
@@ -530,11 +539,13 @@ export type RouteAddFileChildrenFn<
   TLoaderFn,
   TNewChildren,
   TFileRouteTypes,
-  TSSR
+  TSSR,
+  TServerMiddlewares,
+  THandlers
 >
 
 export type RouteAddFileTypesFn<
-  TRegister extends Register,
+  TRegister,
   TParentRoute extends AnyRoute,
   TPath extends string,
   TFullPath extends string,
@@ -549,6 +560,8 @@ export type RouteAddFileTypesFn<
   TLoaderFn,
   TChildren,
   TSSR,
+  TServerMiddlewares,
+  THandlers,
 > = <TNewFileRouteTypes>() => Route<
   TRegister,
   TParentRoute,
@@ -565,11 +578,13 @@ export type RouteAddFileTypesFn<
   TLoaderFn,
   TChildren,
   TNewFileRouteTypes,
-  TSSR
+  TSSR,
+  TServerMiddlewares,
+  THandlers
 >
 
 export interface Route<
-  in out TRegister extends Register,
+  in out TRegister,
   in out TParentRoute extends AnyRoute,
   in out TPath extends string,
   in out TFullPath extends string,
@@ -585,11 +600,14 @@ export interface Route<
   in out TChildren,
   in out TFileRouteTypes,
   in out TSSR,
+  in out TServerMiddlewares,
+  in out THandlers,
 > extends RouteExtensions<TId, TFullPath> {
   path: TPath
   parentRoute: TParentRoute
   children?: TChildren
   types: RouteTypes<
+    TRegister,
     TParentRoute,
     TPath,
     TFullPath,
@@ -604,7 +622,9 @@ export interface Route<
     TLoaderFn,
     TChildren,
     TFileRouteTypes,
-    TSSR
+    TSSR,
+    TServerMiddlewares,
+    THandlers
   >
   options: RouteOptions<
     TRegister,
@@ -620,7 +640,9 @@ export interface Route<
     TRouterContext,
     TRouteContextFn,
     TBeforeLoadFn,
-    TSSR
+    TSSR,
+    TServerMiddlewares,
+    THandlers
   >
   isRoot: TParentRoute extends AnyRoute ? true : false
   /** @internal */
@@ -645,7 +667,9 @@ export interface Route<
         TLoaderFn,
         TChildren,
         TFileRouteTypes,
-        TSSR
+        TSSR,
+        TServerMiddlewares,
+        THandlers
       >
     >
   >
@@ -687,7 +711,9 @@ export interface Route<
       TLoaderFn,
       TChildren,
       TFileRouteTypes,
-      TSSR
+      TSSR,
+      TServerMiddlewares,
+      THandlers
     >
   >
   addChildren: RouteAddChildrenFn<
@@ -705,7 +731,9 @@ export interface Route<
     TLoaderDeps,
     TLoaderFn,
     TFileRouteTypes,
-    TSSR
+    TSSR,
+    TServerMiddlewares,
+    THandlers
   >
   _addFileChildren: RouteAddFileChildrenFn<
     TRegister,
@@ -722,7 +750,9 @@ export interface Route<
     TLoaderDeps,
     TLoaderFn,
     TFileRouteTypes,
-    TSSR
+    TSSR,
+    TServerMiddlewares,
+    THandlers
   >
   _addFileTypes: RouteAddFileTypesFn<
     TRegister,
@@ -739,7 +769,9 @@ export interface Route<
     TLoaderDeps,
     TLoaderFn,
     TChildren,
-    TSSR
+    TSSR,
+    TServerMiddlewares,
+    THandlers
   >
 }
 
@@ -759,6 +791,8 @@ export type AnyRoute = Route<
   any,
   any,
   any,
+  any,
+  any,
   any
 >
 
@@ -767,7 +801,7 @@ export type AnyRouteWithContext<TContext> = AnyRoute & {
 }
 
 export type RouteOptions<
-  TRegister extends Register,
+  TRegister,
   TParentRoute extends AnyRoute = AnyRoute,
   TId extends string = string,
   TCustomId extends string = string,
@@ -781,6 +815,8 @@ export type RouteOptions<
   TRouteContextFn = AnyContext,
   TBeforeLoadFn = AnyContext,
   TSSR = unknown,
+  TServerMiddlewares = unknown,
+  THandlers = undefined,
 > = BaseRouteOptions<
   TRegister,
   TParentRoute,
@@ -794,7 +830,9 @@ export type RouteOptions<
   TRouterContext,
   TRouteContextFn,
   TBeforeLoadFn,
-  TSSR
+  TSSR,
+  TServerMiddlewares,
+  THandlers
 > &
   UpdatableRouteOptions<
     NoInfer<TParentRoute>,
@@ -823,24 +861,43 @@ export type RouteContextFn<
   >,
 ) => any
 
-export type BeforeLoadFn<
-  in out TParentRoute extends AnyRoute,
-  in out TSearchValidator,
-  in out TParams,
-  in out TRouterContext,
-  in out TRouteContextFn,
-> = (
-  ctx: BeforeLoadContextOptions<
+export type FileBaseRouteOptions<
+  TRegister,
+  TParentRoute extends AnyRoute = AnyRoute,
+  TId extends string = string,
+  TPath extends string = string,
+  TSearchValidator = undefined,
+  TParams = {},
+  TLoaderDeps extends Record<string, any> = {},
+  TLoaderFn = undefined,
+  TRouterContext = {},
+  TRouteContextFn = AnyContext,
+  TBeforeLoadFn = AnyContext,
+  TRemountDepsFn = AnyContext,
+  TSSR = unknown,
+  TServerMiddlewares = unknown,
+  THandlers = undefined,
+> = ParamsOptions<TPath, TParams> &
+  FilebaseRouteOptionsInterface<
+    TRegister,
     TParentRoute,
+    TId,
+    TPath,
     TSearchValidator,
     TParams,
+    TLoaderDeps,
+    TLoaderFn,
     TRouterContext,
-    TRouteContextFn
-  >,
-) => any
+    TRouteContextFn,
+    TBeforeLoadFn,
+    TRemountDepsFn,
+    TSSR,
+    TServerMiddlewares,
+    THandlers
+  >
 
-export type FileBaseRouteOptions<
-  TRegister extends Register,
+export interface FilebaseRouteOptionsInterface<
+  TRegister,
   TParentRoute extends AnyRoute = AnyRoute,
   TId extends string = string,
   TPath extends string = string,
@@ -853,20 +910,25 @@ export type FileBaseRouteOptions<
   TBeforeLoadFn = AnyContext,
   TRemountDepsFn = AnyContext,
   TSSR = unknown,
-> = ParamsOptions<TPath, TParams> & {
+  TServerMiddlewares = unknown,
+  THandlers = undefined,
+> {
   validateSearch?: Constrain<TSearchValidator, AnyValidator, DefaultValidator>
 
   shouldReload?:
     | boolean
     | ((
         match: LoaderFnContext<
+          TRegister,
           TParentRoute,
           TId,
           TParams,
           TLoaderDeps,
           TRouterContext,
           TRouteContextFn,
-          TBeforeLoadFn
+          TBeforeLoadFn,
+          TServerMiddlewares,
+          THandlers
         >,
       ) => any)
 
@@ -899,11 +961,14 @@ export type FileBaseRouteOptions<
     TBeforeLoadFn,
     (
       ctx: BeforeLoadContextOptions<
+        TRegister,
         TParentRoute,
         TSearchValidator,
         TParams,
         TRouterContext,
-        TRouteContextFn
+        TRouteContextFn,
+        TServerMiddlewares,
+        THandlers
       >,
     ) => ValidateSerializableLifecycleResult<
       TRegister,
@@ -933,13 +998,16 @@ export type FileBaseRouteOptions<
     TLoaderFn,
     (
       ctx: LoaderFnContext<
+        TRegister,
         TParentRoute,
         TId,
         TParams,
         TLoaderDeps,
         TRouterContext,
         TRouteContextFn,
-        TBeforeLoadFn
+        TBeforeLoadFn,
+        TServerMiddlewares,
+        THandlers
       >,
     ) => ValidateSerializableLifecycleResult<
       TRegister,
@@ -951,7 +1019,7 @@ export type FileBaseRouteOptions<
 }
 
 export type BaseRouteOptions<
-  TRegister extends Register,
+  TRegister,
   TParentRoute extends AnyRoute = AnyRoute,
   TId extends string = string,
   TCustomId extends string = string,
@@ -964,6 +1032,8 @@ export type BaseRouteOptions<
   TRouteContextFn = AnyContext,
   TBeforeLoadFn = AnyContext,
   TSSR = unknown,
+  TServerMiddlewares = unknown,
+  THandlers = undefined,
 > = RoutePathOptions<TCustomId, TPath> &
   FileBaseRouteOptions<
     TRegister,
@@ -978,7 +1048,9 @@ export type BaseRouteOptions<
     TRouteContextFn,
     TBeforeLoadFn,
     AnyContext,
-    TSSR
+    TSSR,
+    TServerMiddlewares,
+    THandlers
   > & {
     getParentRoute: () => TParentRoute
   }
@@ -1032,11 +1104,14 @@ export interface SsrContextOptions<
 }
 
 export interface BeforeLoadContextOptions<
+  in out TRegister,
   in out TParentRoute extends AnyRoute,
   in out TSearchValidator,
   in out TParams,
   in out TRouterContext,
   in out TRouteContextFn,
+  in out TServerMiddlewares,
+  in out THandlers,
 > extends ContextOptions<TParentRoute, TParams>,
     FullSearchSchemaOption<TParentRoute, TSearchValidator> {
   context: Expand<
@@ -1256,6 +1331,7 @@ export interface UpdatableRouteOptions<
 }
 
 export type RouteLoaderFn<
+  in out TRegister,
   in out TParentRoute extends AnyRoute = AnyRoute,
   in out TId extends string = string,
   in out TParams = {},
@@ -1263,19 +1339,25 @@ export type RouteLoaderFn<
   in out TRouterContext = {},
   in out TRouteContextFn = AnyContext,
   in out TBeforeLoadFn = AnyContext,
+  in out TServerMiddlewares = unknown,
+  in out THandlers = undefined,
 > = (
   match: LoaderFnContext<
+    TRegister,
     TParentRoute,
     TId,
     TParams,
     TLoaderDeps,
     TRouterContext,
     TRouteContextFn,
-    TBeforeLoadFn
+    TBeforeLoadFn,
+    TServerMiddlewares,
+    THandlers
   >,
 ) => any
 
 export interface LoaderFnContext<
+  in out TRegister = unknown,
   in out TParentRoute extends AnyRoute = AnyRoute,
   in out TId extends string = string,
   in out TParams = {},
@@ -1283,6 +1365,8 @@ export interface LoaderFnContext<
   in out TRouterContext = {},
   in out TRouteContextFn = AnyContext,
   in out TBeforeLoadFn = AnyContext,
+  in out TServerMiddlewares = unknown,
+  in out THandlers = undefined,
 > {
   abortController: AbortController
   preload: boolean
@@ -1316,8 +1400,8 @@ export interface DefaultRootRouteOptionsExtensions {
 export interface RootRouteOptionsExtensions
   extends DefaultRootRouteOptionsExtensions {}
 
-export type RootRouteOptions<
-  TRegister extends Register = Register,
+export interface RootRouteOptions<
+  TRegister = unknown,
   TSearchValidator = undefined,
   TRouterContext = {},
   TRouteContextFn = AnyContext,
@@ -1325,32 +1409,36 @@ export type RootRouteOptions<
   TLoaderDeps extends Record<string, any> = {},
   TLoaderFn = undefined,
   TSSR = unknown,
-> = Omit<
-  RouteOptions<
-    TRegister,
-    any, // TParentRoute
-    RootRouteId, // TId
-    RootRouteId, // TCustomId
-    '', // TFullPath
-    '', // TPath
-    TSearchValidator,
-    {}, // TParams
-    TLoaderDeps,
-    TLoaderFn,
-    TRouterContext,
-    TRouteContextFn,
-    TBeforeLoadFn,
-    TSSR
-  >,
-  | 'path'
-  | 'id'
-  | 'getParentRoute'
-  | 'caseSensitive'
-  | 'parseParams'
-  | 'stringifyParams'
-  | 'params'
-> &
-  RootRouteOptionsExtensions
+  TServerMiddlewares = unknown,
+  THandlers = undefined,
+> extends Omit<
+      RouteOptions<
+        TRegister,
+        any, // TParentRoute
+        RootRouteId, // TId
+        RootRouteId, // TCustomId
+        '', // TFullPath
+        '', // TPath
+        TSearchValidator,
+        {}, // TParams
+        TLoaderDeps,
+        TLoaderFn,
+        TRouterContext,
+        TRouteContextFn,
+        TBeforeLoadFn,
+        TSSR,
+        TServerMiddlewares,
+        THandlers
+      >,
+      | 'path'
+      | 'id'
+      | 'getParentRoute'
+      | 'caseSensitive'
+      | 'parseParams'
+      | 'stringifyParams'
+      | 'params'
+    >,
+    RootRouteOptionsExtensions {}
 
 export type RouteConstraints = {
   TParentRoute: AnyRoute
@@ -1406,7 +1494,7 @@ export type NotFoundRouteProps = {
 }
 
 export class BaseRoute<
-  in out TRegister extends Register,
+  in out TRegister = Register,
   in out TParentRoute extends AnyRoute = AnyRoute,
   in out TPath extends string = '/',
   in out TFullPath extends string = ResolveFullPath<TParentRoute, TPath>,
@@ -1422,6 +1510,8 @@ export class BaseRoute<
   in out TChildren = unknown,
   in out TFileRouteTypes = unknown,
   in out TSSR = unknown,
+  in out TServerMiddlewares = unknown,
+  in out THandlers = undefined,
 > {
   isRoot: TParentRoute extends AnyRoute ? true : false
   options: RouteOptions<
@@ -1438,7 +1528,9 @@ export class BaseRoute<
     TRouterContext,
     TRouteContextFn,
     TBeforeLoadFn,
-    TSSR
+    TSSR,
+    TServerMiddlewares,
+    THandlers
   >
 
   // The following properties are set up in this.init()
@@ -1486,7 +1578,9 @@ export class BaseRoute<
         TLoaderFn,
         TChildren,
         TFileRouteTypes,
-        TSSR
+        TSSR,
+        TServerMiddlewares,
+        THandlers
       >
     >
   >
@@ -1510,7 +1604,9 @@ export class BaseRoute<
       TRouterContext,
       TRouteContextFn,
       TBeforeLoadFn,
-      TSSR
+      TSSR,
+      TServerMiddlewares,
+      THandlers
     >,
   ) {
     this.options = (options as any) || {}
@@ -1522,6 +1618,7 @@ export class BaseRoute<
   }
 
   types!: RouteTypes<
+    TRegister,
     TParentRoute,
     TPath,
     TFullPath,
@@ -1536,7 +1633,9 @@ export class BaseRoute<
     TLoaderFn,
     TChildren,
     TFileRouteTypes,
-    TSSR
+    TSSR,
+    TServerMiddlewares,
+    THandlers
   >
 
   init = (opts: { originalIndex: number }): void => {
@@ -1557,7 +1656,8 @@ export class BaseRoute<
           TRouterContext,
           TRouteContextFn,
           TBeforeLoadFn,
-          TSSR
+          TSSR,
+          TServerMiddlewares
         > &
           RoutePathOptionsIntersection<TCustomId, TPath>)
       | undefined
@@ -1633,7 +1733,9 @@ export class BaseRoute<
     TLoaderDeps,
     TLoaderFn,
     TFileRouteTypes,
-    TSSR
+    TSSR,
+    TServerMiddlewares,
+    THandlers
   > = (children) => {
     return this._addFileChildren(children) as any
   }
@@ -1653,7 +1755,9 @@ export class BaseRoute<
     TLoaderDeps,
     TLoaderFn,
     TFileRouteTypes,
-    TSSR
+    TSSR,
+    TServerMiddlewares,
+    THandlers
   > = (children) => {
     if (Array.isArray(children)) {
       this.children = children as TChildren
@@ -1681,7 +1785,9 @@ export class BaseRoute<
     TLoaderDeps,
     TLoaderFn,
     TChildren,
-    TSSR
+    TSSR,
+    TServerMiddlewares,
+    THandlers
   > = () => {
     return this as any
   }
@@ -1690,6 +1796,7 @@ export class BaseRoute<
     loader: Constrain<
       TNewLoaderFn,
       RouteLoaderFn<
+        TRegister,
         TParentRoute,
         TCustomId,
         TParams,
@@ -1717,7 +1824,9 @@ export class BaseRoute<
       TNewLoaderFn,
       TChildren,
       TFileRouteTypes,
-      TSSR
+      TSSR,
+      TServerMiddlewares,
+      THandlers
     >
   }
 
@@ -1756,7 +1865,9 @@ export class BaseRoute<
       TLoaderFn,
       TChildren,
       TFileRouteTypes,
-      TSSR
+      TSSR,
+      TServerMiddlewares,
+      THandlers
     >
   > = (lazyFn) => {
     this.lazyFn = lazyFn
@@ -1777,7 +1888,7 @@ export class BaseRouteApi<TId, TRouter extends AnyRouter = RegisteredRouter> {
 }
 
 export interface RootRoute<
-  in out TRegister extends Register,
+  in out TRegister,
   in out TSearchValidator = undefined,
   in out TRouterContext = {},
   in out TRouteContextFn = AnyContext,
@@ -1787,6 +1898,8 @@ export interface RootRoute<
   in out TChildren = unknown,
   in out TFileRouteTypes = unknown,
   in out TSSR = unknown,
+  in out TServerMiddlewares = unknown,
+  in out THandlers = undefined,
 > extends Route<
     TRegister,
     any, // TParentRoute
@@ -1803,11 +1916,13 @@ export interface RootRoute<
     TLoaderFn,
     TChildren, // TChildren
     TFileRouteTypes,
-    TSSR
+    TSSR,
+    TServerMiddlewares,
+    THandlers
   > {}
 
 export class BaseRootRoute<
-  in out TRegister extends Register,
+  in out TRegister = Register,
   in out TSearchValidator = undefined,
   in out TRouterContext = {},
   in out TRouteContextFn = AnyContext,
@@ -1817,6 +1932,8 @@ export class BaseRootRoute<
   in out TChildren = unknown,
   in out TFileRouteTypes = unknown,
   in out TSSR = unknown,
+  in out TServerMiddlewares = unknown,
+  in out THandlers = undefined,
 > extends BaseRoute<
   TRegister,
   any, // TParentRoute
@@ -1833,7 +1950,9 @@ export class BaseRootRoute<
   TLoaderFn,
   TChildren, // TChildren
   TFileRouteTypes,
-  TSSR
+  TSSR,
+  TServerMiddlewares,
+  THandlers
 > {
   constructor(
     options?: RootRouteOptions<
@@ -1844,7 +1963,9 @@ export class BaseRootRoute<
       TBeforeLoadFn,
       TLoaderDeps,
       TLoaderFn,
-      TSSR
+      TSSR,
+      TServerMiddlewares,
+      THandlers
     >,
   ) {
     super(options as any)
@@ -1852,3 +1973,16 @@ export class BaseRootRoute<
 }
 
 //
+
+export interface RouteLike {
+  id: string
+  isRoot?: boolean
+  path?: string
+  fullPath: string
+  rank?: number
+  parentRoute?: RouteLike
+  children?: Array<RouteLike>
+  options?: {
+    caseSensitive?: boolean
+  }
+}