@tanstack/router-core 1.121.0 → 1.121.12

package/dist/cjs/router.d.cts

@@ -2,7 +2,7 @@ import { Store } from '@tanstack/store';
 import { SearchParser, SearchSerializer } from './searchParams.cjs';
 import { AnyRedirect, ResolvedRedirect } from './redirect.cjs';
 import { HistoryLocation, HistoryState, ParsedHistoryState, RouterHistory } from '@tanstack/history';
-import { ControlledPromise, NoInfer, NonNullableUpdater, PickAsRequired, Updater } from './utils.cjs';
+import { Awaitable, ControlledPromise, NoInfer, NonNullableUpdater, PickAsRequired, Updater } from './utils.cjs';
 import { ParsedLocation } from './location.cjs';
 import { DeferredPromiseState } from './defer.cjs';
 import { AnyContext, AnyRoute, AnyRouteWithContext, MakeRemountDepsOptionsUnion, RouteMask } from './route.cjs';
@@ -206,12 +206,10 @@ export interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption
     /**
      * A function that will be called when the router is hydrated.
      *
-     * The return value of this function will be serialized and stored in the router's dehydrated state.
-     *
      * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#hydrate-method)
      * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/external-data-loading#critical-dehydrationhydration)
      */
-    hydrate?: (dehydrated: TDehydrated) => void;
+    hydrate?: (dehydrated: TDehydrated) => Awaitable<void>;
     /**
      * An array of route masks that will be used to mask routes in the route tree.
      *
@@ -604,14 +602,15 @@ interface RouteLike {
         caseSensitive?: boolean;
     };
 }
-export declare function processRouteTree<TRouteLike extends RouteLike>({ routeTree, initRoute, }: {
-    routeTree: TRouteLike;
-    initRoute?: (route: TRouteLike, index: number) => void;
-}): {
+export type ProcessRouteTreeResult<TRouteLike extends RouteLike> = {
     routesById: Record<string, TRouteLike>;
     routesByPath: Record<string, TRouteLike>;
-    flatRoutes: TRouteLike[];
+    flatRoutes: Array<TRouteLike>;
 };
+export declare function processRouteTree<TRouteLike extends RouteLike>({ routeTree, initRoute, }: {
+    routeTree: TRouteLike;
+    initRoute?: (route: TRouteLike, index: number) => void;
+}): ProcessRouteTreeResult<TRouteLike>;
 export declare function getMatchedRoutes<TRouteLike extends RouteLike>({ pathname, routePathname, basepath, caseSensitive, routesByPath, routesById, flatRoutes, }: {
     pathname: string;
     routePathname?: string;

package/dist/esm/index.d.ts

@@ -17,7 +17,7 @@ export type { RootRouteId } from './root.js';
 export { BaseRoute, BaseRouteApi, BaseRootRoute } from './route.js';
 export type { AnyPathParams, SearchSchemaInput, AnyContext, RouteContext, PreloadableObj, RoutePathOptions, StaticDataRouteOption, RoutePathOptionsIntersection, SearchFilter, SearchMiddlewareContext, SearchMiddleware, ResolveId, InferFullSearchSchema, InferFullSearchSchemaInput, InferAllParams, InferAllContext, MetaDescriptor, RouteLinkEntry, SearchValidator, AnySearchValidator, DefaultSearchValidator, ErrorRouteProps, ErrorComponentProps, NotFoundRouteProps, ResolveParams, ParseParamsFn, StringifyParamsFn, ParamsOptions, UpdatableStaticRouteOption, ContextReturnType, ContextAsyncReturnType, ResolveRouteContext, ResolveLoaderData, RoutePrefix, TrimPath, TrimPathLeft, TrimPathRight, ResolveSearchSchemaFnInput, ResolveSearchSchemaInput, ResolveSearchSchemaFn, ResolveSearchSchema, ResolveFullSearchSchema, ResolveFullSearchSchemaInput, ResolveAllContext, BeforeLoadContextParameter, RouteContextParameter, ResolveAllParamsFromParent, AnyRoute, Route, RouteTypes, FullSearchSchemaOption, RemountDepsOptions, MakeRemountDepsOptionsUnion, ResolveFullPath, AnyRouteWithContext, RouteOptions, FileBaseRouteOptions, BaseRouteOptions, UpdatableRouteOptions, RouteLoaderFn, LoaderFnContext, RouteContextFn, BeforeLoadFn, ContextOptions, RouteContextOptions, BeforeLoadContextOptions, RootRouteOptions, UpdatableRouteOptionsExtensions, RouteConstraints, RouteTypesById, RouteMask, RouteExtensions, RouteLazyFn, RouteAddChildrenFn, RouteAddFileChildrenFn, RouteAddFileTypesFn, ResolveOptionalParams, ResolveRequiredParams, RootRoute, } from './route.js';
 export { defaultSerializeError, getLocationChangeInfo, RouterCore, componentTypes, lazyFn, SearchParamError, PathParamError, getInitialRouterState, processRouteTree, getMatchedRoutes, } from './router.js';
-export type { ViewTransitionOptions, ExtractedBaseEntry, ExtractedStream, ExtractedPromise, ExtractedEntry, StreamState, TrailingSlashOption, Register, AnyRouter, AnyRouterWithContext, RegisteredRouter, RouterState, BuildNextOptions, RouterListener, RouterEvent, ListenerFn, RouterEvents, MatchRoutesOpts, RouterOptionsExtensions, DefaultRemountDepsFn, PreloadRouteFn, MatchRouteFn, RouterContextOptions, RouterOptions, RouterConstructorOptions, UpdateFn, ParseLocationFn, InvalidateFn, ControllablePromise, InjectedHtmlEntry, RouterErrorSerializer, EmitFn, LoadFn, GetMatchFn, SubscribeFn, UpdateMatchFn, CommitLocationFn, GetMatchRoutesFn, MatchRoutesFn, StartTransitionFn, LoadRouteChunkFn, ServerSrr, ClearCacheFn, CreateRouterFn, } from './router.js';
+export type { ViewTransitionOptions, ExtractedBaseEntry, ExtractedStream, ExtractedPromise, ExtractedEntry, StreamState, TrailingSlashOption, Register, AnyRouter, AnyRouterWithContext, RegisteredRouter, RouterState, BuildNextOptions, RouterListener, RouterEvent, ListenerFn, RouterEvents, MatchRoutesOpts, RouterOptionsExtensions, DefaultRemountDepsFn, PreloadRouteFn, MatchRouteFn, RouterContextOptions, RouterOptions, RouterConstructorOptions, UpdateFn, ParseLocationFn, InvalidateFn, ControllablePromise, InjectedHtmlEntry, RouterErrorSerializer, EmitFn, LoadFn, GetMatchFn, SubscribeFn, UpdateMatchFn, CommitLocationFn, GetMatchRoutesFn, MatchRoutesFn, StartTransitionFn, LoadRouteChunkFn, ServerSrr, ClearCacheFn, CreateRouterFn, ProcessRouteTreeResult, } from './router.js';
 export type { MatchLocation, CommitLocationOptions, NavigateFn, BuildLocationFn, } from './RouterProvider.js';
 export { retainSearchParams, stripSearchParams } from './searchMiddleware.js';
 export { defaultParseSearch, defaultStringifySearch, parseSearchWith, stringifySearchWith, } from './searchParams.js';

package/dist/esm/router.d.ts

@@ -2,7 +2,7 @@ import { Store } from '@tanstack/store';
 import { SearchParser, SearchSerializer } from './searchParams.js';
 import { AnyRedirect, ResolvedRedirect } from './redirect.js';
 import { HistoryLocation, HistoryState, ParsedHistoryState, RouterHistory } from '@tanstack/history';
-import { ControlledPromise, NoInfer, NonNullableUpdater, PickAsRequired, Updater } from './utils.js';
+import { Awaitable, ControlledPromise, NoInfer, NonNullableUpdater, PickAsRequired, Updater } from './utils.js';
 import { ParsedLocation } from './location.js';
 import { DeferredPromiseState } from './defer.js';
 import { AnyContext, AnyRoute, AnyRouteWithContext, MakeRemountDepsOptionsUnion, RouteMask } from './route.js';
@@ -206,12 +206,10 @@ export interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption
     /**
      * A function that will be called when the router is hydrated.
      *
-     * The return value of this function will be serialized and stored in the router's dehydrated state.
-     *
      * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#hydrate-method)
      * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/external-data-loading#critical-dehydrationhydration)
      */
-    hydrate?: (dehydrated: TDehydrated) => void;
+    hydrate?: (dehydrated: TDehydrated) => Awaitable<void>;
     /**
      * An array of route masks that will be used to mask routes in the route tree.
      *
@@ -604,14 +602,15 @@ interface RouteLike {
         caseSensitive?: boolean;
     };
 }
-export declare function processRouteTree<TRouteLike extends RouteLike>({ routeTree, initRoute, }: {
-    routeTree: TRouteLike;
-    initRoute?: (route: TRouteLike, index: number) => void;
-}): {
+export type ProcessRouteTreeResult<TRouteLike extends RouteLike> = {
     routesById: Record<string, TRouteLike>;
     routesByPath: Record<string, TRouteLike>;
-    flatRoutes: TRouteLike[];
+    flatRoutes: Array<TRouteLike>;
 };
+export declare function processRouteTree<TRouteLike extends RouteLike>({ routeTree, initRoute, }: {
+    routeTree: TRouteLike;
+    initRoute?: (route: TRouteLike, index: number) => void;
+}): ProcessRouteTreeResult<TRouteLike>;
 export declare function getMatchedRoutes<TRouteLike extends RouteLike>({ pathname, routePathname, basepath, caseSensitive, routesByPath, routesById, flatRoutes, }: {
     pathname: string;
     routePathname?: string;