@tanstack/react-router 1.97.0 → 1.97.3

package/dist/cjs/router.d.cts

@@ -1,5 +1,4 @@
 import { Store, NoInfer } from '@tanstack/react-store';
-import { DeferredPromiseState } from './defer.cjs';
 import { HistoryLocation, HistoryState, ParsedHistoryState, RouterHistory } from '@tanstack/history';
 import { Manifest } from './manifest.cjs';
 import { AnyContext, AnyRoute, AnyRouteWithContext, ErrorRouteComponent, NotFoundRouteComponent, RootRoute, RouteComponent, RouteMask } from './route.cjs';
@@ -15,24 +14,30 @@ import { NavigateOptions, ResolveRelativePath, ToOptions } from './link.cjs';
 import { RouterTransformer } from './transformer.cjs';
 import { AnySchema } from './validators.cjs';
 import type * as React from 'react';
+export interface TSRGlobalMatch {
+    index: number;
+    __beforeLoadContext?: string;
+    loaderData?: string;
+    extracted: Record<string, ClientExtractedEntry>;
+}
+export interface TSRGlobal {
+    matches: Array<TSRGlobalMatch>;
+    streamedValues: Record<string, {
+        value: any;
+        parsed: any;
+    }>;
+    cleanScripts: () => void;
+    dehydrated?: any;
+}
 declare global {
     interface Window {
-        __TSR__?: {
-            matches: Array<{
-                __beforeLoadContext?: string;
-                loaderData?: string;
-                extracted?: Array<ExtractedEntry>;
-            }>;
-            streamedValues: Record<string, {
-                value: any;
-                parsed: any;
-            }>;
-            cleanScripts: () => void;
-            dehydrated?: any;
-        };
+        __TSR__?: RegisteredTSRGlobal;
         __TSR_ROUTER_CONTEXT__?: React.Context<Router<any, any, any>>;
     }
 }
+type RegisteredTSRGlobal = Register extends {
+    __TSR__: infer TTSR extends TSRGlobal;
+} ? TTSR : TSRGlobal;
 export interface Register {
 }
 export type AnyRouter = Router<any, any, any, any, any, any>;
@@ -45,22 +50,25 @@ export type HydrationCtx = {
     payload: Record<string, any>;
 };
 export type InferRouterContext<TRouteTree extends AnyRoute> = TRouteTree extends RootRoute<any, infer TRouterContext extends AnyContext, any, any, any, any, any, any> ? TRouterContext : AnyContext;
-export interface ExtractedBaseEntry {
-    dataType: '__beforeLoadContext' | 'loaderData';
+export interface ClientExtractedBaseEntry {
     type: string;
     path: Array<string>;
-    id: number;
-    matchIndex: number;
-}
-export interface ExtractedStream extends ExtractedBaseEntry {
-    type: 'stream';
-    streamState: StreamState;
 }
-export interface ExtractedPromise extends ExtractedBaseEntry {
+export type ControllablePromise<T = any> = Promise<T> & {
+    resolve: (value: T) => void;
+    reject: (value?: any) => void;
+};
+export interface ClientExtractedPromise extends ClientExtractedBaseEntry {
     type: 'promise';
-    promiseState: DeferredPromiseState<any>;
+    value?: ControllablePromise<any>;
+}
+export interface ClientExtractedStream extends ClientExtractedBaseEntry {
+    type: 'stream';
+    value?: ReadableStream & {
+        controller?: ReadableStreamDefaultController;
+    };
 }
-export type ExtractedEntry = ExtractedStream | ExtractedPromise;
+export type ClientExtractedEntry = ClientExtractedStream | ClientExtractedPromise;
 export type StreamState = {
     promises: Array<ControlledPromise<string | null>>;
 };

package/dist/esm/defer.d.ts

@@ -1,20 +1,20 @@
 import { defaultSerializeError } from './router.js';
 export declare const TSR_DEFERRED_PROMISE: unique symbol;
 export type DeferredPromiseState<T> = {
-    [TSR_DEFERRED_PROMISE]: {
-        status: 'pending';
-        data?: T;
-        error?: unknown;
-    } | {
-        status: 'success';
-        data: T;
-    } | {
-        status: 'error';
-        data?: T;
-        error: unknown;
-    };
+    status: 'pending';
+    data?: T;
+    error?: unknown;
+} | {
+    status: 'success';
+    data: T;
+} | {
+    status: 'error';
+    data?: T;
+    error: unknown;
+};
+export type DeferredPromise<T> = Promise<T> & {
+    [TSR_DEFERRED_PROMISE]: DeferredPromiseState<T>;
 };
-export type DeferredPromise<T> = Promise<T> & DeferredPromiseState<T>;
 export declare function defer<T>(_promise: Promise<T>, options?: {
     serializeError?: typeof defaultSerializeError;
 }): DeferredPromise<T>;

package/dist/esm/defer.js.map

@@ -1 +1 @@
-{"version":3,"file":"defer.js","sources":["../../src/defer.ts"],"sourcesContent":["import { defaultSerializeError } from './router'\n\nexport const TSR_DEFERRED_PROMISE = Symbol.for('TSR_DEFERRED_PROMISE')\n\nexport type DeferredPromiseState<T> = {\n  [TSR_DEFERRED_PROMISE]:\n    | {\n        status: 'pending'\n        data?: T\n        error?: unknown\n      }\n    | {\n        status: 'success'\n        data: T\n      }\n    | {\n        status: 'error'\n        data?: T\n        error: unknown\n      }\n}\n\nexport type DeferredPromise<T> = Promise<T> & DeferredPromiseState<T>\n\nexport function defer<T>(\n  _promise: Promise<T>,\n  options?: {\n    serializeError?: typeof defaultSerializeError\n  },\n) {\n  const promise = _promise as DeferredPromise<T>\n  // this is already deferred promise\n  if ((promise as any)[TSR_DEFERRED_PROMISE]) {\n    return promise\n  }\n  promise[TSR_DEFERRED_PROMISE] = { status: 'pending' }\n\n  promise\n    .then((data) => {\n      promise[TSR_DEFERRED_PROMISE].status = 'success'\n      promise[TSR_DEFERRED_PROMISE].data = data\n    })\n    .catch((error) => {\n      promise[TSR_DEFERRED_PROMISE].status = 'error'\n      ;(promise[TSR_DEFERRED_PROMISE] as any).error = {\n        data: (options?.serializeError ?? defaultSerializeError)(error),\n        __isServerError: true,\n      }\n    })\n\n  return promise\n}\n"],"names":[],"mappings":";AAEa,MAAA,uBAAuB,OAAO,IAAI,sBAAsB;AAsBrD,SAAA,MACd,UACA,SAGA;AACA,QAAM,UAAU;AAEX,MAAA,QAAgB,oBAAoB,GAAG;AACnC,WAAA;AAAA,EAAA;AAET,UAAQ,oBAAoB,IAAI,EAAE,QAAQ,UAAU;AAGjD,UAAA,KAAK,CAAC,SAAS;AACN,YAAA,oBAAoB,EAAE,SAAS;AAC/B,YAAA,oBAAoB,EAAE,OAAO;AAAA,EAAA,CACtC,EACA,MAAM,CAAC,UAAU;AACR,YAAA,oBAAoB,EAAE,SAAS;AACrC,YAAQ,oBAAoB,EAAU,QAAQ;AAAA,MAC9C,QAAO,mCAAS,mBAAkB,uBAAuB,KAAK;AAAA,MAC9D,iBAAiB;AAAA,IACnB;AAAA,EAAA,CACD;AAEI,SAAA;AACT;"}
+{"version":3,"file":"defer.js","sources":["../../src/defer.ts"],"sourcesContent":["import { defaultSerializeError } from './router'\n\nexport const TSR_DEFERRED_PROMISE = Symbol.for('TSR_DEFERRED_PROMISE')\n\nexport type DeferredPromiseState<T> =\n  | {\n      status: 'pending'\n      data?: T\n      error?: unknown\n    }\n  | {\n      status: 'success'\n      data: T\n    }\n  | {\n      status: 'error'\n      data?: T\n      error: unknown\n    }\n\nexport type DeferredPromise<T> = Promise<T> & {\n  [TSR_DEFERRED_PROMISE]: DeferredPromiseState<T>\n}\n\nexport function defer<T>(\n  _promise: Promise<T>,\n  options?: {\n    serializeError?: typeof defaultSerializeError\n  },\n) {\n  const promise = _promise as DeferredPromise<T>\n  // this is already deferred promise\n  if ((promise as any)[TSR_DEFERRED_PROMISE]) {\n    return promise\n  }\n  promise[TSR_DEFERRED_PROMISE] = { status: 'pending' }\n\n  promise\n    .then((data) => {\n      promise[TSR_DEFERRED_PROMISE].status = 'success'\n      promise[TSR_DEFERRED_PROMISE].data = data\n    })\n    .catch((error) => {\n      promise[TSR_DEFERRED_PROMISE].status = 'error'\n      ;(promise[TSR_DEFERRED_PROMISE] as any).error = {\n        data: (options?.serializeError ?? defaultSerializeError)(error),\n        __isServerError: true,\n      }\n    })\n\n  return promise\n}\n"],"names":[],"mappings":";AAEa,MAAA,uBAAuB,OAAO,IAAI,sBAAsB;AAsBrD,SAAA,MACd,UACA,SAGA;AACA,QAAM,UAAU;AAEX,MAAA,QAAgB,oBAAoB,GAAG;AACnC,WAAA;AAAA,EAAA;AAET,UAAQ,oBAAoB,IAAI,EAAE,QAAQ,UAAU;AAGjD,UAAA,KAAK,CAAC,SAAS;AACN,YAAA,oBAAoB,EAAE,SAAS;AAC/B,YAAA,oBAAoB,EAAE,OAAO;AAAA,EAAA,CACtC,EACA,MAAM,CAAC,UAAU;AACR,YAAA,oBAAoB,EAAE,SAAS;AACrC,YAAQ,oBAAoB,EAAU,QAAQ;AAAA,MAC9C,QAAO,mCAAS,mBAAkB,uBAAuB,KAAK;AAAA,MAC9D,iBAAiB;AAAA,IACnB;AAAA,EAAA,CACD;AAEI,SAAA;AACT;"}

package/dist/esm/index.d.ts

@@ -34,7 +34,7 @@ export { RouteApi, getRouteApi, Route, createRoute, RootRoute, rootRouteWithCont
 export type { AnyPathParams, ResolveParams, SearchSchemaInput, AnyContext, RouteContext, PreloadableObj, RoutePathOptions, StaticDataRouteOption, RoutePathOptionsIntersection, RouteOptions, FileBaseRouteOptions, BaseRouteOptions, UpdatableRouteOptions, UpdatableStaticRouteOption, MetaDescriptor, RouteLinkEntry, ParseParamsFn, RouteLoaderFn, LoaderFnContext, SearchFilter, ResolveId, InferFullSearchSchema, InferFullSearchSchemaInput, ResolveFullSearchSchema, ResolveFullSearchSchemaInput, AnyRoute, RouteConstraints, AnyRootRoute, ResolveFullPath, RouteMask, ErrorRouteProps, ErrorComponentProps, NotFoundRouteProps, ReactNode, SyncRouteComponent, AsyncRouteComponent, RouteComponent, ErrorRouteComponent, NotFoundRouteComponent, TrimPath, TrimPathLeft, TrimPathRight, RootRouteOptions, AnyRouteWithContext, ParseSplatParams, SplatParams, StringifyParamsFn, ParamsOptions, FullSearchSchemaOption, RouteContextFn, RouteContextOptions, BeforeLoadFn, BeforeLoadContextOptions, ContextOptions, InferAllParams, InferAllContext, LooseReturnType, LooseAsyncReturnType, ContextReturnType, ContextAsyncReturnType, RouteContextParameter, BeforeLoadContextParameter, ResolveAllContext, ResolveLoaderData, ResolveAllParamsFromParent, ResolveRouteContext, } from './route.js';
 export type { ParseRoute, RoutesById, RouteById, RouteIds, RoutesByPath, RouteByPath, RoutePaths, FullSearchSchema, AllParams, AllLoaderData, FullSearchSchemaInput, AllContext, } from './routeInfo.js';
 export { componentTypes, createRouter, Router, lazyFn, SearchParamError, PathParamError, getInitialRouterState, defaultSerializeError, } from './router.js';
-export type { Register, AnyRouter, RegisteredRouter, HydrationCtx, RouterContextOptions, TrailingSlashOption, RouterOptions, RouterErrorSerializer, RouterState, ListenerFn, BuildNextOptions, DehydratedRouterState, DehydratedRouteMatch, DehydratedRouter, RouterConstructorOptions, RouterEvents, RouterEvent, RouterListener, AnyRouterWithContext, ExtractedEntry, ExtractedStream, ExtractedPromise, StreamState, } from './router.js';
+export type { Register, AnyRouter, RegisteredRouter, HydrationCtx, RouterContextOptions, TrailingSlashOption, RouterOptions, RouterErrorSerializer, RouterState, ListenerFn, BuildNextOptions, DehydratedRouterState, DehydratedRouteMatch, DehydratedRouter, RouterConstructorOptions, RouterEvents, RouterEvent, RouterListener, AnyRouterWithContext, ClientExtractedBaseEntry, ClientExtractedEntry, ClientExtractedPromise, ControllablePromise, StreamState, TSRGlobal, TSRGlobalMatch, } from './router.js';
 export { RouterProvider, RouterContextProvider } from './RouterProvider.js';
 export type { RouterProps, CommitLocationOptions, MatchLocation, NavigateFn, BuildLocationFn, InjectedHtmlEntry, } from './RouterProvider.js';
 export { useScrollRestoration, useElementScrollRestoration, ScrollRestoration, } from './scroll-restoration.js';

package/dist/esm/router.d.ts

@@ -1,5 +1,4 @@
 import { Store, NoInfer } from '@tanstack/react-store';
-import { DeferredPromiseState } from './defer.js';
 import { HistoryLocation, HistoryState, ParsedHistoryState, RouterHistory } from '@tanstack/history';
 import { Manifest } from './manifest.js';
 import { AnyContext, AnyRoute, AnyRouteWithContext, ErrorRouteComponent, NotFoundRouteComponent, RootRoute, RouteComponent, RouteMask } from './route.js';
@@ -15,24 +14,30 @@ import { NavigateOptions, ResolveRelativePath, ToOptions } from './link.js';
 import { RouterTransformer } from './transformer.js';
 import { AnySchema } from './validators.js';
 import type * as React from 'react';
+export interface TSRGlobalMatch {
+    index: number;
+    __beforeLoadContext?: string;
+    loaderData?: string;
+    extracted: Record<string, ClientExtractedEntry>;
+}
+export interface TSRGlobal {
+    matches: Array<TSRGlobalMatch>;
+    streamedValues: Record<string, {
+        value: any;
+        parsed: any;
+    }>;
+    cleanScripts: () => void;
+    dehydrated?: any;
+}
 declare global {
     interface Window {
-        __TSR__?: {
-            matches: Array<{
-                __beforeLoadContext?: string;
-                loaderData?: string;
-                extracted?: Array<ExtractedEntry>;
-            }>;
-            streamedValues: Record<string, {
-                value: any;
-                parsed: any;
-            }>;
-            cleanScripts: () => void;
-            dehydrated?: any;
-        };
+        __TSR__?: RegisteredTSRGlobal;
         __TSR_ROUTER_CONTEXT__?: React.Context<Router<any, any, any>>;
     }
 }
+type RegisteredTSRGlobal = Register extends {
+    __TSR__: infer TTSR extends TSRGlobal;
+} ? TTSR : TSRGlobal;
 export interface Register {
 }
 export type AnyRouter = Router<any, any, any, any, any, any>;
@@ -45,22 +50,25 @@ export type HydrationCtx = {
     payload: Record<string, any>;
 };
 export type InferRouterContext<TRouteTree extends AnyRoute> = TRouteTree extends RootRoute<any, infer TRouterContext extends AnyContext, any, any, any, any, any, any> ? TRouterContext : AnyContext;
-export interface ExtractedBaseEntry {
-    dataType: '__beforeLoadContext' | 'loaderData';
+export interface ClientExtractedBaseEntry {
     type: string;
     path: Array<string>;
-    id: number;
-    matchIndex: number;
-}
-export interface ExtractedStream extends ExtractedBaseEntry {
-    type: 'stream';
-    streamState: StreamState;
 }
-export interface ExtractedPromise extends ExtractedBaseEntry {
+export type ControllablePromise<T = any> = Promise<T> & {
+    resolve: (value: T) => void;
+    reject: (value?: any) => void;
+};
+export interface ClientExtractedPromise extends ClientExtractedBaseEntry {
     type: 'promise';
-    promiseState: DeferredPromiseState<any>;
+    value?: ControllablePromise<any>;
+}
+export interface ClientExtractedStream extends ClientExtractedBaseEntry {
+    type: 'stream';
+    value?: ReadableStream & {
+        controller?: ReadableStreamDefaultController;
+    };
 }
-export type ExtractedEntry = ExtractedStream | ExtractedPromise;
+export type ClientExtractedEntry = ClientExtractedStream | ClientExtractedPromise;
 export type StreamState = {
     promises: Array<ControlledPromise<string | null>>;
 };