@tanstack/solid-router 1.111.3 → 1.111.4

package/dist/source/route.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route.js","sourceRoot":"","sources":["../../src/route.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAA;AACtC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAukBrC,MAAM,UAAU,WAAW,CAGzB,EAAyD;IACzD,OAAO,IAAI,QAAQ,CAAe,EAAE,EAAE,EAAE,CAAC,CAAA;AAC3C,CAAC;AAED,MAAM,OAAO,QAAQ;IAGnB;;OAEG;IACH,YAAY,EAAE,EAAE,EAAe;QAI/B,aAAQ,GAAuB,CAAC,IAAI,EAAE,EAAE;YACtC,OAAO,QAAQ,CAAC;gBACd,MAAM,EAAE,IAAI,EAAE,MAAM;gBACpB,IAAI,EAAE,IAAI,CAAC,EAAE;aACP,CAAQ,CAAA;QAClB,CAAC,CAAA;QAED,oBAAe,GAA8B,CAAC,IAAI,EAAE,EAAE;YACpD,OAAO,QAAQ,CAAC;gBACd,IAAI,EAAE,IAAI,CAAC,EAAS;gBACpB,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;aACnE,CAAQ,CAAA;QACX,CAAC,CAAA;QAED,cAAS,GAAwB,CAAC,IAAI,EAAE,EAAE;YACxC,OAAO,SAAS,CAAC;gBACf,MAAM,EAAE,IAAI,EAAE,MAAM;gBACpB,IAAI,EAAE,IAAI,CAAC,EAAE;aACP,CAAQ,CAAA;QAClB,CAAC,CAAA;QAED,cAAS,GAAwB,CAAC,IAAI,EAAE,EAAE;YACxC,OAAO,SAAS,CAAC;gBACf,MAAM,EAAE,IAAI,EAAE,MAAM;gBACpB,IAAI,EAAE,IAAI,CAAC,EAAE;aACP,CAAQ,CAAA;QAClB,CAAC,CAAA;QAED,kBAAa,GAA4B,CAAC,IAAI,EAAE,EAAE;YAChD,OAAO,aAAa,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAS,CAAC,CAAA;QACxE,CAAC,CAAA;QAED,kBAAa,GAA4B,CAAC,IAAI,EAAE,EAAE;YAChD,OAAO,aAAa,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAS,CAAC,CAAA;QACxE,CAAC,CAAA;QAED,gBAAW,GAAG,GAEZ,EAAE;YACF,OAAO,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,EAAY,EAAE,CAAC,CAAA;QACjD,CAAC,CAAA;QAED,aAAQ,GAAG,CAAC,IAAoB,EAAE,EAAE;YAClC,OAAO,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,EAAY,EAAE,GAAG,IAAI,EAAE,CAAC,CAAA;QAC1D,CAAC,CAAA;QA/CC,IAAI,CAAC,EAAE,GAAG,EAAS,CAAA;IACrB,CAAC;CA+CF;AAED,MAAM,OAAO,KAAK;IAgEhB,IAAW,EAAE;QACX;;;WAGG;QACH,OAAO,IAAI,CAAC,GAAG,CAAA;IACjB,CAAC;IAED,IAAW,EAAE;QACX;;;WAGG;QACH,OAAO,IAAI,CAAC,GAAG,CAAA;IACjB,CAAC;IAED,IAAW,IAAI;QACb;;;;WAIG;QACH,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAED,IAAW,QAAQ;QACjB;;;WAGG;QACH,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAED,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAUD;;OAEG;IACH,YACE,OAaC;QA4BH,SAAI,GAAG,CAAC,IAAqD,EAAQ,EAAE;YACrE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;YAEvC,MAAM,OAAO,GAAG,IAAI,CAAC,OAgBR,CAAA;YAEb,MAAM,MAAM,GAAG,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAA;YAE7C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAA;YAElD,IAAI,MAAM,EAAE,CAAC;gBACX,IAAI,CAAC,KAAK,GAAG,WAAoB,CAAA;YACnC,CAAC;iBAAM,CAAC;gBACN,SAAS,CACP,IAAI,CAAC,WAAW,EAChB,6GAA6G,CAC9G,CAAA;YACH,CAAC;YAED,IAAI,IAAI,GAAuB,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAA;YAElE,+DAA+D;YAC/D,IAAI,IAAI,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;gBACzB,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;YAC3B,CAAC;YAED,MAAM,QAAQ,GAAG,OAAO,EAAE,EAAE,IAAI,IAAI,CAAA;YAEpC,6DAA6D;YAC7D,IAAI,EAAE,GAAG,MAAM;gBACb,CAAC,CAAC,WAAW;gBACb,CAAC,CAAC,SAAS,CAAC;oBACR,IAAI,CAAC,WAAW,CAAC,EAAE,KAAK,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;oBAC9D,QAAQ;iBACT,CAAC,CAAA;YAEN,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;gBACzB,IAAI,GAAG,GAAG,CAAA;YACZ,CAAC;YAED,IAAI,EAAE,KAAK,WAAW,EAAE,CAAC;gBACvB,EAAE,GAAG,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAA;YAC3B,CAAC;YAED,MAAM,QAAQ,GACZ,EAAE,KAAK,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;YAEzE,IAAI,CAAC,KAAK,GAAG,IAAa,CAAA;YAC1B,IAAI,CAAC,GAAG,GAAG,EAAS,CAAA;YACpB,wCAAwC;YACxC,IAAI,CAAC,SAAS,GAAG,QAAqB,CAAA;YACtC,IAAI,CAAC,GAAG,GAAG,QAAoC,CAAA;YAC/C,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAA;QACrD,CAAC,CAAA;QAqFD,iBAAY,GAAG,CAAe,OAa7B,EAAE,EAAE;YACH,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YACpC,OAAO,IAeN,CAAA;QACH,CAAC,CAAA;QAED,WAAM,GAAG,CACP,OAWC,EACK,EAAE;YACR,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YACpC,OAAO,IAAI,CAAA;QACb,CAAC,CAAA;QAED,SAAI,GAAG,CAAC,MAAqC,EAAQ,EAAE;YACrD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;YACpB,OAAO,IAAI,CAAA;QACb,CAAC,CAAA;QAED,aAAQ,GAAuB,CAAC,IAAI,EAAE,EAAE;YACtC,OAAO,QAAQ,CAAC;gBACd,MAAM,EAAE,IAAI,EAAE,MAAM;gBACpB,IAAI,EAAE,IAAI,CAAC,EAAE;aACP,CAAQ,CAAA;QAClB,CAAC,CAAA;QAED,oBAAe,GAA8B,CAAC,IAAK,EAAE,EAAE;YACrD,OAAO,QAAQ,CAAC;gBACd,GAAG,IAAI;gBACP,IAAI,EAAE,IAAI,CAAC,EAAE;gBACb,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;aACnE,CAAQ,CAAA;QACX,CAAC,CAAA;QAED,cAAS,GAAwB,CAAC,IAAI,EAAE,EAAE;YACxC,OAAO,SAAS,CAAC;gBACf,MAAM,EAAE,IAAI,EAAE,MAAM;gBACpB,IAAI,EAAE,IAAI,CAAC,EAAE;aACP,CAAQ,CAAA;QAClB,CAAC,CAAA;QAED,cAAS,GAAwB,CAAC,IAAI,EAAE,EAAE;YACxC,OAAO,SAAS,CAAC;gBACf,MAAM,EAAE,IAAI,EAAE,MAAM;gBACpB,IAAI,EAAE,IAAI,CAAC,EAAE;aACP,CAAQ,CAAA;QAClB,CAAC,CAAA;QAED,kBAAa,GAA4B,CAAC,IAAI,EAAE,EAAE;YAChD,OAAO,aAAa,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAS,CAAC,CAAA;QACzD,CAAC,CAAA;QAED,kBAAa,GAA4B,CAAC,IAAI,EAAE,EAAE;YAChD,OAAO,aAAa,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAS,CAAC,CAAA;QACzD,CAAC,CAAA;QAED,gBAAW,GAAG,GAAiC,EAAE;YAC/C,OAAO,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAA;QACvC,CAAC,CAAA;QAlRC,IAAI,CAAC,OAAO,GAAI,OAAe,IAAI,EAAE,CAAA;QAErC,IAAI,CAAC,MAAM,GAAG,CAAC,OAAO,EAAE,cAAqB,CAAA;QAC7C,SAAS,CACP,CAAC,CAAE,OAAe,EAAE,EAAE,IAAK,OAAe,EAAE,IAAI,CAAC,EACjD,qDAAqD,CACtD,CAAA;IACH,CAAC;IAyFD,WAAW,CACT,QAGC;QAiBD,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAepC,CAAA;IACH,CAAC;IAED,gBAAgB,CACd,QAAsB;QAiBtB,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,QAAQ,GAAG,QAAqB,CAAA;QACvC,CAAC;QAED,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtD,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAc,CAAA;QACtD,CAAC;QAED,OAAO,IAeN,CAAA;IACH,CAAC;CAkGF;AAED,MAAM,UAAU,WAAW,CAqBzB,OAaC;IAED,OAAO,IAAI,KAAK,CAcd,OAAO,CAAC,CAAA;AACZ,CAAC;AAmCD,MAAM,UAAU,0BAA0B;IACxC,OAAO,CAOL,OAOC,EACD,EAAE;QACF,OAAO,eAAe,CAOpB,OAAc,CAAC,CAAA;IACnB,CAAC,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,0BAA0B,CAAA;AAE9D,MAAM,OAAO,SAUX,SAAQ,KAeP;IAaD;;OAEG;IACH,YACE,OAOC;QAED,KAAK,CAAC,OAAc,CAAC,CAAA;IACvB,CAAC;IAED,WAAW,CACT,QAGC;QAWD,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;QAC3B,OAAO,IASN,CAAA;IACH,CAAC;IAED,gBAAgB,CACd,QAAsB;QAWtB,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAA;QAChC,OAAO,IASN,CAAA;IACH,CAAC;IAED,aAAa;QAUX,OAAO,IAAW,CAAA;IACpB,CAAC;CACF;AAED,MAAM,UAAU,eAAe,CAQ7B,OAOC;IAED,OAAO,IAAI,SAAS,CAOlB,OAAO,CAAC,CAAA;AACZ,CAAC;AAmBD,MAAM,UAAU,eAAe,CAK7B,IAE0D;IAE1D,OAAO,IAAW,CAAA;AACpB,CAAC;AAgBD,MAAM,OAAO,aASX,SAAQ,KAcT;IACC,YACE,OAqBC;QAED,KAAK,CAAC;YACJ,GAAI,OAAe;YACnB,EAAE,EAAE,KAAK;SACV,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/source/router.d.ts

@@ -0,0 +1,550 @@
+import { Store } from '@tanstack/solid-store';
+import type * as Solid from 'solid-js';
+import type { HistoryLocation, HistoryState, ParsedHistoryState, RouterHistory } from '@tanstack/history';
+import type { NoInfer } from '@tanstack/solid-store';
+import type { AnyContext, AnySchema, BuildLocationFn, CommitLocationOptions, ControlledPromise, FullSearchSchema, MakeRemountDepsOptionsUnion, Manifest, NavigateFn, NavigateOptions, NonNullableUpdater, ParsedLocation, PickAsRequired, Register, ResolveRelativePath, RouteById, RoutePaths, RoutesById, RoutesByPath, SearchParser, SearchSerializer, StartSerializer, ToOptions, TrailingSlashOption, Updater, ViewTransitionOptions } from '@tanstack/router-core';
+import type { AnyRoute, ErrorRouteComponent, NotFoundRouteComponent, RootRoute, RouteComponent, RouteMask } from './route';
+import type { AnyRouteMatch, MakeRouteMatch, MakeRouteMatchUnion, MatchRouteOptions } from './Matches';
+import type { AnyRedirect, ResolvedRedirect } from './redirects';
+import type { NotFoundError } from './not-found';
+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)
+     * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/route-trees#case-sensitivity)
+     */
+    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/guide/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?: {
+        /**
+         * Configures how unknown search params (= not returned by any `validateSearch`) are treated.
+         *
+         * @default false
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#search.strict-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>;
+}
+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>> {
+    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, 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, TRouterHistory, TDehydrated>);
+    startSolidTransition: (fn: () => void) => void;
+    update: (newOptions: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TRouterHistory, TDehydrated>) => void;
+    get state(): RouterState<TRouteTree, import("./Matches").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>>;
+    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(pathname: string, locationSearch: AnySchema, opts?: MatchRoutesOpts): Array<AnyRouteMatch>;
+    matchRoutes(next: ParsedLocation, opts?: MatchRoutesOpts): Array<AnyRouteMatch>;
+    private matchRoutesInternal;
+    getMatchedRoutes: (next: ParsedLocation, dest?: BuildNextOptions) => {
+        matchedRoutes: AnyRoute[];
+        routeParams: Record<string, string>;
+        foundRoute: AnyRoute | undefined;
+    };
+    cancelMatch: (id: string) => void;
+    cancelMatches: () => void;
+    buildLocation: BuildLocationFn;
+    commitLocationPromise: undefined | ControlledPromise<void>;
+    commitLocation: ({ viewTransition, ignoreBlocker, ...next }: ParsedLocation & CommitLocationOptions) => Promise<void>;
+    buildAndCommitLocation: ({ replace, resetScroll, hashScrollIntoView, viewTransition, ignoreBlocker, href, ...rest }?: BuildNextOptions & CommitLocationOptions) => Promise<void>;
+    navigate: NavigateFn;
+    latestLoadPromise: undefined | Promise<void>;
+    load: (opts?: {
+        sync?: boolean;
+    }) => Promise<void>;
+    startViewTransition: (fn: () => Promise<void>) => void;
+    updateMatch: (id: string, updater: (match: AnyRouteMatch) => AnyRouteMatch) => AnyRouteMatch;
+    getMatch: (matchId: string) => import("./Matches").RouteMatch<any, any, any, any, any, any, any> | undefined;
+    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: <TRouter extends AnyRouter = this>(opts?: {
+        filter?: (d: MakeRouteMatchUnion<TRouter>) => boolean;
+        sync?: boolean;
+    }) => Promise<void>;
+    resolveRedirect: (err: AnyRedirect) => ResolvedRedirect;
+    clearCache: <TRouter extends AnyRouter = this>(opts?: {
+        filter?: (d: MakeRouteMatchUnion<TRouter>) => boolean;
+    }) => void;
+    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"];
+    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 function getInitialRouterState(location: ParsedLocation): RouterState<any>;
+export {};