@tanstack/router-core 1.126.2 → 1.127.0

package/dist/esm/router.d.ts

@@ -4,13 +4,11 @@ import { AnyRedirect, ResolvedRedirect } from './redirect.js';
 import { HistoryLocation, HistoryState, ParsedHistoryState, RouterHistory } from '@tanstack/history';
 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';
 import { FullSearchSchema, RouteById, RoutePaths, RoutesById, RoutesByPath } from './routeInfo.js';
 import { AnyRouteMatch, MakeRouteMatch, MakeRouteMatchUnion, MatchRouteOptions } from './Matches.js';
 import { BuildLocationFn, CommitLocationOptions, NavigateFn } from './RouterProvider.js';
 import { Manifest } from './manifest.js';
-import { TsrSerializer } from './serializer.js';
 import { AnySchema } from './validators.js';
 import { NavigateOptions, ResolveRelativePath, ToOptions } from './link.js';
 import { NotFoundError } from './not-found.js';
@@ -202,7 +200,7 @@ export interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption
      * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#dehydrate-method)
      * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/external-data-loading#critical-dehydrationhydration)
      */
-    dehydrate?: () => TDehydrated;
+    dehydrate?: () => Awaitable<TDehydrated>;
     /**
      * A function that will be called when the router is hydrated.
      *
@@ -349,7 +347,7 @@ type NavigationEventInfo = {
     hrefChanged: boolean;
     hashChanged: boolean;
 };
-export type RouterEvents = {
+export interface RouterEvents {
     onBeforeNavigate: {
         type: 'onBeforeNavigate';
     } & NavigationEventInfo;
@@ -365,20 +363,17 @@ export type RouterEvents = {
     onBeforeRouteMount: {
         type: 'onBeforeRouteMount';
     } & NavigationEventInfo;
-    onInjectedHtml: {
-        type: 'onInjectedHtml';
-        promise: Promise<string>;
-    };
     onRendered: {
         type: 'onRendered';
     } & NavigationEventInfo;
-};
+}
 export type RouterEvent = RouterEvents[keyof RouterEvents];
 export type ListenerFn<TEvent extends RouterEvent> = (event: TEvent) => void;
 export type RouterListener<TRouterEvent extends RouterEvent> = {
     eventType: TRouterEvent['type'];
     fn: ListenerFn<TRouterEvent>;
 };
+export type SubscribeFn = <TType extends keyof RouterEvents>(eventType: TType, fn: ListenerFn<RouterEvents[TType]>) => () => void;
 export interface MatchRoutesOpts {
     preload?: boolean;
     throwOnError?: boolean;
@@ -392,10 +387,6 @@ export type RouterContextOptions<TRouteTree extends AnyRoute> = AnyContext exten
     context: InferRouterContext<TRouteTree>;
 };
 export type RouterConstructorOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory, TDehydrated extends Record<string, any>> = Omit<RouterOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>, 'context'> & RouterContextOptions<TRouteTree>;
-export interface RouterErrorSerializer<TSerializedError> {
-    serialize: (err: unknown) => TSerializedError;
-    deserialize: (err: TSerializedError) => unknown;
-}
 export type PreloadRouteFn<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory> = <TFrom extends RoutePaths<TRouteTree> | string = string, TTo extends string | undefined = undefined, TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom, TMaskTo extends string = ''>(opts: NavigateOptions<RouterCore<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory>, TFrom, TTo, TMaskFrom, TMaskTo>) => Promise<Array<AnyRouteMatch> | undefined>;
 export type MatchRouteFn<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory> = <TFrom extends RoutePaths<TRouteTree> = '/', TTo extends string | undefined = undefined, TResolved = ResolveRelativePath<TFrom, NoInfer<TTo>>>(location: ToOptions<RouterCore<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory>, TFrom, TTo>, opts?: MatchRouteOptions) => false | RouteById<TRouteTree, TResolved>['types']['allParams'];
 export type UpdateFn<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory, TDehydrated extends Record<string, any>> = (newOptions: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>) => void;
@@ -416,7 +407,6 @@ export type LoadFn = (opts?: {
 }) => Promise<void>;
 export type CommitLocationFn = ({ viewTransition, ignoreBlocker, ...next }: ParsedLocation & CommitLocationOptions) => Promise<void>;
 export type StartTransitionFn = (fn: () => void) => void;
-export type SubscribeFn = <TType extends keyof RouterEvents>(eventType: TType, fn: ListenerFn<RouterEvents[TType]>) => () => void;
 export interface MatchRoutesFn {
     (pathname: string, locationSearch: AnySchema, opts?: MatchRoutesOpts): Array<AnyRouteMatch>;
     (next: ParsedLocation, opts?: MatchRoutesOpts): Array<AnyRouteMatch>;
@@ -429,18 +419,15 @@ export type ResolveRedirect = (err: AnyRedirect) => ResolvedRedirect;
 export type ClearCacheFn<TRouter extends AnyRouter> = (opts?: {
     filter?: (d: MakeRouteMatchUnion<TRouter>) => boolean;
 }) => void;
-export interface ServerSrr {
+export interface ServerSsr {
     injectedHtml: Array<InjectedHtmlEntry>;
     injectHtml: (getHtml: () => string | Promise<string>) => Promise<void>;
     injectScript: (getScript: () => string | Promise<string>, opts?: {
         logScript?: boolean;
     }) => Promise<void>;
-    streamValue: (key: string, value: any) => void;
-    streamedKeys: Set<string>;
-    onMatchSettled: (opts: {
-        router: AnyRouter;
-        match: AnyRouteMatch;
-    }) => any;
+    isDehydrated: () => boolean;
+    onRenderFinished: (listener: () => void) => void;
+    dehydrate: () => Promise<void>;
 }
 export type AnyRouterWithContext<TContext> = RouterCore<AnyRouteWithContext<TContext>, any, any, any, any>;
 export type AnyRouter = RouterCore<any, any, any, any, any>;
@@ -459,25 +446,6 @@ export declare function defaultSerializeError(err: unknown): {
 } | {
     data: unknown;
 };
-export interface ExtractedBaseEntry {
-    dataType: '__beforeLoadContext' | 'loaderData';
-    type: string;
-    path: Array<string>;
-    id: number;
-    matchIndex: number;
-}
-export interface ExtractedStream extends ExtractedBaseEntry {
-    type: 'stream';
-    streamState: StreamState;
-}
-export interface ExtractedPromise extends ExtractedBaseEntry {
-    type: 'promise';
-    promiseState: DeferredPromiseState<any>;
-}
-export type ExtractedEntry = ExtractedStream | ExtractedPromise;
-export type StreamState = {
-    promises: Array<ControlledPromise<string | null>>;
-};
 export type TrailingSlashOption = 'always' | 'never' | 'preserve';
 export declare function getLocationChangeInfo(routerState: {
     resolvedLocation?: ParsedLocation;
@@ -568,24 +536,8 @@ export declare class RouterCore<in out TRouteTree extends AnyRoute, in out TTrai
     matchRoute: MatchRouteFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory>;
     ssr?: {
         manifest: Manifest | undefined;
-        serializer: TsrSerializer;
-    };
-    serverSsr?: {
-        injectedHtml: Array<InjectedHtmlEntry>;
-        injectHtml: (getHtml: () => string | Promise<string>) => Promise<void>;
-        injectScript: (getScript: () => string | Promise<string>, opts?: {
-            logScript?: boolean;
-        }) => Promise<void>;
-        streamValue: (key: string, value: any) => void;
-        streamedKeys: Set<string>;
-        onMatchSettled: (opts: {
-            router: AnyRouter;
-            match: AnyRouteMatch;
-        }) => any;
-    };
-    clientSsr?: {
-        getStreamedValue: <T>(key: string) => T | undefined;
     };
+    serverSsr?: ServerSsr;
     _handleNotFound: (matches: Array<AnyRouteMatch>, err: NotFoundError, { updateMatch, }?: {
         updateMatch?: (id: string, updater: (match: AnyRouteMatch) => AnyRouteMatch) => void;
     }) => void;

package/dist/esm/router.js

@@ -745,7 +745,7 @@ class RouterCore {
         triggerOnReady();
       }
       const handleRedirectAndNotFound = (match, err) => {
-        var _a, _b, _c, _d;
+        var _a, _b, _c;
         if (isRedirect(err) || isNotFound(err)) {
           if (isRedirect(err)) {
             if (err.redirectHandled) {
@@ -778,10 +778,6 @@ class RouterCore {
             this._handleNotFound(matches, err, {
               updateMatch
             });
-            (_d = this.serverSsr) == null ? void 0 : _d.onMatchSettled({
-              router: this,
-              match: this.getMatch(match.id)
-            });
             throw err;
           }
         }
@@ -968,7 +964,7 @@ class RouterCore {
                       cause: preload ? "preload" : cause,
                       matches
                     };
-                    const beforeLoadContext = await ((_d = (_c = route.options).beforeLoad) == null ? void 0 : _d.call(_c, beforeLoadFnContext)) ?? {};
+                    const beforeLoadContext = await ((_d = (_c = route.options).beforeLoad) == null ? void 0 : _d.call(_c, beforeLoadFnContext));
                     if (isRedirect(beforeLoadContext) || isNotFound(beforeLoadContext)) {
                       handleSerialError(index, beforeLoadContext, "BEFORE_LOAD");
                     }
@@ -1003,12 +999,11 @@ class RouterCore {
               validResolvedMatches.forEach(({ id: matchId, routeId }, index) => {
                 matchPromises.push(
                   (async () => {
-                    var _a2, _b2;
                     let loaderShouldRunAsync = false;
                     let loaderIsRunningAsync = false;
                     const route = this.looseRoutesById[routeId];
                     const executeHead = async () => {
-                      var _a3, _b3, _c2, _d2, _e, _f;
+                      var _a2, _b2, _c2, _d2, _e, _f;
                       const match = this.getMatch(matchId);
                       if (!match) {
                         return;
@@ -1019,7 +1014,7 @@ class RouterCore {
                         params: match.params,
                         loaderData: match.loaderData
                       };
-                      const headFnContent = await ((_b3 = (_a3 = route.options).head) == null ? void 0 : _b3.call(_a3, assetContext));
+                      const headFnContent = await ((_b2 = (_a2 = route.options).head) == null ? void 0 : _b2.call(_a2, assetContext));
                       const meta = headFnContent == null ? void 0 : headFnContent.meta;
                       const links = headFnContent == null ? void 0 : headFnContent.links;
                       const headScripts = headFnContent == null ? void 0 : headFnContent.scripts;
@@ -1049,10 +1044,6 @@ class RouterCore {
                           ...prev,
                           ...head
                         }));
-                        (_a2 = this.serverSsr) == null ? void 0 : _a2.onMatchSettled({
-                          router: this,
-                          match: this.getMatch(matchId)
-                        });
                         return this.getMatch(matchId);
                       } else {
                         await potentialPendingMinPromise();
@@ -1101,7 +1092,7 @@ class RouterCore {
                         preload: !!preload && !this.state.matches.find((d) => d.id === matchId)
                       }));
                       const runLoader = async () => {
-                        var _a3, _b3, _c2, _d2, _e;
+                        var _a2, _b2, _c2, _d2;
                         try {
                           try {
                             if (!this.isServer || this.isServer && this.getMatch(matchId).ssr === true) {
@@ -1111,7 +1102,7 @@ class RouterCore {
                               ...prev,
                               isFetching: "loader"
                             }));
-                            const loaderData = await ((_b3 = (_a3 = route.options).loader) == null ? void 0 : _b3.call(_a3, getLoaderContext()));
+                            const loaderData = await ((_b2 = (_a2 = route.options).loader) == null ? void 0 : _b2.call(_a2, getLoaderContext()));
                             handleRedirectAndNotFound(
                               this.getMatch(matchId),
                               loaderData
@@ -1154,10 +1145,6 @@ class RouterCore {
                               ...head
                             }));
                           }
-                          (_e = this.serverSsr) == null ? void 0 : _e.onMatchSettled({
-                            router: this,
-                            match: this.getMatch(matchId)
-                          });
                         } catch (err) {
                           const head = await executeHead();
                           updateMatch(matchId, (prev) => ({
@@ -1200,10 +1187,6 @@ class RouterCore {
                           ...prev,
                           ...head
                         }));
-                        (_b2 = this.serverSsr) == null ? void 0 : _b2.onMatchSettled({
-                          router: this,
-                          match: this.getMatch(matchId)
-                        });
                       }
                     }
                     if (!loaderIsRunningAsync) {
@@ -1475,7 +1458,7 @@ class RouterCore {
       parseSearch: options.parseSearch ?? defaultParseSearch
     });
     if (typeof document !== "undefined") {
-      window.__TSR_ROUTER__ = this;
+      self.__TSR_ROUTER__ = this;
     }
   }
   get state() {
@@ -1621,7 +1604,7 @@ class RouterCore {
           error: void 0,
           paramsError: parseErrors[index],
           __routeContext: {},
-          __beforeLoadContext: {},
+          __beforeLoadContext: void 0,
           context: {},
           abortController: new AbortController(),
           fetchCount: 0,