@tanstack/react-router 1.49.1 → 1.49.2

package/dist/cjs/router.d.cts

@@ -1,7 +1,7 @@
 import { Store, NoInfer } from '@tanstack/react-store';
 import { HistoryState, RouterHistory } from '@tanstack/history';
 import { Manifest } from './manifest.cjs';
-import { AnyContext, AnyRoute, AnyRouteWithContext, ErrorRouteComponent, NotFoundRouteComponent, RootRoute, RouteComponent, RouteMask } from './route.cjs';
+import { AnyContext, AnyRoute, AnyRouteWithContext, AnySearchSchema, ErrorRouteComponent, NotFoundRouteComponent, RootRoute, RouteComponent, RouteMask } from './route.cjs';
 import { FullSearchSchema, RouteById, RoutePaths, RoutesById, RoutesByPath } from './routeInfo.cjs';
 import { ControlledPromise, NonNullableUpdater, PickAsRequired, Updater } from './utils.cjs';
 import { AnyRouteMatch, MakeRouteMatch, MatchRouteOptions } from './Matches.cjs';
@@ -423,6 +423,10 @@ export type RouterListener<TRouterEvent extends RouterEvent> = {
     fn: ListenerFn<TRouterEvent>;
 };
 export declare function createRouter<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDehydrated extends Record<string, any> = Record<string, any>, TSerializedError extends Record<string, any> = Record<string, any>>(options: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDehydrated, TSerializedError>): Router<TRouteTree, TTrailingSlashOption, TDehydrated, TSerializedError>;
+type MatchRoutesOpts = {
+    preload?: boolean;
+    throwOnError?: boolean;
+};
 export declare class Router<in out TRouteTree extends AnyRoute, in out TTrailingSlashOption extends TrailingSlashOption, 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;
@@ -465,10 +469,18 @@ export declare class Router<in out TRouteTree extends AnyRoute, in out TTrailing
     parseLocation: (previousLocation?: ParsedLocation<FullSearchSchema<TRouteTree>>) => ParsedLocation<FullSearchSchema<TRouteTree>>;
     resolvePathWithBase: (from: string, path: string) => string;
     get looseRoutesById(): Record<string, AnyRoute>;
-    matchRoutes: (next: ParsedLocation, opts?: {
-        preload?: boolean;
-        throwOnError?: boolean;
-    }) => Array<AnyRouteMatch>;
+    /**
+    @deprecated use the following signature instead
+    ```ts
+    matchRoutes (
+      next: ParsedLocation,
+      opts?: { preload?: boolean; throwOnError?: boolean },
+    ): Array<AnyRouteMatch>;
+    ```
+  */
+    matchRoutes(pathname: string, locationSearch: AnySearchSchema, opts?: MatchRoutesOpts): Array<AnyRouteMatch>;
+    matchRoutes(next: ParsedLocation, opts?: MatchRoutesOpts): Array<AnyRouteMatch>;
+    private matchRoutesInternal;
     cancelMatch: (id: string) => void;
     cancelMatches: () => void;
     buildLocation: BuildLocationFn;
@@ -518,3 +530,4 @@ export declare function defaultSerializeError(err: unknown): {
 } | {
     data: unknown;
 };
+export {};

package/dist/esm/router.d.ts

@@ -1,7 +1,7 @@
 import { Store, NoInfer } from '@tanstack/react-store';
 import { HistoryState, RouterHistory } from '@tanstack/history';
 import { Manifest } from './manifest.js';
-import { AnyContext, AnyRoute, AnyRouteWithContext, ErrorRouteComponent, NotFoundRouteComponent, RootRoute, RouteComponent, RouteMask } from './route.js';
+import { AnyContext, AnyRoute, AnyRouteWithContext, AnySearchSchema, ErrorRouteComponent, NotFoundRouteComponent, RootRoute, RouteComponent, RouteMask } from './route.js';
 import { FullSearchSchema, RouteById, RoutePaths, RoutesById, RoutesByPath } from './routeInfo.js';
 import { ControlledPromise, NonNullableUpdater, PickAsRequired, Updater } from './utils.js';
 import { AnyRouteMatch, MakeRouteMatch, MatchRouteOptions } from './Matches.js';
@@ -423,6 +423,10 @@ export type RouterListener<TRouterEvent extends RouterEvent> = {
     fn: ListenerFn<TRouterEvent>;
 };
 export declare function createRouter<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDehydrated extends Record<string, any> = Record<string, any>, TSerializedError extends Record<string, any> = Record<string, any>>(options: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDehydrated, TSerializedError>): Router<TRouteTree, TTrailingSlashOption, TDehydrated, TSerializedError>;
+type MatchRoutesOpts = {
+    preload?: boolean;
+    throwOnError?: boolean;
+};
 export declare class Router<in out TRouteTree extends AnyRoute, in out TTrailingSlashOption extends TrailingSlashOption, 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;
@@ -465,10 +469,18 @@ export declare class Router<in out TRouteTree extends AnyRoute, in out TTrailing
     parseLocation: (previousLocation?: ParsedLocation<FullSearchSchema<TRouteTree>>) => ParsedLocation<FullSearchSchema<TRouteTree>>;
     resolvePathWithBase: (from: string, path: string) => string;
     get looseRoutesById(): Record<string, AnyRoute>;
-    matchRoutes: (next: ParsedLocation, opts?: {
-        preload?: boolean;
-        throwOnError?: boolean;
-    }) => Array<AnyRouteMatch>;
+    /**
+    @deprecated use the following signature instead
+    ```ts
+    matchRoutes (
+      next: ParsedLocation,
+      opts?: { preload?: boolean; throwOnError?: boolean },
+    ): Array<AnyRouteMatch>;
+    ```
+  */
+    matchRoutes(pathname: string, locationSearch: AnySearchSchema, opts?: MatchRoutesOpts): Array<AnyRouteMatch>;
+    matchRoutes(next: ParsedLocation, opts?: MatchRoutesOpts): Array<AnyRouteMatch>;
+    private matchRoutesInternal;
     cancelMatch: (id: string) => void;
     cancelMatches: () => void;
     buildLocation: BuildLocationFn;
@@ -518,3 +530,4 @@ export declare function defaultSerializeError(err: unknown): {
 } | {
     data: unknown;
 };
+export {};

package/dist/esm/router.js

@@ -4,7 +4,7 @@ import invariant from "tiny-invariant";
 import warning from "tiny-warning";
 import { rootRouteId } from "./root.js";
 import { defaultStringifySearch, defaultParseSearch } from "./searchParams.js";
-import { createControlledPromise, replaceEqualDeep, pick, deepEqual, last, functionalUpdate } from "./utils.js";
+import { pick, createControlledPromise, deepEqual, replaceEqualDeep, last, functionalUpdate } from "./utils.js";
 import { trimPath, trimPathLeft, parsePathname, resolvePath, cleanPath, matchPathname, trimPathRight, interpolatePath, joinPaths } from "./path.js";
 import { isResolvedRedirect, isRedirect } from "./redirects.js";
 import { isNotFound } from "./not-found.js";
@@ -209,200 +209,6 @@ class Router {
       });
       return resolvedPath;
     };
-    this.matchRoutes = (next, opts) => {
-      let routeParams = {};
-      const foundRoute = this.flatRoutes.find((route) => {
-        const matchedParams = matchPathname(
-          this.basepath,
-          trimPathRight(next.pathname),
-          {
-            to: route.fullPath,
-            caseSensitive: route.options.caseSensitive ?? this.options.caseSensitive,
-            fuzzy: true
-          }
-        );
-        if (matchedParams) {
-          routeParams = matchedParams;
-          return true;
-        }
-        return false;
-      });
-      let routeCursor = foundRoute || this.routesById[rootRouteId];
-      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
-        foundRoute ? foundRoute.path !== "/" && routeParams["**"] : (
-          // Or if we didn't find a route and we have left over path
-          trimPathRight(next.pathname)
-        )
-      ) {
-        if (this.options.notFoundRoute) {
-          matchedRoutes.push(this.options.notFoundRoute);
-        } else {
-          isGlobalNotFound = true;
-        }
-      }
-      while (routeCursor.parentRoute) {
-        routeCursor = routeCursor.parentRoute;
-        matchedRoutes.unshift(routeCursor);
-      }
-      const globalNotFoundRouteId = (() => {
-        if (!isGlobalNotFound) {
-          return void 0;
-        }
-        if (this.options.notFoundMode !== "root") {
-          for (let i = matchedRoutes.length - 1; i >= 0; i--) {
-            const route = matchedRoutes[i];
-            if (route.children) {
-              return route.id;
-            }
-          }
-        }
-        return rootRouteId;
-      })();
-      const parseErrors = matchedRoutes.map((route) => {
-        var _a;
-        let parsedParamsError;
-        const parseParams = ((_a = route.options.params) == null ? void 0 : _a.parse) ?? route.options.parseParams;
-        if (parseParams) {
-          try {
-            const parsedParams = parseParams(routeParams);
-            Object.assign(routeParams, parsedParams);
-          } catch (err) {
-            parsedParamsError = new PathParamError(err.message, {
-              cause: err
-            });
-            if (opts == null ? void 0 : opts.throwOnError) {
-              throw parsedParamsError;
-            }
-            return parsedParamsError;
-          }
-        }
-        return;
-      });
-      const matches = [];
-      matchedRoutes.forEach((route, index) => {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l;
-        const parentMatch = matches[index - 1];
-        const [preMatchSearch, searchError] = (() => {
-          const parentSearch = (parentMatch == null ? void 0 : parentMatch.search) ?? next.search;
-          try {
-            const validator = typeof route.options.validateSearch === "object" ? route.options.validateSearch.parse : route.options.validateSearch;
-            const search = (validator == null ? void 0 : validator(parentSearch)) ?? {};
-            return [
-              {
-                ...parentSearch,
-                ...search
-              },
-              void 0
-            ];
-          } catch (err) {
-            const searchParamError = new SearchParamError(err.message, {
-              cause: err
-            });
-            if (opts == null ? void 0 : opts.throwOnError) {
-              throw searchParamError;
-            }
-            return [parentSearch, searchParamError];
-          }
-        })();
-        const loaderDeps = ((_b = (_a = route.options).loaderDeps) == null ? void 0 : _b.call(_a, {
-          search: preMatchSearch
-        })) ?? "";
-        const loaderDepsHash = loaderDeps ? JSON.stringify(loaderDeps) : "";
-        const interpolatedPath = interpolatePath({
-          path: route.fullPath,
-          params: routeParams
-        });
-        const matchId = interpolatePath({
-          path: route.id,
-          params: routeParams,
-          leaveWildcards: true
-        }) + loaderDepsHash;
-        const existingMatch = this.getMatch(matchId);
-        const cause = this.state.matches.find((d) => d.id === matchId) ? "stay" : "enter";
-        let match;
-        if (existingMatch) {
-          match = {
-            ...existingMatch,
-            cause,
-            params: routeParams
-          };
-        } else {
-          const status = route.options.loader || route.options.beforeLoad || route.lazyFn ? "pending" : "success";
-          match = {
-            id: matchId,
-            index,
-            routeId: route.id,
-            params: routeParams,
-            pathname: joinPaths([this.basepath, interpolatedPath]),
-            updatedAt: Date.now(),
-            search: {},
-            searchError: void 0,
-            status,
-            isFetching: false,
-            error: void 0,
-            paramsError: parseErrors[index],
-            __routeContext: {},
-            __beforeLoadContext: {},
-            context: {},
-            abortController: new AbortController(),
-            fetchCount: 0,
-            cause,
-            loaderDeps,
-            invalid: false,
-            preload: false,
-            links: (_d = (_c = route.options).links) == null ? void 0 : _d.call(_c),
-            scripts: (_f = (_e = route.options).scripts) == null ? void 0 : _f.call(_e),
-            staticData: route.options.staticData || {},
-            loadPromise: createControlledPromise()
-          };
-        }
-        if (match.status === "success") {
-          match.meta = (_h = (_g = route.options).meta) == null ? void 0 : _h.call(_g, {
-            matches,
-            match,
-            params: match.params,
-            loaderData: match.loaderData
-          });
-          match.headers = (_j = (_i = route.options).headers) == null ? void 0 : _j.call(_i, {
-            loaderData: match.loaderData
-          });
-        }
-        if (!(opts == null ? void 0 : opts.preload)) {
-          match.globalNotFound = globalNotFoundRouteId === route.id;
-        }
-        match.search = replaceEqualDeep(match.search, preMatchSearch);
-        match.searchError = searchError;
-        const parentMatchId = parentMatch == null ? void 0 : parentMatch.id;
-        const parentContext = !parentMatchId ? this.options.context ?? {} : parentMatch.context ?? this.options.context ?? {};
-        match.context = {
-          ...parentContext,
-          ...match.__routeContext,
-          ...match.__beforeLoadContext
-        };
-        const contextFnContext = {
-          search: match.search,
-          params: match.params,
-          context: match.context,
-          location: next,
-          navigate: (opts2) => this.navigate({ ...opts2, _fromLocation: next }),
-          buildLocation: this.buildLocation,
-          cause: match.cause,
-          abortController: match.abortController,
-          preload: !!match.preload
-        };
-        match.__routeContext = ((_l = (_k = route.options).context) == null ? void 0 : _l.call(_k, contextFnContext)) ?? {};
-        match.context = {
-          ...parentContext,
-          ...match.__routeContext,
-          ...match.__beforeLoadContext
-        };
-        matches.push(match);
-      });
-      return matches;
-    };
     this.cancelMatch = (id) => {
       const match = this.getMatch(id);
       if (!match) return;
@@ -1414,6 +1220,213 @@ class Router {
   get looseRoutesById() {
     return this.routesById;
   }
+  matchRoutes(pathnameOrNext, locationSearchOrOpts, opts) {
+    if (typeof pathnameOrNext === "string") {
+      return this.matchRoutesInternal(
+        {
+          pathname: pathnameOrNext,
+          search: locationSearchOrOpts
+        },
+        opts
+      );
+    } else {
+      return this.matchRoutesInternal(pathnameOrNext, locationSearchOrOpts);
+    }
+  }
+  matchRoutesInternal(next, opts) {
+    let routeParams = {};
+    const foundRoute = this.flatRoutes.find((route) => {
+      const matchedParams = matchPathname(
+        this.basepath,
+        trimPathRight(next.pathname),
+        {
+          to: route.fullPath,
+          caseSensitive: route.options.caseSensitive ?? this.options.caseSensitive,
+          fuzzy: true
+        }
+      );
+      if (matchedParams) {
+        routeParams = matchedParams;
+        return true;
+      }
+      return false;
+    });
+    let routeCursor = foundRoute || this.routesById[rootRouteId];
+    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
+      foundRoute ? foundRoute.path !== "/" && routeParams["**"] : (
+        // Or if we didn't find a route and we have left over path
+        trimPathRight(next.pathname)
+      )
+    ) {
+      if (this.options.notFoundRoute) {
+        matchedRoutes.push(this.options.notFoundRoute);
+      } else {
+        isGlobalNotFound = true;
+      }
+    }
+    while (routeCursor.parentRoute) {
+      routeCursor = routeCursor.parentRoute;
+      matchedRoutes.unshift(routeCursor);
+    }
+    const globalNotFoundRouteId = (() => {
+      if (!isGlobalNotFound) {
+        return void 0;
+      }
+      if (this.options.notFoundMode !== "root") {
+        for (let i = matchedRoutes.length - 1; i >= 0; i--) {
+          const route = matchedRoutes[i];
+          if (route.children) {
+            return route.id;
+          }
+        }
+      }
+      return rootRouteId;
+    })();
+    const parseErrors = matchedRoutes.map((route) => {
+      var _a;
+      let parsedParamsError;
+      const parseParams = ((_a = route.options.params) == null ? void 0 : _a.parse) ?? route.options.parseParams;
+      if (parseParams) {
+        try {
+          const parsedParams = parseParams(routeParams);
+          Object.assign(routeParams, parsedParams);
+        } catch (err) {
+          parsedParamsError = new PathParamError(err.message, {
+            cause: err
+          });
+          if (opts == null ? void 0 : opts.throwOnError) {
+            throw parsedParamsError;
+          }
+          return parsedParamsError;
+        }
+      }
+      return;
+    });
+    const matches = [];
+    matchedRoutes.forEach((route, index) => {
+      var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l;
+      const parentMatch = matches[index - 1];
+      const [preMatchSearch, searchError] = (() => {
+        const parentSearch = (parentMatch == null ? void 0 : parentMatch.search) ?? next.search;
+        try {
+          const validator = typeof route.options.validateSearch === "object" ? route.options.validateSearch.parse : route.options.validateSearch;
+          const search = (validator == null ? void 0 : validator(parentSearch)) ?? {};
+          return [
+            {
+              ...parentSearch,
+              ...search
+            },
+            void 0
+          ];
+        } catch (err) {
+          const searchParamError = new SearchParamError(err.message, {
+            cause: err
+          });
+          if (opts == null ? void 0 : opts.throwOnError) {
+            throw searchParamError;
+          }
+          return [parentSearch, searchParamError];
+        }
+      })();
+      const loaderDeps = ((_b = (_a = route.options).loaderDeps) == null ? void 0 : _b.call(_a, {
+        search: preMatchSearch
+      })) ?? "";
+      const loaderDepsHash = loaderDeps ? JSON.stringify(loaderDeps) : "";
+      const interpolatedPath = interpolatePath({
+        path: route.fullPath,
+        params: routeParams
+      });
+      const matchId = interpolatePath({
+        path: route.id,
+        params: routeParams,
+        leaveWildcards: true
+      }) + loaderDepsHash;
+      const existingMatch = this.getMatch(matchId);
+      const cause = this.state.matches.find((d) => d.id === matchId) ? "stay" : "enter";
+      let match;
+      if (existingMatch) {
+        match = {
+          ...existingMatch,
+          cause,
+          params: routeParams
+        };
+      } else {
+        const status = route.options.loader || route.options.beforeLoad || route.lazyFn ? "pending" : "success";
+        match = {
+          id: matchId,
+          index,
+          routeId: route.id,
+          params: routeParams,
+          pathname: joinPaths([this.basepath, interpolatedPath]),
+          updatedAt: Date.now(),
+          search: {},
+          searchError: void 0,
+          status,
+          isFetching: false,
+          error: void 0,
+          paramsError: parseErrors[index],
+          __routeContext: {},
+          __beforeLoadContext: {},
+          context: {},
+          abortController: new AbortController(),
+          fetchCount: 0,
+          cause,
+          loaderDeps,
+          invalid: false,
+          preload: false,
+          links: (_d = (_c = route.options).links) == null ? void 0 : _d.call(_c),
+          scripts: (_f = (_e = route.options).scripts) == null ? void 0 : _f.call(_e),
+          staticData: route.options.staticData || {},
+          loadPromise: createControlledPromise()
+        };
+      }
+      if (match.status === "success") {
+        match.meta = (_h = (_g = route.options).meta) == null ? void 0 : _h.call(_g, {
+          matches,
+          match,
+          params: match.params,
+          loaderData: match.loaderData
+        });
+        match.headers = (_j = (_i = route.options).headers) == null ? void 0 : _j.call(_i, {
+          loaderData: match.loaderData
+        });
+      }
+      if (!(opts == null ? void 0 : opts.preload)) {
+        match.globalNotFound = globalNotFoundRouteId === route.id;
+      }
+      match.search = replaceEqualDeep(match.search, preMatchSearch);
+      match.searchError = searchError;
+      const parentMatchId = parentMatch == null ? void 0 : parentMatch.id;
+      const parentContext = !parentMatchId ? this.options.context ?? {} : parentMatch.context ?? this.options.context ?? {};
+      match.context = {
+        ...parentContext,
+        ...match.__routeContext,
+        ...match.__beforeLoadContext
+      };
+      const contextFnContext = {
+        search: match.search,
+        params: match.params,
+        context: match.context,
+        location: next,
+        navigate: (opts2) => this.navigate({ ...opts2, _fromLocation: next }),
+        buildLocation: this.buildLocation,
+        cause: match.cause,
+        abortController: match.abortController,
+        preload: !!match.preload
+      };
+      match.__routeContext = ((_l = (_k = route.options).context) == null ? void 0 : _l.call(_k, contextFnContext)) ?? {};
+      match.context = {
+        ...parentContext,
+        ...match.__routeContext,
+        ...match.__beforeLoadContext
+      };
+      matches.push(match);
+    });
+    return matches;
+  }
 }
 function lazyFn(fn, key) {
   return async (...args) => {