@tanstack/react-router 1.6.1 → 1.7.0

package/build/types/Matches.d.ts

@@ -64,3 +64,8 @@ export declare function useLoaderDeps<TRouteTree extends AnyRoute = RegisteredRo
 export declare function useLoaderData<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TRouteMatch extends RouteMatch<TRouteTree, TFrom> = RouteMatch<TRouteTree, TFrom>, TSelected = Required<TRouteMatch>['loaderData']>(opts: StrictOrFrom<TFrom> & {
     select?: (match: TRouteMatch) => TSelected;
 }): TSelected;
+export declare function isServerSideError(error: unknown): error is {
+    __isServerError: true;
+    data: Record<string, any>;
+};
+export declare function defaultDeserializeError(serializedData: Record<string, any>): any;

package/build/types/defer.d.ts

@@ -1,3 +1,4 @@
+import { defaultSerializeError } from './router';
 export type DeferredPromiseState<T> = {
     uid: string;
 } & ({
@@ -15,5 +16,7 @@ export type DeferredPromiseState<T> = {
 export type DeferredPromise<T> = Promise<T> & {
     __deferredState: DeferredPromiseState<T>;
 };
-export declare function defer<T>(_promise: Promise<T>): DeferredPromise<T>;
+export declare function defer<T>(_promise: Promise<T>, options?: {
+    serializeError?: typeof defaultSerializeError;
+}): DeferredPromise<T>;
 export declare function isDehydratedDeferred(obj: any): boolean;

package/build/types/router.d.ts

@@ -32,7 +32,7 @@ export type RouterContextOptions<TRouteTree extends AnyRoute> = AnyContext exten
 } : {
     context: TRouteTree['types']['routerContext'];
 };
-export interface RouterOptions<TRouteTree extends AnyRoute, TDehydrated extends Record<string, any> = Record<string, any>> {
+export interface RouterOptions<TRouteTree extends AnyRoute, TDehydrated extends Record<string, any> = Record<string, any>, TSerializedError extends Record<string, any> = Record<string, any>> {
     history?: RouterHistory;
     stringifySearch?: SearchSerializer;
     parseSearch?: SearchParser;
@@ -62,6 +62,11 @@ export interface RouterOptions<TRouteTree extends AnyRoute, TDehydrated extends
         children: any;
     }) => JSX.Element;
     notFoundRoute?: AnyRoute;
+    errorSerializer?: RouterErrorSerializer<TSerializedError>;
+}
+export interface RouterErrorSerializer<TSerializedError> {
+    serialize: (err: unknown) => TSerializedError;
+    deserialize: (err: TSerializedError) => unknown;
 }
 export interface RouterState<TRouteTree extends AnyRoute = AnyRoute> {
     status: 'pending' | 'idle';
@@ -98,7 +103,7 @@ export type DehydratedRouteMatch = Pick<RouteMatch, 'id' | 'status' | 'updatedAt
 export interface DehydratedRouter {
     state: DehydratedRouterState;
 }
-export type RouterConstructorOptions<TRouteTree extends AnyRoute, TDehydrated extends Record<string, any>> = Omit<RouterOptions<TRouteTree, TDehydrated>, 'context'> & RouterContextOptions<TRouteTree>;
+export type RouterConstructorOptions<TRouteTree extends AnyRoute, TDehydrated extends Record<string, any>, TSerializedError extends Record<string, any>> = Omit<RouterOptions<TRouteTree, TDehydrated, TSerializedError>, 'context'> & RouterContextOptions<TRouteTree>;
 export declare const componentTypes: readonly ["component", "errorComponent", "pendingComponent"];
 export type RouterEvents = {
     onBeforeLoad: {
@@ -125,7 +130,7 @@ export type RouterListener<TRouterEvent extends RouterEvent> = {
     eventType: TRouterEvent['type'];
     fn: ListenerFn<TRouterEvent>;
 };
-export declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated extends Record<string, any> = Record<string, any>> {
+export declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated extends Record<string, any> = Record<string, any>, TSerializedError extends Record<string, any> = Record<string, any>> {
     tempLocationKey: string | undefined;
     resetNextScroll: boolean;
     navigateTimeout: Timeout | null;
@@ -134,7 +139,7 @@ export declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated
     injectedHtml: InjectedHtmlEntry[];
     dehydratedData?: TDehydrated;
     __store: Store<RouterState<TRouteTree>>;
-    options: PickAsRequired<RouterOptions<TRouteTree, TDehydrated>, 'stringifySearch' | 'parseSearch' | 'context'>;
+    options: PickAsRequired<RouterOptions<TRouteTree, TDehydrated, TSerializedError>, 'stringifySearch' | 'parseSearch' | 'context'>;
     history: RouterHistory;
     latestLocation: ParsedLocation;
     basepath: string;
@@ -142,9 +147,9 @@ export declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated
     routesById: RoutesById<TRouteTree>;
     routesByPath: RoutesByPath<TRouteTree>;
     flatRoutes: AnyRoute[];
-    constructor(options: RouterConstructorOptions<TRouteTree, TDehydrated>);
+    constructor(options: RouterConstructorOptions<TRouteTree, TDehydrated, TSerializedError>);
     startReactTransition: (fn: () => void) => void;
-    update: (newOptions: RouterConstructorOptions<TRouteTree, TDehydrated>) => void;
+    update: (newOptions: RouterConstructorOptions<TRouteTree, TDehydrated, TSerializedError>) => void;
     get state(): RouterState<TRouteTree>;
     buildRouteTree: () => void;
     subscribe: <TType extends keyof RouterEvents>(eventType: TType, fn: ListenerFn<RouterEvents[TType]>) => () => void;
@@ -185,3 +190,12 @@ export declare class SearchParamError extends Error {
 export declare class PathParamError extends Error {
 }
 export declare function getInitialRouterState(location: ParsedLocation): RouterState<any>;
+export declare function defaultSerializeError(err: unknown): {
+    name: string;
+    message: string;
+    data?: undefined;
+} | {
+    data: unknown;
+    name?: undefined;
+    message?: undefined;
+};

package/build/types/routerContext.d.ts

@@ -1,3 +1,3 @@
 import * as React from 'react';
 import { Router } from './router';
-export declare let routerContext: React.Context<Router<any, Record<string, any>>>;
+export declare let routerContext: React.Context<Router<any, Record<string, any>, Record<string, any>>>;