@tanstack/react-router 1.22.4 → 1.22.6

package/dist/esm/router.d.ts

@@ -1,19 +1,19 @@
-import * as React from 'react';
-import { HistoryState, RouterHistory } from '@tanstack/history';
 import { Store } from '@tanstack/react-store';
-import { AnySearchSchema, AnyRoute, AnyContext, RouteMask, NotFoundRouteComponent } from './route.js';
-import { FullSearchSchema, RouteById, RoutePaths, RoutesById, RoutesByPath } from './routeInfo.js';
-import { PickAsRequired, Updater, NonNullableUpdater, Timeout } from './utils.js';
-import { RouteComponent } from './route.js';
-import { AnyRouteMatch, MatchRouteOptions, RouteMatch } from './Matches.js';
-import { ParsedLocation } from './location.js';
-import { SearchSerializer, SearchParser } from './searchParams.js';
-import { BuildLocationFn, CommitLocationOptions, InjectedHtmlEntry, NavigateFn } from './RouterProvider.js';
-import { AnyRedirect, ResolvedRedirect } from './redirects.js';
-import { NotFoundError } from './not-found.js';
-import { NavigateOptions, ResolveRelativePath, ToOptions } from './link.js';
-import { NoInfer } from '@tanstack/react-store';
-import { DeferredPromiseState } from './defer.js';
+import type * as React from 'react';
+import type { HistoryState, RouterHistory } from '@tanstack/history';
+import type { AnyContext, AnyRoute, AnySearchSchema, NotFoundRouteComponent, RouteMask } from './route.js';
+import type { FullSearchSchema, RouteById, RoutePaths, RoutesById, RoutesByPath } from './routeInfo.js';
+import type { NonNullableUpdater, PickAsRequired, Timeout, Updater } from './utils.js';
+import type { RouteComponent } from './route.js';
+import type { AnyRouteMatch, MatchRouteOptions, RouteMatch } from './Matches.js';
+import type { ParsedLocation } from './location.js';
+import type { SearchParser, SearchSerializer } from './searchParams.js';
+import type { BuildLocationFn, CommitLocationOptions, InjectedHtmlEntry, NavigateFn } from './RouterProvider.js';
+import type { AnyRedirect, ResolvedRedirect } from './redirects.js';
+import type { NotFoundError } from './not-found.js';
+import type { NavigateOptions, ResolveRelativePath, ToOptions } from './link.js';
+import type { NoInfer } from '@tanstack/react-store';
+import type { DeferredPromiseState } from './defer.js';
 declare global {
     interface Window {
         __TSR_DEHYDRATED__?: {
@@ -59,7 +59,7 @@ export interface RouterOptions<TRouteTree extends AnyRoute, TDehydrated extends
     context?: TRouteTree['types']['routerContext'];
     dehydrate?: () => TDehydrated;
     hydrate?: (dehydrated: TDehydrated) => void;
-    routeMasks?: RouteMask<TRouteTree>[];
+    routeMasks?: Array<RouteMask<TRouteTree>>;
     unmaskOnReload?: boolean;
     Wrap?: (props: {
         children: any;
@@ -89,9 +89,9 @@ export interface RouterState<TRouteTree extends AnyRoute = AnyRoute> {
     status: 'pending' | 'idle';
     isLoading: boolean;
     isTransitioning: boolean;
-    matches: RouteMatch<TRouteTree>[];
-    pendingMatches?: RouteMatch<TRouteTree>[];
-    cachedMatches: RouteMatch<TRouteTree>[];
+    matches: Array<RouteMatch<TRouteTree>>;
+    pendingMatches?: Array<RouteMatch<TRouteTree>>;
+    cachedMatches: Array<RouteMatch<TRouteTree>>;
     location: ParsedLocation<FullSearchSchema<TRouteTree>>;
     resolvedLocation: ParsedLocation<FullSearchSchema<TRouteTree>>;
     lastUpdated: number;
@@ -116,7 +116,7 @@ export interface BuildNextOptions {
     from?: string;
 }
 export interface DehydratedRouterState {
-    dehydratedMatches: DehydratedRouteMatch[];
+    dehydratedMatches: Array<DehydratedRouteMatch>;
 }
 export type DehydratedRouteMatch = Pick<RouteMatch, 'id' | 'status' | 'updatedAt' | 'loaderData'>;
 export interface DehydratedRouter {
@@ -156,7 +156,7 @@ export declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated
     navigateTimeout: Timeout | null;
     latestLoadPromise: Promise<void>;
     subscribers: Set<RouterListener<RouterEvent>>;
-    injectedHtml: InjectedHtmlEntry[];
+    injectedHtml: Array<InjectedHtmlEntry>;
     dehydratedData?: TDehydrated;
     __store: Store<RouterState<TRouteTree>>;
     options: PickAsRequired<Omit<RouterOptions<TRouteTree, TDehydrated, TSerializedError>, 'transformer'> & {
@@ -168,7 +168,7 @@ export declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated
     routeTree: TRouteTree;
     routesById: RoutesById<TRouteTree>;
     routesByPath: RoutesByPath<TRouteTree>;
-    flatRoutes: AnyRoute[];
+    flatRoutes: Array<AnyRoute>;
     /**
      * @deprecated Use the `createRouter` function instead
      */
@@ -197,14 +197,14 @@ export declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated
     loadMatches: ({ checkLatest, location, matches, preload, }: {
         checkLatest: () => Promise<void> | undefined;
         location: ParsedLocation;
-        matches: AnyRouteMatch[];
+        matches: Array<AnyRouteMatch>;
         preload?: boolean | undefined;
-    }) => Promise<RouteMatch[]>;
+    }) => Promise<Array<RouteMatch>>;
     invalidate: () => void;
     load: () => Promise<void>;
     resolveRedirect: (err: AnyRedirect) => ResolvedRedirect;
     cleanCache: () => void;
-    preloadRoute: <TFrom extends string | import("./routeInfo").ParseRoute<TRouteTree, TRouteTree>["fullPath"] = string, TTo extends string = "", TMaskFrom extends string | import("./routeInfo").ParseRoute<TRouteTree, TRouteTree>["fullPath"] = TFrom, TMaskTo extends string = "">(opts: NavigateOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo>) => Promise<AnyRouteMatch[] | undefined>;
+    preloadRoute: <TFrom extends string | import("./routeInfo").ParseRoute<TRouteTree, TRouteTree>["fullPath"] = string, TTo extends string = "", TMaskFrom extends string | import("./routeInfo").ParseRoute<TRouteTree, TRouteTree>["fullPath"] = TFrom, TMaskTo extends string = "">(opts: NavigateOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo>) => Promise<Array<AnyRouteMatch> | undefined>;
     matchRoute: <TFrom extends RoutePaths<TRouteTree> = "/", TTo extends string = "", TResolved = ResolveRelativePath<TFrom, NoInfer<TTo>>>(location: ToOptions<TRouteTree, TFrom, TTo>, opts?: MatchRouteOptions) => false | RouteById<TRouteTree, TResolved>["types"]["allParams"];
     injectHtml: (html: string | (() => Promise<string> | string)) => Promise<void>;
     registeredDeferredsIds: Map<string, {}>;
@@ -217,13 +217,13 @@ export declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated
     /**
      * @deprecated Please extract your own data from scripts injected using the `injectHtml` method
      */
-    hydrateData: <T extends unknown = unknown>(key: any) => T | undefined;
+    hydrateData: <T = unknown>(key: any) => T | undefined;
     dehydrate: () => DehydratedRouter;
     hydrate: (__do_not_use_server_ctx?: string) => Promise<void>;
-    handleNotFound: (matches: AnyRouteMatch[], err: NotFoundError) => void;
+    handleNotFound: (matches: Array<AnyRouteMatch>, err: NotFoundError) => void;
     hasNotFoundMatch: () => boolean;
 }
-export declare function lazyFn<T extends Record<string, (...args: any[]) => any>, TKey extends keyof T = 'default'>(fn: () => Promise<T>, key?: TKey): (...args: Parameters<T[TKey]>) => Promise<Awaited<ReturnType<T[TKey]>>>;
+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 {

package/dist/esm/router.js

@@ -1,14 +1,14 @@
 import { createBrowserHistory, createMemoryHistory } from "@tanstack/history";
 import { Store } from "@tanstack/react-store";
+import invariant from "tiny-invariant";
+import warning from "tiny-warning";
 import { rootRouteId } from "./route.js";
 import { defaultStringifySearch, defaultParseSearch } from "./searchParams.js";
 import { replaceEqualDeep, pick, isServer, deepEqual, escapeJSON, last, functionalUpdate } from "./utils.js";
 import { getRouteMatch } from "./RouterProvider.js";
 import { trimPath, trimPathLeft, parsePathname, resolvePath, cleanPath, matchPathname, trimPathRight, interpolatePath, joinPaths } from "./path.js";
-import invariant from "tiny-invariant";
 import { isRedirect } from "./redirects.js";
 import { isNotFound } from "./not-found.js";
-import warning from "tiny-warning";
 const componentTypes = [
   "component",
   "errorComponent",
@@ -50,7 +50,10 @@ class Router {
           this.basepath = `/${trimPath(newOptions.basepath)}`;
         }
       }
-      if (!this.history || this.options.history && this.options.history !== this.history) {
+      if (
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+        !this.history || this.options.history && this.options.history !== this.history
+      ) {
         this.history = this.options.history ?? (typeof document !== "undefined" ? createBrowserHistory() : createMemoryHistory({
           initialEntries: [this.options.basepath || "/"]
         }));
@@ -105,7 +108,8 @@ class Router {
       };
       recurseRoutes([this.routeTree]);
       const scoredRoutes = [];
-      Object.values(this.routesById).forEach((d, i) => {
+      const routes = Object.values(this.routesById);
+      routes.forEach((d, i) => {
         var _a;
         if (d.isRoot || !d.path) {
           return;
@@ -115,14 +119,14 @@ class Router {
         while (parsed.length > 1 && ((_a = parsed[0]) == null ? void 0 : _a.value) === "/") {
           parsed.shift();
         }
-        const scores = parsed.map((d2) => {
-          if (d2.value === "/") {
+        const scores = parsed.map((segment) => {
+          if (segment.value === "/") {
             return 0.75;
           }
-          if (d2.type === "param") {
+          if (segment.type === "param") {
             return 0.5;
           }
-          if (d2.type === "wildcard") {
+          if (segment.type === "wildcard") {
             return 0.25;
           }
           return 1;
@@ -189,7 +193,7 @@ class Router {
         };
       };
       const location = parse(this.history.location);
-      let { __tempLocation, __tempKey } = location.state;
+      const { __tempLocation, __tempKey } = location.state;
       if (__tempLocation && (!__tempKey || __tempKey === this.tempLocationKey)) {
         const parsedTempLocation = parse(__tempLocation);
         parsedTempLocation.state.key = location.state.key;
@@ -206,7 +210,7 @@ class Router {
     };
     this.matchRoutes = (pathname, locationSearch, opts) => {
       let routeParams = {};
-      let foundRoute = this.flatRoutes.find((route) => {
+      const foundRoute = this.flatRoutes.find((route) => {
         const matchedParams = matchPathname(
           this.basepath,
           trimPathRight(pathname),
@@ -223,7 +227,7 @@ class Router {
         return false;
       });
       let routeCursor = foundRoute || this.routesById[rootRouteId];
-      let matchedRoutes = [routeCursor];
+      const matchedRoutes = [routeCursor];
       let isGlobalNotFound = false;
       if (
         // If we found a route, and it's not an index route and we have left over path
@@ -238,10 +242,9 @@ class Router {
           isGlobalNotFound = true;
         }
       }
-      while (routeCursor == null ? void 0 : routeCursor.parentRoute) {
+      while (routeCursor.parentRoute) {
         routeCursor = routeCursor.parentRoute;
-        if (routeCursor)
-          matchedRoutes.unshift(routeCursor);
+        matchedRoutes.unshift(routeCursor);
       }
       const globalNotFoundRouteId = (() => {
         if (!isGlobalNotFound) {
@@ -283,7 +286,7 @@ class Router {
           const parentSearch = (parentMatch == null ? void 0 : parentMatch.search) ?? locationSearch;
           try {
             const validator = typeof route.options.validateSearch === "object" ? route.options.validateSearch.parse : route.options.validateSearch;
-            let search = (validator == null ? void 0 : validator(parentSearch)) ?? {};
+            const search = (validator == null ? void 0 : validator(parentSearch)) ?? {};
             return [
               {
                 ...parentSearch,
@@ -292,13 +295,13 @@ class Router {
               void 0
             ];
           } catch (err) {
-            const searchError2 = new SearchParamError(err.message, {
+            const searchParamError = new SearchParamError(err.message, {
               cause: err
             });
             if (opts == null ? void 0 : opts.throwOnError) {
-              throw searchError2;
+              throw searchParamError;
             }
-            return [parentSearch, searchError2];
+            return [parentSearch, searchParamError];
           }
         })();
         const loaderDeps = ((_b = (_a = route.options).loaderDeps) == null ? void 0 : _b.call(_a, {
@@ -314,7 +317,7 @@ class Router {
           params: routeParams,
           leaveWildcards: true
         }) + loaderDepsHash;
-        let existingMatch = getRouteMatch(this.state, matchId);
+        const existingMatch = getRouteMatch(this.state, matchId);
         const cause = this.state.matches.find((d) => d.id === matchId) ? "stay" : "enter";
         const match = existingMatch ? {
           ...existingMatch,
@@ -369,13 +372,16 @@ class Router {
       const build = (dest = {}, matches) => {
         var _a, _b, _c;
         const relevantMatches = this.state.pendingMatches || this.state.matches;
-        const fromSearch = ((_a = relevantMatches[relevantMatches.length - 1]) == null ? void 0 : _a.search) || this.latestLocation.search;
+        const fromSearch = (
+          // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+          ((_a = relevantMatches[relevantMatches.length - 1]) == null ? void 0 : _a.search) || this.latestLocation.search
+        );
         const fromMatches = this.matchRoutes(
           this.latestLocation.pathname,
           fromSearch
         );
         const stayingMatches = matches == null ? void 0 : matches.filter(
-          (d) => fromMatches == null ? void 0 : fromMatches.find((e) => e.routeId === d.routeId)
+          (d) => fromMatches.find((e) => e.routeId === d.routeId)
         );
         const fromRoute = this.looseRoutesById[(_b = last(fromMatches)) == null ? void 0 : _b.routeId];
         let pathname = dest.to ? this.resolvePathWithBase(
@@ -401,12 +407,9 @@ class Router {
         const postSearchFilters = (stayingMatches == null ? void 0 : stayingMatches.map(
           (match) => this.looseRoutesById[match.routeId].options.postSearchFilters ?? []
         ).flat().filter(Boolean)) ?? [];
-        const preFilteredSearch = (preSearchFilters == null ? void 0 : preSearchFilters.length) ? preSearchFilters == null ? void 0 : preSearchFilters.reduce(
-          (prev, next) => next(prev),
-          fromSearch
-        ) : fromSearch;
-        const destSearch = dest.search === true ? preFilteredSearch : dest.search ? functionalUpdate(dest.search, preFilteredSearch) ?? {} : (preSearchFilters == null ? void 0 : preSearchFilters.length) ? preFilteredSearch : {};
-        const postFilteredSearch = (postSearchFilters == null ? void 0 : postSearchFilters.length) ? postSearchFilters.reduce((prev, next) => next(prev), destSearch) : destSearch;
+        const preFilteredSearch = preSearchFilters.length ? preSearchFilters.reduce((prev, next) => next(prev), fromSearch) : fromSearch;
+        const destSearch = dest.search === true ? preFilteredSearch : dest.search ? functionalUpdate(dest.search, preFilteredSearch) : preSearchFilters.length ? preFilteredSearch : {};
+        const postFilteredSearch = postSearchFilters.length ? postSearchFilters.reduce((prev, next) => next(prev), destSearch) : destSearch;
         const search = replaceEqualDeep(fromSearch, postFilteredSearch);
         const searchStr = this.options.stringifySearch(search);
         const hash = dest.hash === true ? this.latestLocation.hash : dest.hash ? functionalUpdate(dest.hash, this.latestLocation.hash) : void 0;
@@ -425,11 +428,11 @@ class Router {
       };
       const buildWithMatches = (dest = {}, maskedDest) => {
         var _a;
-        let next = build(dest);
+        const next = build(dest);
         let maskedNext = maskedDest ? build(maskedDest) : void 0;
         if (!maskedNext) {
           let params = {};
-          let foundMask = (_a = this.options.routeMasks) == null ? void 0 : _a.find((d) => {
+          const foundMask = (_a = this.options.routeMasks) == null ? void 0 : _a.find((d) => {
             const match = matchPathname(this.basepath, next.pathname, {
               to: d.from,
               caseSensitive: false,
@@ -654,6 +657,7 @@ class Router {
       const matchPromises = [];
       validResolvedMatches.forEach((match, index) => {
         matchPromises.push(
+          // eslint-disable-next-line no-async-promise-executor
           new Promise(async (resolve, reject) => {
             var _a2;
             const parentMatchPromise = matchPromises[index - 1];
@@ -748,12 +752,13 @@ class Router {
                   meta,
                   headers
                 };
-              } catch (error) {
+              } catch (e) {
+                let error = e;
                 if (latestPromise = checkLatest())
                   return await latestPromise;
-                handleError(error);
+                handleError(e);
                 try {
-                  (_j = (_i = route.options).onError) == null ? void 0 : _j.call(_i, error);
+                  (_j = (_i = route.options).onError) == null ? void 0 : _j.call(_i, e);
                 } catch (onErrorError) {
                   error = onErrorError;
                   handleError(onErrorError);
@@ -768,10 +773,9 @@ class Router {
               updateMatch(match);
             };
             const age = Date.now() - match.updatedAt;
-            let staleAge = preload ? route.options.preloadStaleTime ?? this.options.defaultPreloadStaleTime ?? 3e4 : route.options.staleTime ?? this.options.defaultStaleTime ?? 0;
-            let shouldReload;
+            const staleAge = preload ? route.options.preloadStaleTime ?? this.options.defaultPreloadStaleTime ?? 3e4 : route.options.staleTime ?? this.options.defaultStaleTime ?? 0;
             const shouldReloadOption = route.options.shouldReload;
-            shouldReload = typeof shouldReloadOption === "function" ? shouldReloadOption(loaderContext) : shouldReloadOption;
+            const shouldReload = typeof shouldReloadOption === "function" ? shouldReloadOption(loaderContext) : shouldReloadOption;
             matches[index] = match = {
               ...match,
               preload: !!preload && !this.state.matches.find((d) => d.id === match.id)
@@ -944,7 +948,7 @@ class Router {
       return this.latestLoadPromise;
     };
     this.resolveRedirect = (err) => {
-      let redirect = err;
+      const redirect = err;
       if (!redirect.href) {
         redirect.href = this.buildLocation(redirect).href;
       }
@@ -966,18 +970,17 @@ class Router {
       });
     };
     this.preloadRoute = async (opts) => {
-      var _a;
-      let next = this.buildLocation(opts);
+      const next = this.buildLocation(opts);
       let matches = this.matchRoutes(next.pathname, next.search, {
         throwOnError: true,
         preload: true
       });
       const loadedMatchIds = Object.fromEntries(
-        (_a = [
+        [
           ...this.state.matches,
           ...this.state.pendingMatches ?? [],
           ...this.state.cachedMatches
-        ]) == null ? void 0 : _a.map((d) => [d.id, true])
+        ].map((d) => [d.id, true])
       );
       this.__store.batch(() => {
         matches.forEach((match) => {
@@ -1017,9 +1020,6 @@ class Router {
         return false;
       }
       const baseLocation = (opts == null ? void 0 : opts.pending) ? this.latestLocation : this.state.resolvedLocation;
-      if (!baseLocation) {
-        return false;
-      }
       const match = matchPathname(this.basepath, baseLocation.pathname, {
         ...opts,
         to: next.pathname
@@ -1113,7 +1113,7 @@ class Router {
       this.dehydratedData = ctx.payload;
       (_c = (_b = this.options).hydrate) == null ? void 0 : _c.call(_b, ctx.payload);
       const dehydratedState = ctx.router.state;
-      let matches = this.matchRoutes(
+      const matches = this.matchRoutes(
         this.state.location.pathname,
         this.state.location.search
       ).map((match) => {
@@ -1125,23 +1125,20 @@ class Router {
           dehydratedMatch,
           `Could not find a client-side match for dehydrated match with id: ${match.id}!`
         );
-        if (dehydratedMatch) {
-          const route = this.looseRoutesById[match.routeId];
-          const assets = dehydratedMatch.status === "notFound" || dehydratedMatch.status === "redirected" ? {} : {
-            meta: (_b2 = (_a2 = route.options).meta) == null ? void 0 : _b2.call(_a2, {
-              params: match.params,
-              loaderData: dehydratedMatch.loaderData
-            }),
-            links: (_d = (_c2 = route.options).links) == null ? void 0 : _d.call(_c2),
-            scripts: (_f = (_e = route.options).scripts) == null ? void 0 : _f.call(_e)
-          };
-          return {
-            ...match,
-            ...dehydratedMatch,
-            ...assets
-          };
-        }
-        return match;
+        const route = this.looseRoutesById[match.routeId];
+        const assets = dehydratedMatch.status === "notFound" || dehydratedMatch.status === "redirected" ? {} : {
+          meta: (_b2 = (_a2 = route.options).meta) == null ? void 0 : _b2.call(_a2, {
+            params: match.params,
+            loaderData: dehydratedMatch.loaderData
+          }),
+          links: (_d = (_c2 = route.options).links) == null ? void 0 : _d.call(_c2),
+          scripts: (_f = (_e = route.options).scripts) == null ? void 0 : _f.call(_e)
+        };
+        return {
+          ...match,
+          ...dehydratedMatch,
+          ...assets
+        };
       });
       this.__store.setState((s) => {
         return {
@@ -1157,13 +1154,13 @@ class Router {
       );
       let routeCursor = (err.global ? this.looseRoutesById[rootRouteId] : this.looseRoutesById[err.routeId]) || this.looseRoutesById[rootRouteId];
       while (!routeCursor.options.notFoundComponent && !this.options.defaultNotFoundComponent && routeCursor.id !== rootRouteId) {
-        routeCursor = routeCursor == null ? void 0 : routeCursor.parentRoute;
+        routeCursor = routeCursor.parentRoute;
         invariant(
           routeCursor,
           "Found invalid route tree while trying to find not-found handler."
         );
       }
-      let match = matchesByRouteId[routeCursor.id];
+      const match = matchesByRouteId[routeCursor.id];
       invariant(match, "Could not find match for route: " + routeCursor.id);
       Object.assign(match, {
         status: "notFound",
@@ -1182,9 +1179,9 @@ class Router {
       defaultPendingMinMs: 500,
       context: void 0,
       ...options,
-      stringifySearch: (options == null ? void 0 : options.stringifySearch) ?? defaultStringifySearch,
-      parseSearch: (options == null ? void 0 : options.parseSearch) ?? defaultParseSearch,
-      transformer: (options == null ? void 0 : options.transformer) ?? JSON
+      stringifySearch: options.stringifySearch ?? defaultStringifySearch,
+      parseSearch: options.parseSearch ?? defaultParseSearch,
+      transformer: options.transformer ?? JSON
     });
     if (typeof document !== "undefined") {
       window.__TSR__ROUTER__ = this;