@tanstack/solid-router 1.114.24 → 1.114.26

package/dist/source/router.d.ts

@@ -1,64 +1,60 @@
-import { Store } from '@tanstack/solid-store';
-import type * as Solid from 'solid-js';
+import { RouterCore } from '@tanstack/router-core';
 import type { RouterHistory } from '@tanstack/history';
-import type { 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, NotFoundError, ParseLocationFn, ParsedLocation, PickAsRequired, PreloadRouteFn, ResolvedRedirect, RouterConstructorOptions, RouterEvent, RouterListener, RouterOptions, RouterState, RoutesById, RoutesByPath, StartSerializer, StartTransitionFn, SubscribeFn, TrailingSlashOption, UpdateFn, UpdateMatchFn, ViewTransitionOptions } from '@tanstack/router-core';
+import type { AnyRoute, CreateRouterFn, RouterConstructorOptions, TrailingSlashOption } from '@tanstack/router-core';
 import type { ErrorRouteComponent, NotFoundRouteComponent, RouteComponent } from './route';
+import type { JSX } from 'solid-js';
 declare module '@tanstack/router-core' {
     interface RouterOptionsExtensions {
-        /**
-         * 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;
         /**
          * 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)
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/solid/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)
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/solid/api/router/RouterOptionsType#defaulterrorcomponent-property)
+         * @link [Guide](https://tanstack.com/router/latest/docs/framework/solid/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)
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/solid/api/router/RouterOptionsType#defaultpendingcomponent-property)
+         * @link [Guide](https://tanstack.com/router/latest/docs/framework/solid/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)
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/solid/api/router/RouterOptionsType#defaultnotfoundcomponent-property)
+         * @link [Guide](https://tanstack.com/router/latest/docs/framework/solid/guide/not-found-errors#default-router-wide-not-found-handling)
          */
         defaultNotFoundComponent?: NotFoundRouteComponent;
+        /**
+         * A component that will be used to wrap the entire router.
+         *
+         * This is useful for providing a context to the entire router.
+         *
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/solid/api/router/RouterOptionsType#wrap-property)
+         */
+        Wrap?: (props: {
+            children: any;
+        }) => 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.
+         *
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/solid/api/router/RouterOptionsType#innerwrap-property)
+         */
+        InnerWrap?: (props: {
+            children: any;
+        }) => JSX.Element;
         /**
          * The default `onCatch` handler for errors caught by the Router ErrorBoundary
          *
@@ -68,109 +64,7 @@ declare module '@tanstack/router-core' {
         defaultOnCatch?: (error: Error) => void;
     }
 }
-export declare const componentTypes: readonly ["component", "errorComponent", "pendingComponent", "notFoundComponent"];
-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;
-    isViewTransitionTypesSupported?: boolean;
-    subscribers: Set<RouterListener<RouterEvent>>;
-    viewTransitionPromise?: ControlledPromise<true>;
-    isScrollRestoring: boolean;
-    isScrollRestorationSetup: boolean;
-    __store: Store<RouterState<TRouteTree>>;
-    options: PickAsRequired<RouterOptions<TRouteTree, TTrailingSlashOption, false, 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, 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: 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<this>;
-    resolveRedirect: (err: AnyRedirect) => ResolvedRedirect;
-    clearCache: ClearCacheFn<this>;
-    clearExpiredCache: () => void;
-    loadRouteChunk: (route: AnyRoute) => Promise<void[]>;
-    preloadRoute: PreloadRouteFn<TRouteTree, TTrailingSlashOption, false, TRouterHistory>;
-    matchRoute: MatchRouteFn<TRouteTree, TTrailingSlashOption, false, 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 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 class SearchParamError extends Error {
-}
-export declare class PathParamError extends Error {
+export declare const createRouter: CreateRouterFn;
+export declare class Router<in out TRouteTree extends AnyRoute, in out TTrailingSlashOption extends TrailingSlashOption = 'never', in out TDefaultStructuralSharingOption extends boolean = false, in out TRouterHistory extends RouterHistory = RouterHistory, in out TDehydrated extends Record<string, any> = Record<string, any>> extends RouterCore<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated> {
+    constructor(options: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>);
 }
-export declare function getInitialRouterState(location: ParsedLocation): RouterState<any>;