@tanstack/router-core 1.132.0-alpha.1 → 1.132.0-alpha.3

package/dist/esm/router.d.ts

@@ -1,4 +1,5 @@
 import { Store } from '@tanstack/store';
+import { loadRouteChunk } from './load-matches.js';
 import { ParsePathnameCache } from './path.js';
 import { SearchParser, SearchSerializer } from './searchParams.js';
 import { AnyRedirect, ResolvedRedirect } from './redirect.js';
@@ -7,12 +8,11 @@ import { Awaitable, ControlledPromise, NoInfer, NonNullableUpdater, PickAsRequir
 import { ParsedLocation } from './location.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 { AnyRouteMatch, MakeRouteMatchUnion, MatchRouteOptions } from './Matches.js';
 import { BuildLocationFn, CommitLocationOptions, NavigateFn } from './RouterProvider.js';
 import { Manifest } from './manifest.js';
 import { AnySchema } from './validators.js';
 import { NavigateOptions, ResolveRelativePath, ToOptions } from './link.js';
-import { NotFoundError } from './not-found.js';
 export type ControllablePromise<T = any> = Promise<T> & {
     resolve: (value: T) => void;
     reject: (value?: any) => void;
@@ -29,7 +29,7 @@ export interface DefaultRouterOptionsExtensions {
 }
 export interface RouterOptionsExtensions extends DefaultRouterOptionsExtensions {
 }
-export interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean = false, TRouterHistory extends RouterHistory = RouterHistory, TDehydrated extends Record<string, any> = Record<string, any>> extends RouterOptionsExtensions {
+export interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean = false, TRouterHistory extends RouterHistory = RouterHistory, TDehydrated extends Record<string, any> = Record<string, any>, TTransformerConfig = any> extends RouterOptionsExtensions {
     /**
      * The history object that will be used to manage the browser history.
      *
@@ -320,6 +320,7 @@ export interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption
      * @default false
      */
     disableGlobalCatchBoundary?: boolean;
+    serializationAdapters?: TTransformerConfig;
 }
 export interface RouterState<in out TRouteTree extends AnyRoute = AnyRoute, in out TRouteMatch = MakeRouteMatchUnion> {
     status: 'pending' | 'idle';
@@ -400,10 +401,10 @@ 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 type RouterConstructorOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory, TDehydrated extends Record<string, any>, TTransformerConfig> = Omit<RouterOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated, TTransformerConfig>, 'context'> & RouterContextOptions<TRouteTree>;
 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;
+export type UpdateFn<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory, TDehydrated extends Record<string, any>, TTransformerConfig extends any> = (newOptions: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated, TTransformerConfig>) => void;
 export type InvalidateFn<TRouter extends AnyRouter> = (opts?: {
     filter?: (d: MakeRouteMatchUnion<TRouter>) => boolean;
     sync?: boolean;
@@ -446,8 +447,8 @@ export interface ServerSsr {
     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>;
+export type AnyRouterWithContext<TContext> = RouterCore<AnyRouteWithContext<TContext>, any, any, any, any, any>;
+export type AnyRouter = RouterCore<any, any, any, any, any, any>;
 export interface ViewTransitionOptions {
     types: Array<string> | ((locationChangeInfo: {
         fromLocation?: ParsedLocation;
@@ -474,8 +475,8 @@ export declare function getLocationChangeInfo(routerState: {
     hrefChanged: boolean;
     hashChanged: boolean;
 };
-export type CreateRouterFn = <TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption = 'never', TDefaultStructuralSharingOption extends boolean = false, TRouterHistory extends RouterHistory = RouterHistory, TDehydrated extends Record<string, any> = Record<string, any>>(options: undefined extends number ? 'strictNullChecks must be enabled in tsconfig.json' : RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>) => RouterCore<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>;
-export declare class RouterCore<in out TRouteTree extends AnyRoute, in out TTrailingSlashOption extends TrailingSlashOption, in out TDefaultStructuralSharingOption extends boolean, in out TRouterHistory extends RouterHistory = RouterHistory, in out TDehydrated extends Record<string, any> = Record<string, any>> {
+export type CreateRouterFn = <TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption = 'never', TDefaultStructuralSharingOption extends boolean = false, TRouterHistory extends RouterHistory = RouterHistory, TDehydrated extends Record<string, any> = Record<string, any>, TTransformerConfig = any>(options: undefined extends number ? 'strictNullChecks must be enabled in tsconfig.json' : RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated, TTransformerConfig>) => RouterCore<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated, TTransformerConfig>;
+export declare class RouterCore<in out TRouteTree extends AnyRoute, in out TTrailingSlashOption extends TrailingSlashOption, in out TDefaultStructuralSharingOption extends boolean, in out TRouterHistory extends RouterHistory = RouterHistory, in out TDehydrated extends Record<string, any> = Record<string, any>, in out TTransformerConfig = any> {
     tempLocationKey: string | undefined;
     resetNextScroll: boolean;
     shouldViewTransition?: boolean | ViewTransitionOptions;
@@ -485,7 +486,7 @@ export declare class RouterCore<in out TRouteTree extends AnyRoute, in out TTrai
     isScrollRestoring: boolean;
     isScrollRestorationSetup: boolean;
     __store: Store<RouterState<TRouteTree>>;
-    options: PickAsRequired<RouterOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>, 'stringifySearch' | 'parseSearch' | 'context'>;
+    options: PickAsRequired<RouterOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated, TTransformerConfig>, 'stringifySearch' | 'parseSearch' | 'context'>;
     history: TRouterHistory;
     latestLocation: ParsedLocation<FullSearchSchema<TRouteTree>>;
     basepath: string;
@@ -498,11 +499,11 @@ export declare class RouterCore<in out TRouteTree extends AnyRoute, in out TTrai
     /**
      * @deprecated Use the `createRouter` function instead
      */
-    constructor(options: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>);
+    constructor(options: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated, TTransformerConfig>);
     startTransition: StartTransitionFn;
     isShell(): boolean;
     isPrerendering(): boolean;
-    update: UpdateFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>;
+    update: UpdateFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated, TTransformerConfig>;
     get state(): RouterState<TRouteTree, import('./Matches.js').RouteMatch<any, any, any, any, any, any, any>>;
     buildRouteTree: () => void;
     subscribe: SubscribeFn;
@@ -528,29 +529,17 @@ export declare class RouterCore<in out TRouteTree extends AnyRoute, in out TTrai
     startViewTransition: (fn: () => Promise<void>) => void;
     updateMatch: UpdateMatchFn;
     getMatch: GetMatchFn;
-    loadMatches: ({ location, matches, preload: allPreload, onReady, updateMatch, sync, }: {
-        location: ParsedLocation;
-        matches: Array<AnyRouteMatch>;
-        preload?: boolean;
-        onReady?: () => Promise<void>;
-        updateMatch?: (id: string, updater: (match: AnyRouteMatch) => AnyRouteMatch) => void;
-        getMatch?: (matchId: string) => AnyRouteMatch | undefined;
-        sync?: boolean;
-    }) => Promise<Array<MakeRouteMatch>>;
     invalidate: InvalidateFn<RouterCore<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>>;
     resolveRedirect: (redirect: AnyRedirect) => AnyRedirect;
     clearCache: ClearCacheFn<this>;
     clearExpiredCache: () => void;
-    loadRouteChunk: (route: AnyRoute) => Promise<void[]>;
+    loadRouteChunk: typeof loadRouteChunk;
     preloadRoute: PreloadRouteFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory>;
     matchRoute: MatchRouteFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory>;
     ssr?: {
         manifest: Manifest | undefined;
     };
     serverSsr?: ServerSsr;
-    _handleNotFound: (matches: Array<AnyRouteMatch>, err: NotFoundError, { updateMatch, }?: {
-        updateMatch?: (id: string, updater: (match: AnyRouteMatch) => AnyRouteMatch) => void;
-    }) => void;
     hasNotFoundMatch: () => boolean;
 }
 export declare class SearchParamError extends Error {
@@ -559,7 +548,6 @@ export declare class PathParamError extends Error {
 }
 export declare function lazyFn<T extends Record<string, (...args: Array<any>) => any>, TKey extends keyof T = 'default'>(fn: () => Promise<T>, key?: TKey): (...args: Parameters<T[TKey]>) => Promise<Awaited<ReturnType<T[TKey]>>>;
 export declare function getInitialRouterState(location: ParsedLocation): RouterState<any>;
-export declare const componentTypes: readonly ["component", "errorComponent", "pendingComponent", "notFoundComponent"];
 interface RouteLike {
     id: string;
     isRoot?: boolean;