@tanstack/router-core 1.114.23 → 1.114.25

package/dist/esm/router.d.ts

@@ -1,18 +1,19 @@
+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 { ParsedLocation } from './location.js';
 import { DeferredPromiseState } from './defer.js';
-import { ControlledPromise, NoInfer, NonNullableUpdater, Updater } from './utils.js';
 import { AnyContext, AnyRoute, AnyRouteWithContext, MakeRemountDepsOptionsUnion, RouteMask } from './route.js';
-import { Store } from '@tanstack/store';
 import { FullSearchSchema, RouteById, RoutePaths, RoutesById, RoutesByPath } from './routeInfo.js';
-import { AnyRouteMatch, MakeRouteMatchUnion, MatchRouteOptions } from './Matches.js';
-import { AnyRedirect, ResolvedRedirect } from './redirect.js';
+import { AnyRouteMatch, MakeRouteMatch, MakeRouteMatchUnion, MatchRouteOptions } from './Matches.js';
 import { BuildLocationFn, CommitLocationOptions, NavigateFn } from './RouterProvider.js';
-import { HistoryLocation, HistoryState, ParsedHistoryState, RouterHistory } from '@tanstack/history';
 import { Manifest } from './manifest.js';
 import { StartSerializer } from './serializer.js';
 import { AnySchema } from './validators.js';
 import { NavigateOptions, ResolveRelativePath, ToOptions } from './link.js';
-import { SearchParser, SearchSerializer } from './searchParams.js';
+import { NotFoundError } from './not-found.js';
 declare global {
     interface Window {
         __TSR_ROUTER__?: AnyRouter;
@@ -385,8 +386,8 @@ export interface MatchedRoutesResult {
     matchedRoutes: Array<AnyRoute>;
     routeParams: Record<string, string>;
 }
-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<Router<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<Router<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory>, TFrom, TTo>, opts?: MatchRouteOptions) => false | RouteById<TRouteTree, TResolved>['types']['allParams'];
+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 InvalidateFn<TRouter extends AnyRouter> = (opts?: {
     filter?: (d: MakeRouteMatchUnion<TRouter>) => boolean;
@@ -430,53 +431,8 @@ export interface ServerSrr {
         match: AnyRouteMatch;
     }) => any;
 }
-export interface Router<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>> {
-    routeTree: TRouteTree;
-    options: RouterOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>;
-    __store: Store<RouterState<TRouteTree>>;
-    navigate: NavigateFn;
-    history: TRouterHistory;
-    state: RouterState<TRouteTree>;
-    isServer: boolean;
-    clientSsr?: {
-        getStreamedValue: <T>(key: string) => T | undefined;
-    };
-    looseRoutesById: Record<string, AnyRoute>;
-    latestLocation: ParsedLocation<FullSearchSchema<TRouteTree>>;
-    isScrollRestoring: boolean;
-    resetNextScroll: boolean;
-    isScrollRestorationSetup: boolean;
-    ssr?: {
-        manifest: Manifest | undefined;
-        serializer: StartSerializer;
-    };
-    serverSsr?: ServerSrr;
-    basepath: string;
-    routesById: RoutesById<TRouteTree>;
-    routesByPath: RoutesByPath<TRouteTree>;
-    flatRoutes: Array<AnyRoute>;
-    parseLocation: ParseLocationFn<TRouteTree>;
-    getMatchedRoutes: GetMatchRoutesFn;
-    emit: EmitFn;
-    load: LoadFn;
-    commitLocation: CommitLocationFn;
-    buildLocation: BuildLocationFn;
-    startTransition: StartTransitionFn;
-    subscribe: SubscribeFn;
-    matchRoutes: MatchRoutesFn;
-    preloadRoute: PreloadRouteFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory>;
-    getMatch: GetMatchFn;
-    updateMatch: UpdateMatchFn;
-    matchRoute: MatchRouteFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory>;
-    update: UpdateFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>;
-    invalidate: InvalidateFn<Router<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>>;
-    loadRouteChunk: LoadRouteChunkFn;
-    resolveRedirect: ResolveRedirect;
-    buildRouteTree: () => void;
-    clearCache: ClearCacheFn<Router<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>>;
-}
-export type AnyRouterWithContext<TContext> = Router<AnyRouteWithContext<TContext>, any, any, any, any>;
-export type AnyRouter = Router<any, any, any, any, any>;
+export type AnyRouterWithContext<TContext> = RouterCore<AnyRouteWithContext<TContext>, any, any, any, any>;
+export type AnyRouter = RouterCore<any, any, any, any, any>;
 export interface ViewTransitionOptions {
     types: Array<string>;
 }
@@ -516,4 +472,110 @@ 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>> {
+    tempLocationKey: string | undefined;
+    resetNextScroll: boolean;
+    shouldViewTransition?: boolean | ViewTransitionOptions;
+    isViewTransitionTypesSupported?: boolean;
+    subscribers: Set<RouterListener<RouterEvent>>;
+    viewTransitionPromise?: ControlledPromise<true>;
+    isScrollRestoring: boolean;
+    isScrollRestorationSetup: boolean;
+    __store: Store<RouterState<TRouteTree>>;
+    options: PickAsRequired<RouterOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>, 'stringifySearch' | 'parseSearch' | 'context'>;
+    history: TRouterHistory;
+    latestLocation: ParsedLocation<FullSearchSchema<TRouteTree>>;
+    basepath: string;
+    routeTree: TRouteTree;
+    routesById: RoutesById<TRouteTree>;
+    routesByPath: RoutesByPath<TRouteTree>;
+    flatRoutes: Array<AnyRoute>;
+    isServer: boolean;
+    pathParamsDecodeCharMap?: Map<string, string>;
+    /**
+     * @deprecated Use the `createRouter` function instead
+     */
+    constructor(options: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>);
+    startTransition: StartTransitionFn;
+    update: UpdateFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>;
+    get state(): RouterState<TRouteTree, import('./Matches.js').RouteMatch<any, any, any, any, any, any, any>>;
+    buildRouteTree: () => void;
+    subscribe: SubscribeFn;
+    emit: EmitFn;
+    parseLocation: ParseLocationFn<TRouteTree>;
+    resolvePathWithBase: (from: string, path: string) => string;
+    get looseRoutesById(): Record<string, AnyRoute>;
+    /**
+    @deprecated use the following signature instead
+    ```ts
+    matchRoutes (
+      next: ParsedLocation,
+      opts?: { preload?: boolean; throwOnError?: boolean },
+    ): Array<AnyRouteMatch>;
+    ```
+  */
+    matchRoutes: MatchRoutesFn;
+    private matchRoutesInternal;
+    getMatchedRoutes: GetMatchRoutesFn;
+    cancelMatch: (id: string) => void;
+    cancelMatches: () => void;
+    buildLocation: BuildLocationFn;
+    commitLocationPromise: undefined | ControlledPromise<void>;
+    commitLocation: CommitLocationFn;
+    buildAndCommitLocation: ({ replace, resetScroll, hashScrollIntoView, viewTransition, ignoreBlocker, href, ...rest }?: BuildNextOptions & CommitLocationOptions) => Promise<void>;
+    navigate: NavigateFn;
+    latestLoadPromise: undefined | Promise<void>;
+    load: LoadFn;
+    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: (err: AnyRedirect) => ResolvedRedirect;
+    clearCache: ClearCacheFn<this>;
+    clearExpiredCache: () => void;
+    loadRouteChunk: (route: AnyRoute) => Promise<void[]>;
+    preloadRoute: PreloadRouteFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory>;
+    matchRoute: MatchRouteFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory>;
+    ssr?: {
+        manifest: Manifest | undefined;
+        serializer: StartSerializer;
+    };
+    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;
+    };
+    _handleNotFound: (matches: Array<AnyRouteMatch>, err: NotFoundError, { updateMatch, }?: {
+        updateMatch?: (id: string, updater: (match: AnyRouteMatch) => AnyRouteMatch) => void;
+    }) => void;
+    hasNotFoundMatch: () => boolean;
+}
+export declare class SearchParamError extends Error {
+}
+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"];
 export {};