@tanstack/router-core 1.132.0-alpha.0 → 1.132.0-alpha.12

package/src/route.ts

@@ -15,7 +15,7 @@ import type {
 } from './Matches'
 import type { RootRouteId } from './root'
 import type { ParseRoute, RouteById, RoutePaths } from './routeInfo'
-import type { AnyRouter, RegisteredRouter } from './router'
+import type { AnyRouter, Register, RegisteredRouter, SSROption } from './router'
 import type { BuildLocationFn, NavigateFn } from './RouterProvider'
 import type {
   Assign,
@@ -41,6 +41,7 @@ import type {
   ValidatorFn,
   ValidatorObj,
 } from './validators'
+import type { ValidateSerializableLifecycleResult } from './ssr/serializer/transformer'
 
 export type AnyPathParams = {}
 
@@ -391,6 +392,7 @@ export interface RouteTypes<
   in out TLoaderFn,
   in out TChildren,
   in out TFileRouteTypes,
+  in out TSSR,
 > {
   parentRoute: TParentRoute
   path: TPath
@@ -422,8 +424,23 @@ export interface RouteTypes<
   loaderData: ResolveLoaderData<TLoaderFn>
   loaderDeps: TLoaderDeps
   fileRouteTypes: TFileRouteTypes
+  ssr: ResolveSSR<TSSR>
+  allSsr: ResolveAllSSR<TParentRoute, TSSR>
 }
 
+export type ResolveSSR<TSSR> = TSSR extends (...args: ReadonlyArray<any>) => any
+  ? LooseReturnType<TSSR>
+  : TSSR
+
+export type ResolveAllSSR<
+  TParentRoute extends AnyRoute,
+  TSSR,
+> = unknown extends TParentRoute
+  ? ResolveSSR<TSSR>
+  : unknown extends TSSR
+    ? TParentRoute['types']['ssr']
+    : ResolveSSR<TSSR>
+
 export type ResolveFullPath<
   TParentRoute extends AnyRoute,
   TPath extends string,
@@ -440,6 +457,7 @@ export type RouteLazyFn<TRoute extends AnyRoute> = (
 ) => TRoute
 
 export type RouteAddChildrenFn<
+  in out TRegister extends Register,
   in out TParentRoute extends AnyRoute,
   in out TPath extends string,
   in out TFullPath extends string,
@@ -453,12 +471,14 @@ export type RouteAddChildrenFn<
   in out TLoaderDeps extends Record<string, any>,
   in out TLoaderFn,
   in out TFileRouteTypes,
+  in out TSSR,
 > = <const TNewChildren>(
   children: Constrain<
     TNewChildren,
     ReadonlyArray<AnyRoute> | Record<string, AnyRoute>
   >,
 ) => Route<
+  TRegister,
   TParentRoute,
   TPath,
   TFullPath,
@@ -472,10 +492,12 @@ export type RouteAddChildrenFn<
   TLoaderDeps,
   TLoaderFn,
   TNewChildren,
-  TFileRouteTypes
+  TFileRouteTypes,
+  TSSR
 >
 
 export type RouteAddFileChildrenFn<
+  in out TRegister extends Register,
   in out TParentRoute extends AnyRoute,
   in out TPath extends string,
   in out TFullPath extends string,
@@ -489,9 +511,11 @@ export type RouteAddFileChildrenFn<
   in out TLoaderDeps extends Record<string, any>,
   in out TLoaderFn,
   in out TFileRouteTypes,
+  in out TSSR,
 > = <const TNewChildren>(
   children: TNewChildren,
 ) => Route<
+  TRegister,
   TParentRoute,
   TPath,
   TFullPath,
@@ -505,10 +529,12 @@ export type RouteAddFileChildrenFn<
   TLoaderDeps,
   TLoaderFn,
   TNewChildren,
-  TFileRouteTypes
+  TFileRouteTypes,
+  TSSR
 >
 
 export type RouteAddFileTypesFn<
+  TRegister extends Register,
   TParentRoute extends AnyRoute,
   TPath extends string,
   TFullPath extends string,
@@ -522,7 +548,9 @@ export type RouteAddFileTypesFn<
   TLoaderDeps extends Record<string, any>,
   TLoaderFn,
   TChildren,
+  TSSR,
 > = <TNewFileRouteTypes>() => Route<
+  TRegister,
   TParentRoute,
   TPath,
   TFullPath,
@@ -536,10 +564,12 @@ export type RouteAddFileTypesFn<
   TLoaderDeps,
   TLoaderFn,
   TChildren,
-  TNewFileRouteTypes
+  TNewFileRouteTypes,
+  TSSR
 >
 
 export interface Route<
+  in out TRegister extends Register,
   in out TParentRoute extends AnyRoute,
   in out TPath extends string,
   in out TFullPath extends string,
@@ -554,6 +584,7 @@ export interface Route<
   in out TLoaderFn,
   in out TChildren,
   in out TFileRouteTypes,
+  in out TSSR,
 > extends RouteExtensions<TId, TFullPath> {
   path: TPath
   parentRoute: TParentRoute
@@ -572,9 +603,11 @@ export interface Route<
     TLoaderDeps,
     TLoaderFn,
     TChildren,
-    TFileRouteTypes
+    TFileRouteTypes,
+    TSSR
   >
   options: RouteOptions<
+    TRegister,
     TParentRoute,
     TId,
     TCustomId,
@@ -586,13 +619,18 @@ export interface Route<
     TLoaderFn,
     TRouterContext,
     TRouteContextFn,
-    TBeforeLoadFn
+    TBeforeLoadFn,
+    TSSR
   >
   isRoot: TParentRoute extends AnyRoute ? true : false
-  _componentsPromise?: Promise<Array<void>>
+  /** @internal */
+  _componentsPromise?: Promise<void>
+  /** @internal */
+  _componentsLoaded?: boolean
   lazyFn?: () => Promise<
     LazyRoute<
       Route<
+        TRegister,
         TParentRoute,
         TPath,
         TFullPath,
@@ -606,11 +644,15 @@ export interface Route<
         TLoaderDeps,
         TLoaderFn,
         TChildren,
-        TFileRouteTypes
+        TFileRouteTypes,
+        TSSR
       >
     >
   >
+  /** @internal */
   _lazyPromise?: Promise<void>
+  /** @internal */
+  _lazyLoaded?: boolean
   rank: number
   to: TrimPathRight<TFullPath>
   init: (opts: { originalIndex: number }) => void
@@ -630,6 +672,7 @@ export interface Route<
   ) => this
   lazy: RouteLazyFn<
     Route<
+      TRegister,
       TParentRoute,
       TPath,
       TFullPath,
@@ -643,10 +686,12 @@ export interface Route<
       TLoaderDeps,
       TLoaderFn,
       TChildren,
-      TFileRouteTypes
+      TFileRouteTypes,
+      TSSR
     >
   >
   addChildren: RouteAddChildrenFn<
+    TRegister,
     TParentRoute,
     TPath,
     TFullPath,
@@ -659,9 +704,11 @@ export interface Route<
     TBeforeLoadFn,
     TLoaderDeps,
     TLoaderFn,
-    TFileRouteTypes
+    TFileRouteTypes,
+    TSSR
   >
   _addFileChildren: RouteAddFileChildrenFn<
+    TRegister,
     TParentRoute,
     TPath,
     TFullPath,
@@ -674,9 +721,11 @@ export interface Route<
     TBeforeLoadFn,
     TLoaderDeps,
     TLoaderFn,
-    TFileRouteTypes
+    TFileRouteTypes,
+    TSSR
   >
   _addFileTypes: RouteAddFileTypesFn<
+    TRegister,
     TParentRoute,
     TPath,
     TFullPath,
@@ -689,7 +738,8 @@ export interface Route<
     TBeforeLoadFn,
     TLoaderDeps,
     TLoaderFn,
-    TChildren
+    TChildren,
+    TSSR
   >
 }
 
@@ -707,6 +757,8 @@ export type AnyRoute = Route<
   any,
   any,
   any,
+  any,
+  any,
   any
 >
 
@@ -715,6 +767,7 @@ export type AnyRouteWithContext<TContext> = AnyRoute & {
 }
 
 export type RouteOptions<
+  TRegister extends Register,
   TParentRoute extends AnyRoute = AnyRoute,
   TId extends string = string,
   TCustomId extends string = string,
@@ -727,7 +780,9 @@ export type RouteOptions<
   TRouterContext = {},
   TRouteContextFn = AnyContext,
   TBeforeLoadFn = AnyContext,
+  TSSR = unknown,
 > = BaseRouteOptions<
+  TRegister,
   TParentRoute,
   TId,
   TCustomId,
@@ -738,7 +793,8 @@ export type RouteOptions<
   TLoaderFn,
   TRouterContext,
   TRouteContextFn,
-  TBeforeLoadFn
+  TBeforeLoadFn,
+  TSSR
 > &
   UpdatableRouteOptions<
     NoInfer<TParentRoute>,
@@ -784,6 +840,7 @@ export type BeforeLoadFn<
 ) => any
 
 export type FileBaseRouteOptions<
+  TRegister extends Register,
   TParentRoute extends AnyRoute = AnyRoute,
   TId extends string = string,
   TPath extends string = string,
@@ -795,6 +852,7 @@ export type FileBaseRouteOptions<
   TRouteContextFn = AnyContext,
   TBeforeLoadFn = AnyContext,
   TRemountDepsFn = AnyContext,
+  TSSR = unknown,
 > = ParamsOptions<TPath, TParams> & {
   validateSearch?: Constrain<TSearchValidator, AnyValidator, DefaultValidator>
 
@@ -824,13 +882,14 @@ export type FileBaseRouteOptions<
     ) => any
   >
 
-  ssr?:
+  ssr?: Constrain<
+    TSSR,
     | undefined
-    | boolean
-    | 'data-only'
+    | SSROption
     | ((
         ctx: SsrContextOptions<TParentRoute, TSearchValidator, TParams>,
-      ) => Awaitable<undefined | boolean | 'data-only'>)
+      ) => Awaitable<undefined | SSROption>)
+  >
 
   // This async function is called before a route is loaded.
   // If an error is thrown here, the route's loader will not be called.
@@ -846,7 +905,12 @@ export type FileBaseRouteOptions<
         TRouterContext,
         TRouteContextFn
       >,
-    ) => any
+    ) => ValidateSerializableLifecycleResult<
+      TRegister,
+      TParentRoute,
+      TSSR,
+      TBeforeLoadFn
+    >
   >
 
   loaderDeps?: (
@@ -877,11 +941,17 @@ export type FileBaseRouteOptions<
         TRouteContextFn,
         TBeforeLoadFn
       >,
-    ) => any
+    ) => ValidateSerializableLifecycleResult<
+      TRegister,
+      TParentRoute,
+      TSSR,
+      TLoaderFn
+    >
   >
 }
 
 export type BaseRouteOptions<
+  TRegister extends Register,
   TParentRoute extends AnyRoute = AnyRoute,
   TId extends string = string,
   TCustomId extends string = string,
@@ -893,8 +963,10 @@ export type BaseRouteOptions<
   TRouterContext = {},
   TRouteContextFn = AnyContext,
   TBeforeLoadFn = AnyContext,
+  TSSR = unknown,
 > = RoutePathOptions<TCustomId, TPath> &
   FileBaseRouteOptions<
+    TRegister,
     TParentRoute,
     TId,
     TPath,
@@ -904,7 +976,9 @@ export type BaseRouteOptions<
     TLoaderFn,
     TRouterContext,
     TRouteContextFn,
-    TBeforeLoadFn
+    TBeforeLoadFn,
+    AnyContext,
+    TSSR
   > & {
     getParentRoute: () => TParentRoute
   }
@@ -1243,14 +1317,17 @@ export interface RootRouteOptionsExtensions
   extends DefaultRootRouteOptionsExtensions {}
 
 export type RootRouteOptions<
+  TRegister extends Register = Register,
   TSearchValidator = undefined,
   TRouterContext = {},
   TRouteContextFn = AnyContext,
   TBeforeLoadFn = AnyContext,
   TLoaderDeps extends Record<string, any> = {},
   TLoaderFn = undefined,
+  TSSR = unknown,
 > = Omit<
   RouteOptions<
+    TRegister,
     any, // TParentRoute
     RootRouteId, // TId
     RootRouteId, // TCustomId
@@ -1262,7 +1339,8 @@ export type RootRouteOptions<
     TLoaderFn,
     TRouterContext,
     TRouteContextFn,
-    TBeforeLoadFn
+    TBeforeLoadFn,
+    TSSR
   >,
   | 'path'
   | 'id'
@@ -1328,6 +1406,7 @@ export type NotFoundRouteProps = {
 }
 
 export class BaseRoute<
+  in out TRegister extends Register,
   in out TParentRoute extends AnyRoute = AnyRoute,
   in out TPath extends string = '/',
   in out TFullPath extends string = ResolveFullPath<TParentRoute, TPath>,
@@ -1342,9 +1421,11 @@ export class BaseRoute<
   in out TLoaderFn = undefined,
   in out TChildren = unknown,
   in out TFileRouteTypes = unknown,
+  in out TSSR = unknown,
 > {
   isRoot: TParentRoute extends AnyRoute ? true : false
   options: RouteOptions<
+    TRegister,
     TParentRoute,
     TId,
     TCustomId,
@@ -1356,7 +1437,8 @@ export class BaseRoute<
     TLoaderFn,
     TRouterContext,
     TRouteContextFn,
-    TBeforeLoadFn
+    TBeforeLoadFn,
+    TSSR
   >
 
   // The following properties are set up in this.init()
@@ -1389,6 +1471,7 @@ export class BaseRoute<
   lazyFn?: () => Promise<
     LazyRoute<
       Route<
+        TRegister,
         TParentRoute,
         TPath,
         TFullPath,
@@ -1402,15 +1485,19 @@ export class BaseRoute<
         TLoaderDeps,
         TLoaderFn,
         TChildren,
-        TFileRouteTypes
+        TFileRouteTypes,
+        TSSR
       >
     >
   >
+  /** @internal */
   _lazyPromise?: Promise<void>
-  _componentsPromise?: Promise<Array<void>>
+  /** @internal */
+  _componentsPromise?: Promise<void>
 
   constructor(
     options?: RouteOptions<
+      TRegister,
       TParentRoute,
       TId,
       TCustomId,
@@ -1422,7 +1509,8 @@ export class BaseRoute<
       TLoaderFn,
       TRouterContext,
       TRouteContextFn,
-      TBeforeLoadFn
+      TBeforeLoadFn,
+      TSSR
     >,
   ) {
     this.options = (options as any) || {}
@@ -1447,7 +1535,8 @@ export class BaseRoute<
     TLoaderDeps,
     TLoaderFn,
     TChildren,
-    TFileRouteTypes
+    TFileRouteTypes,
+    TSSR
   >
 
   init = (opts: { originalIndex: number }): void => {
@@ -1455,6 +1544,7 @@ export class BaseRoute<
 
     const options = this.options as
       | (RouteOptions<
+          TRegister,
           TParentRoute,
           TId,
           TCustomId,
@@ -1466,7 +1556,8 @@ export class BaseRoute<
           TLoaderFn,
           TRouterContext,
           TRouteContextFn,
-          TBeforeLoadFn
+          TBeforeLoadFn,
+          TSSR
         > &
           RoutePathOptionsIntersection<TCustomId, TPath>)
       | undefined
@@ -1528,6 +1619,7 @@ export class BaseRoute<
   }
 
   addChildren: RouteAddChildrenFn<
+    TRegister,
     TParentRoute,
     TPath,
     TFullPath,
@@ -1540,12 +1632,14 @@ export class BaseRoute<
     TBeforeLoadFn,
     TLoaderDeps,
     TLoaderFn,
-    TFileRouteTypes
+    TFileRouteTypes,
+    TSSR
   > = (children) => {
     return this._addFileChildren(children) as any
   }
 
   _addFileChildren: RouteAddFileChildrenFn<
+    TRegister,
     TParentRoute,
     TPath,
     TFullPath,
@@ -1558,7 +1652,8 @@ export class BaseRoute<
     TBeforeLoadFn,
     TLoaderDeps,
     TLoaderFn,
-    TFileRouteTypes
+    TFileRouteTypes,
+    TSSR
   > = (children) => {
     if (Array.isArray(children)) {
       this.children = children as TChildren
@@ -1572,6 +1667,7 @@ export class BaseRoute<
   }
 
   _addFileTypes: RouteAddFileTypesFn<
+    TRegister,
     TParentRoute,
     TPath,
     TFullPath,
@@ -1584,7 +1680,8 @@ export class BaseRoute<
     TBeforeLoadFn,
     TLoaderDeps,
     TLoaderFn,
-    TChildren
+    TChildren,
+    TSSR
   > = () => {
     return this as any
   }
@@ -1605,6 +1702,7 @@ export class BaseRoute<
   }) => {
     Object.assign(this.options, options)
     return this as unknown as BaseRoute<
+      TRegister,
       TParentRoute,
       TPath,
       TFullPath,
@@ -1618,7 +1716,8 @@ export class BaseRoute<
       TLoaderDeps,
       TNewLoaderFn,
       TChildren,
-      TFileRouteTypes
+      TFileRouteTypes,
+      TSSR
     >
   }
 
@@ -1642,6 +1741,7 @@ export class BaseRoute<
 
   lazy: RouteLazyFn<
     Route<
+      TRegister,
       TParentRoute,
       TPath,
       TFullPath,
@@ -1655,7 +1755,8 @@ export class BaseRoute<
       TLoaderDeps,
       TLoaderFn,
       TChildren,
-      TFileRouteTypes
+      TFileRouteTypes,
+      TSSR
     >
   > = (lazyFn) => {
     this.lazyFn = lazyFn
@@ -1676,6 +1777,7 @@ export class BaseRouteApi<TId, TRouter extends AnyRouter = RegisteredRouter> {
 }
 
 export interface RootRoute<
+  in out TRegister extends Register,
   in out TSearchValidator = undefined,
   in out TRouterContext = {},
   in out TRouteContextFn = AnyContext,
@@ -1684,7 +1786,9 @@ export interface RootRoute<
   in out TLoaderFn = undefined,
   in out TChildren = unknown,
   in out TFileRouteTypes = unknown,
+  in out TSSR = unknown,
 > extends Route<
+    TRegister,
     any, // TParentRoute
     '/', // TPath
     '/', // TFullPath
@@ -1698,10 +1802,12 @@ export interface RootRoute<
     TLoaderDeps,
     TLoaderFn,
     TChildren, // TChildren
-    TFileRouteTypes
+    TFileRouteTypes,
+    TSSR
   > {}
 
 export class BaseRootRoute<
+  in out TRegister extends Register,
   in out TSearchValidator = undefined,
   in out TRouterContext = {},
   in out TRouteContextFn = AnyContext,
@@ -1710,7 +1816,9 @@ export class BaseRootRoute<
   in out TLoaderFn = undefined,
   in out TChildren = unknown,
   in out TFileRouteTypes = unknown,
+  in out TSSR = unknown,
 > extends BaseRoute<
+  TRegister,
   any, // TParentRoute
   '/', // TPath
   '/', // TFullPath
@@ -1724,16 +1832,19 @@ export class BaseRootRoute<
   TLoaderDeps,
   TLoaderFn,
   TChildren, // TChildren
-  TFileRouteTypes
+  TFileRouteTypes,
+  TSSR
 > {
   constructor(
     options?: RootRouteOptions<
+      TRegister,
       TSearchValidator,
       TRouterContext,
       TRouteContextFn,
       TBeforeLoadFn,
       TLoaderDeps,
-      TLoaderFn
+      TLoaderFn,
+      TSSR
     >,
   ) {
     super(options as any)