@tanstack/router-core 1.121.0-alpha.27 → 1.121.0-alpha.28

package/dist/cjs/route.d.cts

@@ -2,7 +2,7 @@ import { LazyRoute } from './fileRoute.cjs';
 import { NotFoundError } from './not-found.cjs';
 import { NavigateOptions, ParsePathParams } from './link.cjs';
 import { ParsedLocation } from './location.cjs';
-import { AnyRouteMatch, MakeRouteMatchFromRoute, MakeRouteMatchUnion, RouteMatch } from './Matches.cjs';
+import { AnyRouteMatch, MakePreValidationErrorHandlingRouteMatchUnion, MakeRouteMatchFromRoute, MakeRouteMatchUnion, RouteMatch } from './Matches.cjs';
 import { RootRouteId } from './root.cjs';
 import { ParseRoute, RouteById, RoutePaths } from './routeInfo.cjs';
 import { AnyRouter, RegisteredRouter } from './router.cjs';
@@ -195,7 +195,6 @@ export interface Route<in out TParentRoute extends AnyRoute, in out TPath extend
     to: TrimPathRight<TFullPath>;
     init: (opts: {
         originalIndex: number;
-        defaultSsr?: boolean;
     }) => void;
     update: (options: UpdatableRouteOptions<TParentRoute, TCustomId, TFullPath, TParams, TSearchValidator, TLoaderFn, TLoaderDeps, TRouterContext, TRouteContextFn, TBeforeLoadFn>) => this;
     lazy: RouteLazyFn<Route<TParentRoute, TPath, TFullPath, TCustomId, TId, TSearchValidator, TParams, TRouterContext, TRouteContextFn, TBeforeLoadFn, TLoaderDeps, TLoaderFn, TChildren, TFileRouteTypes>>;
@@ -216,6 +215,7 @@ export type FileBaseRouteOptions<TParentRoute extends AnyRoute = AnyRoute, TId e
     validateSearch?: Constrain<TSearchValidator, AnyValidator, DefaultValidator>;
     shouldReload?: boolean | ((match: LoaderFnContext<TParentRoute, TId, TParams, TLoaderDeps, TRouterContext, TRouteContextFn, TBeforeLoadFn>) => any);
     context?: Constrain<TRouteContextFn, (ctx: RouteContextOptions<TParentRoute, TParams, TRouterContext, TLoaderDeps>) => any>;
+    ssr?: undefined | boolean | 'data-only' | ((ctx: SsrContextOptions<TParentRoute, TSearchValidator, TParams>) => Awaitable<undefined | boolean | 'data-only'>);
     beforeLoad?: Constrain<TBeforeLoadFn, (ctx: BeforeLoadContextOptions<TParentRoute, TSearchValidator, TParams, TRouterContext, TRouteContextFn>) => any>;
     loaderDeps?: (opts: FullSearchSchemaOption<TParentRoute, TSearchValidator>) => TLoaderDeps;
     remountDeps?: Constrain<TRemountDepsFn, (opt: RemountDepsOptions<TId, FullSearchSchemaOption<TParentRoute, TSearchValidator>, Expand<ResolveAllParamsFromParent<TParentRoute, TParams>>, TLoaderDeps>) => any>;
@@ -241,6 +241,24 @@ export interface RouteContextOptions<in out TParentRoute extends AnyRoute, in ou
     deps: TLoaderDeps;
     context: Expand<RouteContextParameter<TParentRoute, TRouterContext>>;
 }
+export interface SsrContextOptions<in out TParentRoute extends AnyRoute, in out TSearchValidator, in out TParams> {
+    params: {
+        status: 'success';
+        value: Expand<ResolveAllParamsFromParent<TParentRoute, TParams>>;
+    } | {
+        status: 'error';
+        error: unknown;
+    };
+    search: {
+        status: 'success';
+        value: Expand<ResolveFullSearchSchema<TParentRoute, TSearchValidator>>;
+    } | {
+        status: 'error';
+        error: unknown;
+    };
+    location: ParsedLocation;
+    matches: Array<MakePreValidationErrorHandlingRouteMatchUnion>;
+}
 export interface BeforeLoadContextOptions<in out TParentRoute extends AnyRoute, in out TSearchValidator, in out TParams, in out TRouterContext, in out TRouteContextFn> extends ContextOptions<TParentRoute, TParams>, FullSearchSchemaOption<TParentRoute, TSearchValidator> {
     context: Expand<BeforeLoadContextParameter<TParentRoute, TRouterContext, TRouteContextFn>>;
 }
@@ -289,9 +307,9 @@ export interface UpdatableRouteOptions<in out TParentRoute extends AnyRoute, in
         links?: AnyRouteMatch['links'];
         scripts?: AnyRouteMatch['headScripts'];
         meta?: AnyRouteMatch['meta'];
+        styles?: AnyRouteMatch['styles'];
     }>;
     scripts?: (ctx: AssetFnContextOptions<TRouteId, TFullPath, TParentRoute, TParams, TSearchValidator, TLoaderFn, TRouterContext, TRouteContextFn, TBeforeLoadFn, TLoaderDeps>) => Awaitable<AnyRouteMatch['scripts']>;
-    ssr?: boolean;
     codeSplitGroupings?: Array<Array<'loader' | 'component' | 'pendingComponent' | 'notFoundComponent' | 'errorComponent'>>;
 }
 export type RouteLoaderFn<in out TParentRoute extends AnyRoute = AnyRoute, in out TId extends string = string, in out TParams = {}, in out TLoaderDeps = {}, in out TRouterContext = {}, in out TRouteContextFn = AnyContext, in out TBeforeLoadFn = AnyContext> = (match: LoaderFnContext<TParentRoute, TId, TParams, TLoaderDeps, TRouterContext, TRouteContextFn, TBeforeLoadFn>) => any;
@@ -310,13 +328,18 @@ export interface LoaderFnContext<in out TParentRoute extends AnyRoute = AnyRoute
     cause: 'preload' | 'enter' | 'stay';
     route: AnyRoute;
 }
+export interface DefaultRootRouteOptionsExtensions {
+    shellComponent?: unknown;
+}
+export interface RootRouteOptionsExtensions extends DefaultRootRouteOptionsExtensions {
+}
 export type RootRouteOptions<TSearchValidator = undefined, TRouterContext = {}, TRouteContextFn = AnyContext, TBeforeLoadFn = AnyContext, TLoaderDeps extends Record<string, any> = {}, TLoaderFn = undefined> = Omit<RouteOptions<any, // TParentRoute
 RootRouteId, // TId
 RootRouteId, // TCustomId
 '', // TFullPath
 '', // TPath
 TSearchValidator, {}, // TParams
-TLoaderDeps, TLoaderFn, TRouterContext, TRouteContextFn, TBeforeLoadFn>, 'path' | 'id' | 'getParentRoute' | 'caseSensitive' | 'parseParams' | 'stringifyParams' | 'params'>;
+TLoaderDeps, TLoaderFn, TRouterContext, TRouteContextFn, TBeforeLoadFn>, 'path' | 'id' | 'getParentRoute' | 'caseSensitive' | 'parseParams' | 'stringifyParams' | 'params'> & RootRouteOptionsExtensions;
 export type RouteConstraints = {
     TParentRoute: AnyRoute;
     TPath: string;
@@ -355,8 +378,8 @@ export type ErrorRouteProps = {
     };
     reset: () => void;
 };
-export type ErrorComponentProps = {
-    error: Error;
+export type ErrorComponentProps<TError = Error> = {
+    error: TError;
     info?: {
         componentStack: string;
     };
@@ -373,12 +396,10 @@ export declare class BaseRoute<in out TParentRoute extends AnyRoute = AnyRoute,
     private _path;
     private _fullPath;
     private _to;
-    private _ssr;
     get to(): TrimPathRight<TFullPath>;
     get id(): TId;
     get path(): TPath;
     get fullPath(): TFullPath;
-    get ssr(): boolean;
     children?: TChildren;
     originalIndex?: number;
     rank: number;
@@ -389,7 +410,6 @@ export declare class BaseRoute<in out TParentRoute extends AnyRoute = AnyRoute,
     types: RouteTypes<TParentRoute, TPath, TFullPath, TCustomId, TId, TSearchValidator, TParams, TRouterContext, TRouteContextFn, TBeforeLoadFn, TLoaderDeps, TLoaderFn, TChildren, TFileRouteTypes>;
     init: (opts: {
         originalIndex: number;
-        defaultSsr?: boolean;
     }) => void;
     clone: (other: typeof this) => void;
     addChildren: RouteAddChildrenFn<TParentRoute, TPath, TFullPath, TCustomId, TId, TSearchValidator, TParams, TRouterContext, TRouteContextFn, TBeforeLoadFn, TLoaderDeps, TLoaderFn, TFileRouteTypes>;