@tanstack/react-router 1.49.0 → 1.49.2

package/dist/cjs/route.d.cts

@@ -33,8 +33,13 @@ export type RoutePathOptionsIntersection<TCustomId, TPath> = {
     id: TCustomId;
 };
 export type RouteOptions<TParentRoute extends AnyRoute = AnyRoute, TCustomId extends string = string, TPath extends string = string, TSearchValidator extends AnySearchValidator = DefaultSearchValidator, TParams = AnyPathParams, TAllParams = TParams, TLoaderDeps extends Record<string, any> = {}, TLoaderDataReturn = {}, TLoaderData = ResolveLoaderData<TLoaderDataReturn>, TRouterContext = {}, TRouteContextFn = AnyContext, TBeforeLoadFn = AnyContext> = BaseRouteOptions<TParentRoute, TCustomId, TPath, TSearchValidator, TParams, TLoaderDeps, TLoaderDataReturn, TRouterContext, TRouteContextFn, TBeforeLoadFn> & UpdatableRouteOptions<NoInfer<TParentRoute>, NoInfer<TCustomId>, NoInfer<TAllParams>, NoInfer<TSearchValidator>, NoInfer<TLoaderData>, NoInfer<TLoaderDeps>, NoInfer<TRouterContext>, NoInfer<TRouteContextFn>, NoInfer<TBeforeLoadFn>>;
-export type ParseParamsFn<TPath extends string, TParams> = (rawParams: Record<ParsePathParams<TPath>, string>) => TParams extends Record<ParsePathParams<TPath>, any> ? TParams : Record<ParsePathParams<TPath>, any>;
-export type StringifyParamsFn<TPath extends string, TParams> = (params: TParams) => Record<ParsePathParams<TPath>, string>;
+export type ParseSplatParams<TPath extends string> = TPath extends `${string}$` ? '_splat' : TPath extends `${string}$/${string}` ? '_splat' : never;
+export interface SplatParams {
+    _splat?: string;
+}
+export type ResolveParams<TPath extends string> = ParseSplatParams<TPath> extends never ? Record<ParsePathParams<TPath>, string> : Record<ParsePathParams<TPath>, string> & SplatParams;
+export type ParseParamsFn<TPath extends string, TParams> = (rawParams: ResolveParams<TPath>) => TParams extends Record<ParsePathParams<TPath>, any> ? TParams : Record<ParsePathParams<TPath>, any>;
+export type StringifyParamsFn<TPath extends string, TParams> = (params: TParams) => ResolveParams<TPath>;
 export type ParamsOptions<TPath extends string, TParams> = {
     params?: {
         parse: ParseParamsFn<TPath, TParams>;
@@ -278,7 +283,7 @@ export declare class RouteApi<TId extends RouteIds<RegisteredRouter['routeTree']
     useNavigate: () => UseNavigateResult<TRoute["fullPath"]>;
     notFound: (opts?: NotFoundError) => NotFoundError;
 }
-export declare class Route<in out TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute, in out TPath extends RouteConstraints['TPath'] = '/', in out TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath<TParentRoute, TPath>, in out TCustomId extends RouteConstraints['TCustomId'] = string, in out TId extends RouteConstraints['TId'] = ResolveId<TParentRoute, TCustomId, TPath>, in out TSearchValidator extends AnySearchValidator = DefaultSearchValidator, in out TParams = Record<ParsePathParams<TPath>, string>, in out TAllParams = ResolveAllParamsFromParent<TParentRoute, TParams>, in out TRouterContext = AnyContext, in out TRouteContextFn = AnyContext, in out TBeforeLoadFn = AnyContext, in out TLoaderDeps extends Record<string, any> = {}, TLoaderDataReturn = {}, in out TLoaderData = ResolveLoaderData<TLoaderDataReturn>, in out TChildren = unknown> {
+export declare class Route<in out TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute, in out TPath extends RouteConstraints['TPath'] = '/', in out TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath<TParentRoute, TPath>, in out TCustomId extends RouteConstraints['TCustomId'] = string, in out TId extends RouteConstraints['TId'] = ResolveId<TParentRoute, TCustomId, TPath>, in out TSearchValidator extends AnySearchValidator = DefaultSearchValidator, in out TParams = ResolveParams<TPath>, in out TAllParams = ResolveAllParamsFromParent<TParentRoute, TParams>, in out TRouterContext = AnyContext, in out TRouteContextFn = AnyContext, in out TBeforeLoadFn = AnyContext, in out TLoaderDeps extends Record<string, any> = {}, TLoaderDataReturn = {}, in out TLoaderData = ResolveLoaderData<TLoaderDataReturn>, in out TChildren = unknown> {
     isRoot: TParentRoute extends Route<any> ? true : false;
     options: RouteOptions<TParentRoute, TCustomId, TPath, TSearchValidator, TParams, TAllParams, TLoaderDeps, TLoaderDataReturn, TLoaderData, TRouterContext, TRouteContextFn, TBeforeLoadFn>;
     parentRoute: TParentRoute;
@@ -348,7 +353,7 @@ export declare class Route<in out TParentRoute extends RouteConstraints['TParent
     }) => TSelected;
     useNavigate: () => UseNavigateResult<TFullPath>;
 }
-export declare function createRoute<TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute, TPath extends RouteConstraints['TPath'] = '/', TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath<TParentRoute, TPath>, TCustomId extends RouteConstraints['TCustomId'] = string, TId extends RouteConstraints['TId'] = ResolveId<TParentRoute, TCustomId, TPath>, TSearchValidator extends AnySearchValidator = DefaultSearchValidator, TParams = Record<ParsePathParams<TPath>, string>, TAllParams = ResolveAllParamsFromParent<TParentRoute, TParams>, TRouteContextFn = AnyContext, TBeforeLoadFn = AnyContext, TLoaderDeps extends Record<string, any> = {}, TLoaderDataReturn = {}, TLoaderData = ResolveLoaderData<TLoaderDataReturn>, TChildren = unknown>(options: RouteOptions<TParentRoute, TCustomId, TPath, TSearchValidator, TParams, TAllParams, TLoaderDeps, TLoaderDataReturn, TLoaderData, AnyContext, TRouteContextFn, TBeforeLoadFn>): Route<TParentRoute, TPath, TFullPath, TCustomId, TId, TSearchValidator, TParams, TAllParams, AnyContext, TRouteContextFn, TBeforeLoadFn, TLoaderDeps, TLoaderDataReturn, TLoaderData, TChildren>;
+export declare function createRoute<TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute, TPath extends RouteConstraints['TPath'] = '/', TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath<TParentRoute, TPath>, TCustomId extends RouteConstraints['TCustomId'] = string, TId extends RouteConstraints['TId'] = ResolveId<TParentRoute, TCustomId, TPath>, TSearchValidator extends AnySearchValidator = DefaultSearchValidator, TParams = ResolveParams<TPath>, TAllParams = ResolveAllParamsFromParent<TParentRoute, TParams>, TRouteContextFn = AnyContext, TBeforeLoadFn = AnyContext, TLoaderDeps extends Record<string, any> = {}, TLoaderDataReturn = {}, TLoaderData = ResolveLoaderData<TLoaderDataReturn>, TChildren = unknown>(options: RouteOptions<TParentRoute, TCustomId, TPath, TSearchValidator, TParams, TAllParams, TLoaderDeps, TLoaderDataReturn, TLoaderData, AnyContext, TRouteContextFn, TBeforeLoadFn>): Route<TParentRoute, TPath, TFullPath, TCustomId, TId, TSearchValidator, TParams, TAllParams, AnyContext, TRouteContextFn, TBeforeLoadFn, TLoaderDeps, TLoaderDataReturn, TLoaderData, TChildren>;
 export type AnyRootRoute = RootRoute<any, any, any, any, any, any, any, any>;
 export type RootRouteOptions<TSearchValidator extends AnySearchValidator = DefaultSearchValidator, TRouterContext = {}, TRouteContextFn = AnyContext, TBeforeLoadFn = AnyContext, TLoaderDeps extends Record<string, any> = {}, TLoaderDataReturn = {}, TLoaderData = ResolveLoaderData<TLoaderDataReturn>> = Omit<RouteOptions<any, // TParentRoute
 RootRouteId, // TCustomId

package/dist/cjs/router.cjs

@@ -211,200 +211,6 @@ class Router {
       });
       return resolvedPath;
     };
-    this.matchRoutes = (next, opts) => {
-      let routeParams = {};
-      const foundRoute = this.flatRoutes.find((route) => {
-        const matchedParams = path.matchPathname(
-          this.basepath,
-          path.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[root.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
-          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 root.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 = path.interpolatePath({
-          path: route.fullPath,
-          params: routeParams
-        });
-        const matchId = path.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: path.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: utils.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 = utils.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;
@@ -1416,6 +1222,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 = path.matchPathname(
+        this.basepath,
+        path.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[root.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
+        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 root.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 = path.interpolatePath({
+        path: route.fullPath,
+        params: routeParams
+      });
+      const matchId = path.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: path.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: utils.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 = utils.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) => {