@tanstack/solid-router 1.112.10 → 1.112.12

package/dist/cjs/router.d.cts

@@ -1,434 +1,77 @@
-import { Store, NoInfer } from '@tanstack/solid-store';
-import { HistoryLocation, HistoryState, ParsedHistoryState, RouterHistory } from '@tanstack/history';
-import { AnyContext, AnyRedirect, AnyRouteMatch, AnySchema, BuildLocationFn, CommitLocationOptions, ControlledPromise, FullSearchSchema, MakeRemountDepsOptionsUnion, MakeRouteMatch, MakeRouteMatchUnion, Manifest, NavigateFn, NavigateOptions, NonNullableUpdater, ParsedLocation, PickAsRequired, Register, ResolveRelativePath, ResolvedRedirect, RouteById, RoutePaths, RoutesById, RoutesByPath, SearchParser, SearchSerializer, StartSerializer, ToOptions, TrailingSlashOption, Updater, ViewTransitionOptions } from '@tanstack/router-core';
-import { AnyRoute, ErrorRouteComponent, NotFoundRouteComponent, RootRoute, RouteComponent, RouteMask } from './route.cjs';
-import { MatchRouteOptions } from './Matches.cjs';
+import { Store } from '@tanstack/solid-store';
+import { RouterHistory } from '@tanstack/history';
+import { AnyRedirect, AnyRoute, AnyRouteMatch, AnyRouter, BuildLocationFn, BuildNextOptions, ClearCacheFn, CommitLocationFn, CommitLocationOptions, ControlledPromise, Router as CoreRouter, EmitFn, FullSearchSchema, GetMatchFn, GetMatchRoutesFn, InjectedHtmlEntry, InvalidateFn, LoadFn, MakeRouteMatch, Manifest, MatchRouteFn, MatchRoutesFn, NavigateFn, ParseLocationFn, ParsedLocation, PickAsRequired, PreloadRouteFn, ResolvedRedirect, RouterConstructorOptions, RouterEvent, RouterListener, RouterOptions, RouterState, RoutesById, RoutesByPath, StartSerializer, StartTransitionFn, SubscribeFn, TrailingSlashOption, UpdateFn, UpdateMatchFn, ViewTransitionOptions } from '@tanstack/router-core';
+import { ErrorRouteComponent, NotFoundRouteComponent, RouteComponent } from './route.cjs';
 import { NotFoundError } from './not-found.cjs';
 import type * as Solid from 'solid-js';
-declare global {
-    interface Window {
-        __TSR_ROUTER__?: AnyRouter;
-    }
-}
-export type AnyRouter = Router<any, any, any, any, any>;
-export type RegisteredRouter = Register extends {
-    router: infer TRouter extends AnyRouter;
-} ? TRouter : AnyRouter;
-export type InferRouterContext<TRouteTree extends AnyRoute> = TRouteTree extends RootRoute<any, infer TRouterContext extends AnyContext, any, any, any, any, any, any> ? TRouterContext : AnyContext;
-export type ControllablePromise<T = any> = Promise<T> & {
-    resolve: (value: T) => void;
-    reject: (value?: any) => void;
-};
-export type RouterContextOptions<TRouteTree extends AnyRoute> = AnyContext extends InferRouterContext<TRouteTree> ? {
-    context?: InferRouterContext<TRouteTree>;
-} : {
-    context: InferRouterContext<TRouteTree>;
-};
-export type InjectedHtmlEntry = Promise<string>;
-export interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TRouterHistory extends RouterHistory = RouterHistory, TDehydrated extends Record<string, any> = Record<string, any>> {
-    /**
-     * The history object that will be used to manage the browser history.
-     *
-     * If not provided, a new createBrowserHistory instance will be created and used.
-     *
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#history-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/history-types)
-     */
-    history?: TRouterHistory;
-    /**
-     * A function that will be used to stringify search params when generating links.
-     *
-     * @default defaultStringifySearch
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#stringifysearch-method)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/custom-search-param-serialization)
-     */
-    stringifySearch?: SearchSerializer;
-    /**
-     * A function that will be used to parse search params when parsing the current location.
-     *
-     * @default defaultParseSearch
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#parsesearch-method)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/custom-search-param-serialization)
-     */
-    parseSearch?: SearchParser;
-    /**
-     * If `false`, routes will not be preloaded by default in any way.
-     *
-     * If `'intent'`, routes will be preloaded by default when the user hovers over a link or a `touchstart` event is detected on a `<Link>`.
-     *
-     * If `'viewport'`, routes will be preloaded by default when they are within the viewport.
-     *
-     * @default false
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultpreload-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/preloading)
-     */
-    defaultPreload?: false | 'intent' | 'viewport' | 'render';
-    /**
-     * The delay in milliseconds that a route must be hovered over or touched before it is preloaded.
-     *
-     * @default 50
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultpreloaddelay-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/preloading#preload-delay)
-     */
-    defaultPreloadDelay?: number;
-    /**
-     * The default `component` a route should use if no component is provided.
-     *
-     * @default Outlet
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultcomponent-property)
-     */
-    defaultComponent?: RouteComponent;
-    /**
-     * The default `errorComponent` a route should use if no error component is provided.
-     *
-     * @default ErrorComponent
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaulterrorcomponent-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#handling-errors-with-routeoptionserrorcomponent)
-     */
-    defaultErrorComponent?: ErrorRouteComponent;
-    /**
-     * The default `pendingComponent` a route should use if no pending component is provided.
-     *
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultpendingcomponent-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#showing-a-pending-component)
-     */
-    defaultPendingComponent?: RouteComponent;
-    /**
-     * The default `pendingMs` a route should use if no pendingMs is provided.
-     *
-     * @default 1000
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultpendingms-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#avoiding-pending-component-flash)
-     */
-    defaultPendingMs?: number;
-    /**
-     * The default `pendingMinMs` a route should use if no pendingMinMs is provided.
-     *
-     * @default 500
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultpendingminms-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#avoiding-pending-component-flash)
-     */
-    defaultPendingMinMs?: number;
-    /**
-     * The default `staleTime` a route should use if no staleTime is provided. This is the time in milliseconds that a route will be considered fresh.
-     *
-     * @default 0
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultstaletime-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#key-options)
-     */
-    defaultStaleTime?: number;
-    /**
-     * The default `preloadStaleTime` a route should use if no preloadStaleTime is provided.
-     *
-     * @default 30_000 `(30 seconds)`
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultpreloadstaletime-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/preloading)
-     */
-    defaultPreloadStaleTime?: number;
-    /**
-     * The default `defaultPreloadGcTime` a route should use if no preloadGcTime is provided.
-     *
-     * @default 1_800_000 `(30 minutes)`
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultpreloadgctime-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/preloading)
-     */
-    defaultPreloadGcTime?: number;
-    /**
-     * The default `onCatch` handler for errors caught by the Router ErrorBoundary
-     *
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultoncatch-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#handling-errors-with-routeoptionsoncatch)
-     */
-    defaultOnCatch?: (error: Error) => void;
-    /**
-     * If `true`, route navigations will called using `document.startViewTransition()`.
-     *
-     * If the browser does not support this api, this option will be ignored.
-     *
-     * See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document/startViewTransition) for more information on how this function works.
-     *
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultviewtransition-property)
-     */
-    defaultViewTransition?: boolean | ViewTransitionOptions;
-    /**
-     * The default `hashScrollIntoView` a route should use if no hashScrollIntoView is provided while navigating
-     *
-     * See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView) for more information on `ScrollIntoViewOptions`.
-     *
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaulthashscrollintoview-property)
-     */
-    defaultHashScrollIntoView?: boolean | ScrollIntoViewOptions;
-    /**
-     * @default 'fuzzy'
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#notfoundmode-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/not-found-errors#the-notfoundmode-option)
-     */
-    notFoundMode?: 'root' | 'fuzzy';
-    /**
-     * The default `gcTime` a route should use if no gcTime is provided.
-     *
-     * @default 1_800_000 `(30 minutes)`
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultgctime-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#key-options)
-     */
-    defaultGcTime?: number;
-    /**
-     * If `true`, all routes will be matched as case-sensitive.
-     *
-     * @default false
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#casesensitive-property)
-     */
-    caseSensitive?: boolean;
-    /**
-     *
-     * The route tree that will be used to configure the router instance.
-     *
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#routetree-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/routing/route-trees)
-     */
-    routeTree?: TRouteTree;
-    /**
-     * The basepath for then entire router. This is useful for mounting a router instance at a subpath.
-     *
-     * @default '/'
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#basepath-property)
-     */
-    basepath?: string;
-    /**
-     * The root context that will be provided to all routes in the route tree.
-     *
-     * This can be used to provide a context to all routes in the tree without having to provide it to each route individually.
-     *
-     * Optional or required if the root route was created with [`createRootRouteWithContext()`](https://tanstack.com/router/latest/docs/framework/react/api/router/createRootRouteWithContextFunction).
-     *
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#context-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/router-context)
-     */
-    context?: InferRouterContext<TRouteTree>;
-    /**
-     * A function that will be called when the router is dehydrated.
-     *
-     * The return value of this function will be serialized and stored in the router's dehydrated state.
-     *
-     * @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;
-    /**
-     * A function that will be called when the router is hydrated.
-     *
-     * The return value of this function will be serialized and stored in the router's dehydrated state.
-     *
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#hydrate-method)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/external-data-loading#critical-dehydrationhydration)
-     */
-    hydrate?: (dehydrated: TDehydrated) => void;
-    /**
-     * An array of route masks that will be used to mask routes in the route tree.
-     *
-     * Route masking is when you display a route at a different path than the one it is configured to match, like a modal popup that when shared will unmask to the modal's content instead of the modal's context.
-     *
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#routemasks-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/route-masking)
-     */
-    routeMasks?: Array<RouteMask<TRouteTree>>;
-    /**
-     * If `true`, route masks will, by default, be removed when the page is reloaded.
-     *
-     * This can be overridden on a per-mask basis by setting the `unmaskOnReload` option on the mask, or on a per-navigation basis by setting the `unmaskOnReload` option in the `Navigate` options.
-     *
-     * @default false
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#unmaskonreload-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/route-masking#unmasking-on-page-reload)
-     */
-    unmaskOnReload?: boolean;
-    /**
-     * A component that will be used to wrap the entire router.
-     *
-     * This is useful for providing a context to the entire router.
-     *
-     * Only non-DOM-rendering components like providers should be used, anything else will cause a hydration error.
-     *
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#wrap-property)
-     */
-    Wrap?: (props: {
-        children: any;
-    }) => Solid.JSX.Element;
-    /**
-     * A component that will be used to wrap the inner contents of the router.
-     *
-     * This is useful for providing a context to the inner contents of the router where you also need access to the router context and hooks.
-     *
-     * Only non-DOM-rendering components like providers should be used, anything else will cause a hydration error.
-     *
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#innerwrap-property)
-     */
-    InnerWrap?: (props: {
-        children: any;
-    }) => Solid.JSX.Element;
-    /**
-     * Use `notFoundComponent` instead.
-     *
-     * @deprecated
-     * See https://tanstack.com/router/v1/docs/guide/not-found-errors#migrating-from-notfoundroute for more info.
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#notfoundroute-property)
-     */
-    notFoundRoute?: AnyRoute;
-    /**
-     * The default `notFoundComponent` a route should use if no notFound component is provided.
-     *
-     * @default NotFound
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultnotfoundcomponent-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/not-found-errors#default-router-wide-not-found-handling)
-     */
-    defaultNotFoundComponent?: NotFoundRouteComponent;
-    /**
-     * Configures how trailing slashes are treated.
-     *
-     * - `'always'` will add a trailing slash if not present
-     * - `'never'` will remove the trailing slash if present
-     * - `'preserve'` will not modify the trailing slash.
-     *
-     * @default 'never'
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#trailingslash-property)
-     */
-    trailingSlash?: TTrailingSlashOption;
-    /**
-     * While usually automatic, sometimes it can be useful to force the router into a server-side state, e.g. when using the router in a non-browser environment that has access to a global.document object.
-     *
-     * @default typeof document !== 'undefined'
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#isserver-property)
-     */
-    isServer?: boolean;
-    defaultSsr?: boolean;
-    search?: {
+declare module '@tanstack/router-core' {
+    interface RouterOptionsExtensions {
         /**
-         * Configures how unknown search params (= not returned by any `validateSearch`) are treated.
+         * A component that will be used to wrap the entire router.
          *
-         * @default false
-         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#search.strict-property)
+         * This is useful for providing a context to the entire router.
+         *
+         * Only non-DOM-rendering components like providers should be used, anything else will cause a hydration error.
+         *
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#wrap-property)
          */
-        strict?: boolean;
-    };
-    /**
-     * Configures which URI characters are allowed in path params that would ordinarily be escaped by encodeURIComponent.
-     *
-     * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#pathparamsallowedcharacters-property)
-     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/path-params#allowed-characters)
-     */
-    pathParamsAllowedCharacters?: Array<';' | ':' | '@' | '&' | '=' | '+' | '$' | ','>;
-    defaultRemountDeps?: (opts: MakeRemountDepsOptionsUnion<TRouteTree>) => any;
-    /**
-     * If `true`, scroll restoration will be enabled
-     *
-     * @default false
-     */
-    scrollRestoration?: boolean;
-    /**
-     * A function that will be called to get the key for the scroll restoration cache.
-     *
-     * @default (location) => location.href
-     */
-    getScrollRestorationKey?: (location: ParsedLocation) => string;
-    /**
-     * The default behavior for scroll restoration.
-     *
-     * @default 'auto'
-     */
-    scrollRestorationBehavior?: ScrollBehavior;
-    /**
-     * An array of selectors that will be used to scroll to the top of the page in addition to `window`
-     *
-     * @default ['window']
-     */
-    scrollToTopSelectors?: Array<string>;
-}
-export interface RouterErrorSerializer<TSerializedError> {
-    serialize: (err: unknown) => TSerializedError;
-    deserialize: (err: TSerializedError) => unknown;
-}
-export interface RouterState<TRouteTree extends AnyRoute = AnyRoute, TRouteMatch = MakeRouteMatchUnion> {
-    status: 'pending' | 'idle';
-    loadedAt: number;
-    isLoading: boolean;
-    isTransitioning: boolean;
-    matches: Array<TRouteMatch>;
-    pendingMatches?: Array<TRouteMatch>;
-    cachedMatches: Array<TRouteMatch>;
-    location: ParsedLocation<FullSearchSchema<TRouteTree>>;
-    resolvedLocation?: ParsedLocation<FullSearchSchema<TRouteTree>>;
-    statusCode: number;
-    redirect?: ResolvedRedirect;
-}
-export type ListenerFn<TEvent extends RouterEvent> = (event: TEvent) => void;
-export interface BuildNextOptions {
-    to?: string | number | null;
-    params?: true | Updater<unknown>;
-    search?: true | Updater<unknown>;
-    hash?: true | Updater<string>;
-    state?: true | NonNullableUpdater<ParsedHistoryState, HistoryState>;
-    mask?: {
-        to?: string | number | null;
-        params?: true | Updater<unknown>;
-        search?: true | Updater<unknown>;
-        hash?: true | Updater<string>;
-        state?: true | NonNullableUpdater<ParsedHistoryState, HistoryState>;
-        unmaskOnReload?: boolean;
-    };
-    from?: string;
-    _fromLocation?: ParsedLocation;
-    href?: string;
-}
-export interface MatchedRoutesResult {
-    matchedRoutes: Array<AnyRoute>;
-    routeParams: Record<string, string>;
+        Wrap?: (props: {
+            children: any;
+        }) => Solid.JSX.Element;
+        /**
+         * A component that will be used to wrap the inner contents of the router.
+         *
+         * This is useful for providing a context to the inner contents of the router where you also need access to the router context and hooks.
+         *
+         * Only non-DOM-rendering components like providers should be used, anything else will cause a hydration error.
+         *
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#innerwrap-property)
+         */
+        InnerWrap?: (props: {
+            children: any;
+        }) => Solid.JSX.Element;
+        /**
+         * The default `component` a route should use if no component is provided.
+         *
+         * @default Outlet
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultcomponent-property)
+         */
+        defaultComponent?: RouteComponent;
+        /**
+         * The default `errorComponent` a route should use if no error component is provided.
+         *
+         * @default ErrorComponent
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaulterrorcomponent-property)
+         * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#handling-errors-with-routeoptionserrorcomponent)
+         */
+        defaultErrorComponent?: ErrorRouteComponent;
+        /**
+         * The default `pendingComponent` a route should use if no pending component is provided.
+         *
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultpendingcomponent-property)
+         * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#showing-a-pending-component)
+         */
+        defaultPendingComponent?: RouteComponent;
+        /**
+         * The default `notFoundComponent` a route should use if no notFound component is provided.
+         *
+         * @default NotFound
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultnotfoundcomponent-property)
+         * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/not-found-errors#default-router-wide-not-found-handling)
+         */
+        defaultNotFoundComponent?: NotFoundRouteComponent;
+        /**
+         * The default `onCatch` handler for errors caught by the Router ErrorBoundary
+         *
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultoncatch-property)
+         * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#handling-errors-with-routeoptionsoncatch)
+         */
+        defaultOnCatch?: (error: Error) => void;
+    }
 }
-export type RouterConstructorOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TRouterHistory extends RouterHistory, TDehydrated extends Record<string, any>> = Omit<RouterOptions<TRouteTree, TTrailingSlashOption, TRouterHistory, TDehydrated>, 'context'> & RouterContextOptions<TRouteTree>;
 export declare const componentTypes: readonly ["component", "errorComponent", "pendingComponent", "notFoundComponent"];
-type NavigationEventInfo = {
-    fromLocation?: ParsedLocation;
-    toLocation: ParsedLocation;
-    pathChanged: boolean;
-    hrefChanged: boolean;
-    hashChanged: boolean;
-};
-export type RouterEvents = {
-    onBeforeNavigate: {
-        type: 'onBeforeNavigate';
-    } & NavigationEventInfo;
-    onBeforeLoad: {
-        type: 'onBeforeLoad';
-    } & NavigationEventInfo;
-    onLoad: {
-        type: 'onLoad';
-    } & NavigationEventInfo;
-    onResolved: {
-        type: 'onResolved';
-    } & NavigationEventInfo;
-    onBeforeRouteMount: {
-        type: 'onBeforeRouteMount';
-    } & NavigationEventInfo;
-    onInjectedHtml: {
-        type: 'onInjectedHtml';
-        promise: Promise<string>;
-    };
-    onRendered: {
-        type: 'onRendered';
-    } & NavigationEventInfo;
-};
-export type RouterEvent = RouterEvents[keyof RouterEvents];
-export type RouterListener<TRouterEvent extends RouterEvent> = {
-    eventType: TRouterEvent['type'];
-    fn: ListenerFn<TRouterEvent>;
-};
-export declare function createRouter<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TRouterHistory extends RouterHistory = RouterHistory, TDehydrated extends Record<string, any> = Record<string, any>, TSerializedError extends Record<string, any> = Record<string, any>>(options: undefined extends number ? 'strictNullChecks must be enabled in tsconfig.json' : RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TRouterHistory, TDehydrated>): Router<TRouteTree, TTrailingSlashOption, TRouterHistory, TDehydrated, TSerializedError>;
-type MatchRoutesOpts = {
-    preload?: boolean;
-    throwOnError?: boolean;
-    _buildLocation?: boolean;
-    dest?: BuildNextOptions;
-};
-export declare class Router<in out TRouteTree extends AnyRoute, in out TTrailingSlashOption extends TrailingSlashOption, in out TRouterHistory extends RouterHistory = RouterHistory, in out TDehydrated extends Record<string, any> = Record<string, any>, in out TSerializedError extends Record<string, any> = Record<string, any>> {
+export declare function createRouter<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, 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, false, TRouterHistory, TDehydrated>): CoreRouter<TRouteTree, TTrailingSlashOption, false, TRouterHistory, TDehydrated>;
+export declare class Router<in out TRouteTree extends AnyRoute, in out TTrailingSlashOption extends TrailingSlashOption, in out TRouterHistory extends RouterHistory = RouterHistory, in out TDehydrated extends Record<string, any> = Record<string, any>> implements CoreRouter<TRouteTree, TTrailingSlashOption, false, TRouterHistory, TDehydrated> {
     tempLocationKey: string | undefined;
     resetNextScroll: boolean;
     shouldViewTransition?: boolean | ViewTransitionOptions;
@@ -438,7 +81,7 @@ export declare class Router<in out TRouteTree extends AnyRoute, in out TTrailing
     isScrollRestoring: boolean;
     isScrollRestorationSetup: boolean;
     __store: Store<RouterState<TRouteTree>>;
-    options: PickAsRequired<RouterOptions<TRouteTree, TTrailingSlashOption, TRouterHistory, TDehydrated>, 'stringifySearch' | 'parseSearch' | 'context'>;
+    options: PickAsRequired<RouterOptions<TRouteTree, TTrailingSlashOption, false, TRouterHistory, TDehydrated>, 'stringifySearch' | 'parseSearch' | 'context'>;
     history: TRouterHistory;
     latestLocation: ParsedLocation<FullSearchSchema<TRouteTree>>;
     basepath: string;
@@ -451,14 +94,14 @@ export declare class Router<in out TRouteTree extends AnyRoute, in out TTrailing
     /**
      * @deprecated Use the `createRouter` function instead
      */
-    constructor(options: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TRouterHistory, TDehydrated>);
-    startSolidTransition: (fn: () => void) => void;
-    update: (newOptions: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TRouterHistory, TDehydrated>) => void;
+    constructor(options: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, false, TRouterHistory, TDehydrated>);
+    startTransition: StartTransitionFn;
+    update: UpdateFn<TRouteTree, TTrailingSlashOption, false, TRouterHistory, TDehydrated>;
     get state(): RouterState<TRouteTree, import('@tanstack/router-core').RouteMatch<any, any, any, any, any, any, any>>;
     buildRouteTree: () => void;
-    subscribe: <TType extends keyof RouterEvents>(eventType: TType, fn: ListenerFn<RouterEvents[TType]>) => () => void;
-    emit: (routerEvent: RouterEvent) => void;
-    parseLocation: (previousLocation?: ParsedLocation<FullSearchSchema<TRouteTree>>, locationToParse?: HistoryLocation) => ParsedLocation<FullSearchSchema<TRouteTree>>;
+    subscribe: SubscribeFn;
+    emit: EmitFn;
+    parseLocation: ParseLocationFn<TRouteTree>;
     resolvePathWithBase: (from: string, path: string) => string;
     get looseRoutesById(): Record<string, AnyRoute>;
     /**
@@ -470,28 +113,21 @@ export declare class Router<in out TRouteTree extends AnyRoute, in out TTrailing
     ): Array<AnyRouteMatch>;
     ```
   */
-    matchRoutes(pathname: string, locationSearch: AnySchema, opts?: MatchRoutesOpts): Array<AnyRouteMatch>;
-    matchRoutes(next: ParsedLocation, opts?: MatchRoutesOpts): Array<AnyRouteMatch>;
+    matchRoutes: MatchRoutesFn;
     private matchRoutesInternal;
-    getMatchedRoutes: (next: ParsedLocation, dest?: BuildNextOptions) => {
-        matchedRoutes: AnyRoute[];
-        routeParams: Record<string, string>;
-        foundRoute: AnyRoute | undefined;
-    };
+    getMatchedRoutes: GetMatchRoutesFn;
     cancelMatch: (id: string) => void;
     cancelMatches: () => void;
     buildLocation: BuildLocationFn;
     commitLocationPromise: undefined | ControlledPromise<void>;
-    commitLocation: ({ viewTransition, ignoreBlocker, ...next }: ParsedLocation & CommitLocationOptions) => Promise<void>;
+    commitLocation: CommitLocationFn;
     buildAndCommitLocation: ({ replace, resetScroll, hashScrollIntoView, viewTransition, ignoreBlocker, href, ...rest }?: BuildNextOptions & CommitLocationOptions) => Promise<void>;
     navigate: NavigateFn;
     latestLoadPromise: undefined | Promise<void>;
-    load: (opts?: {
-        sync?: boolean;
-    }) => Promise<void>;
+    load: LoadFn;
     startViewTransition: (fn: () => Promise<void>) => void;
-    updateMatch: (id: string, updater: (match: AnyRouteMatch) => AnyRouteMatch) => AnyRouteMatch;
-    getMatch: (matchId: string) => import('@tanstack/router-core').RouteMatch<any, any, any, any, any, any, any> | undefined;
+    updateMatch: UpdateMatchFn;
+    getMatch: GetMatchFn;
     loadMatches: ({ location, matches, preload: allPreload, onReady, updateMatch, sync, }: {
         location: ParsedLocation;
         matches: Array<AnyRouteMatch>;
@@ -501,18 +137,13 @@ export declare class Router<in out TRouteTree extends AnyRoute, in out TTrailing
         getMatch?: (matchId: string) => AnyRouteMatch | undefined;
         sync?: boolean;
     }) => Promise<Array<MakeRouteMatch>>;
-    invalidate: <TRouter extends AnyRouter = this>(opts?: {
-        filter?: (d: MakeRouteMatchUnion<TRouter>) => boolean;
-        sync?: boolean;
-    }) => Promise<void>;
+    invalidate: InvalidateFn<this>;
     resolveRedirect: (err: AnyRedirect) => ResolvedRedirect;
-    clearCache: <TRouter extends AnyRouter = this>(opts?: {
-        filter?: (d: MakeRouteMatchUnion<TRouter>) => boolean;
-    }) => void;
+    clearCache: ClearCacheFn<this>;
     clearExpiredCache: () => void;
     loadRouteChunk: (route: AnyRoute) => Promise<void[]>;
-    preloadRoute: <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, TRouterHistory, TDehydrated, TSerializedError>, TFrom, TTo, TMaskFrom, TMaskTo>) => Promise<Array<AnyRouteMatch> | undefined>;
-    matchRoute: <TFrom extends RoutePaths<TRouteTree> = "/", TTo extends string | undefined = undefined, TResolved = ResolveRelativePath<TFrom, NoInfer<TTo>>>(location: ToOptions<Router<TRouteTree, TTrailingSlashOption, TRouterHistory, TDehydrated, TSerializedError>, TFrom, TTo>, opts?: MatchRouteOptions) => false | RouteById<TRouteTree, TResolved>["types"]["allParams"];
+    preloadRoute: PreloadRouteFn<TRouteTree, TTrailingSlashOption, false, TRouterHistory>;
+    matchRoute: MatchRouteFn<TRouteTree, TTrailingSlashOption, false, TRouterHistory>;
     ssr?: {
         manifest: Manifest | undefined;
         serializer: StartSerializer;
@@ -544,4 +175,3 @@ export declare class SearchParamError extends Error {
 export declare class PathParamError extends Error {
 }
 export declare function getInitialRouterState(location: ParsedLocation): RouterState<any>;
-export {};

package/dist/cjs/routerContext.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"routerContext.cjs","sources":["../../src/routerContext.tsx"],"sourcesContent":["import * as Solid from 'solid-js'\nimport type { AnyRouter, Router } from './router'\n\ndeclare global {\n  interface Window {\n    __TSR_ROUTER_CONTEXT__?: Solid.Context<AnyRouter>\n  }\n}\n\nconst routerContext = Solid.createContext<Router<any, any, any>>(\n  null as unknown as Router<any, any, any>,\n)\n\nexport function getRouterContext() {\n  if (typeof document === 'undefined') {\n    return routerContext\n  }\n\n  if (window.__TSR_ROUTER_CONTEXT__) {\n    return window.__TSR_ROUTER_CONTEXT__\n  }\n\n  window.__TSR_ROUTER_CONTEXT__ = routerContext as any\n\n  return routerContext\n}\n"],"names":["routerContext","Solid","createContext","getRouterContext","document","window","__TSR_ROUTER_CONTEXT__"],"mappings":";;;;;;;;;;;;;;;;;;;;AASA,MAAMA,gBAAgBC,iBAAMC,cAC1B,IACF;AAEO,SAASC,mBAAmB;AAC7B,MAAA,OAAOC,aAAa,aAAa;AAC5BJ,WAAAA;AAAAA,EAAAA;AAGT,MAAIK,OAAOC,wBAAwB;AACjC,WAAOD,OAAOC;AAAAA,EAAAA;AAGhBD,SAAOC,yBAAyBN;AAEzBA,SAAAA;AACT;;"}
+{"version":3,"file":"routerContext.cjs","sources":["../../src/routerContext.tsx"],"sourcesContent":["import * as Solid from 'solid-js'\nimport type { AnyRouter } from '@tanstack/router-core'\n\ndeclare global {\n  interface Window {\n    __TSR_ROUTER_CONTEXT__?: Solid.Context<AnyRouter>\n  }\n}\n\nconst routerContext = Solid.createContext<AnyRouter>(\n  null as unknown as AnyRouter,\n)\n\nexport function getRouterContext() {\n  if (typeof document === 'undefined') {\n    return routerContext\n  }\n\n  if (window.__TSR_ROUTER_CONTEXT__) {\n    return window.__TSR_ROUTER_CONTEXT__\n  }\n\n  window.__TSR_ROUTER_CONTEXT__ = routerContext as any\n\n  return routerContext\n}\n"],"names":["routerContext","Solid","createContext","getRouterContext","document","window","__TSR_ROUTER_CONTEXT__"],"mappings":";;;;;;;;;;;;;;;;;;;;AASA,MAAMA,gBAAgBC,iBAAMC,cAC1B,IACF;AAEO,SAASC,mBAAmB;AAC7B,MAAA,OAAOC,aAAa,aAAa;AAC5BJ,WAAAA;AAAAA,EAAAA;AAGT,MAAIK,OAAOC,wBAAwB;AACjC,WAAOD,OAAOC;AAAAA,EAAAA;AAGhBD,SAAOC,yBAAyBN;AAEzBA,SAAAA;AACT;;"}

package/dist/cjs/routerContext.d.cts

@@ -1,8 +1,8 @@
-import { AnyRouter, Router } from './router.cjs';
+import { AnyRouter } from '@tanstack/router-core';
 import * as Solid from 'solid-js';
 declare global {
     interface Window {
         __TSR_ROUTER_CONTEXT__?: Solid.Context<AnyRouter>;
     }
 }
-export declare function getRouterContext(): Solid.Context<AnyRouter> | Solid.Context<Router<any, any, any, Record<string, any>, Record<string, any>>>;
+export declare function getRouterContext(): Solid.Context<AnyRouter>;