@tanstack/router-core 1.120.5 → 1.121.0-alpha.1

package/dist/esm/router.js

@@ -2,12 +2,12 @@ import { Store, batch } from "@tanstack/store";
 import { createMemoryHistory, createBrowserHistory, parseHref } from "@tanstack/history";
 import invariant from "tiny-invariant";
 import { pick, createControlledPromise, deepEqual, replaceEqualDeep, last, functionalUpdate } from "./utils.js";
-import { trimPath, trimPathLeft, parsePathname, resolvePath, cleanPath, trimPathRight, matchPathname, interpolatePath, joinPaths } from "./path.js";
+import { trimPath, resolvePath, cleanPath, matchPathname, trimPathRight, interpolatePath, joinPaths, trimPathLeft, parsePathname } from "./path.js";
 import { isNotFound } from "./not-found.js";
 import { setupScrollRestoration } from "./scroll-restoration.js";
 import { defaultParseSearch, defaultStringifySearch } from "./searchParams.js";
 import { rootRouteId } from "./root.js";
-import { isResolvedRedirect, isRedirect } from "./redirect.js";
+import { isRedirect } from "./redirect.js";
 function defaultSerializeError(err) {
   if (err instanceof Error) {
     const obj = {
@@ -46,6 +46,7 @@ class RouterCore {
     this.isScrollRestoring = false;
     this.isScrollRestorationSetup = false;
     this.startTransition = (fn) => fn();
+    this.isShell = false;
     this.update = (newOptions) => {
       var _a;
       if (newOptions.notFoundRoute) {
@@ -72,10 +73,7 @@ class RouterCore {
           this.basepath = `/${trimPath(newOptions.basepath)}`;
         }
       }
-      if (
-        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-        !this.history || this.options.history && this.options.history !== this.history
-      ) {
+      if (!this.history || this.options.history && this.options.history !== this.history) {
         this.history = this.options.history ?? (this.isServer ? createMemoryHistory({
           initialEntries: [this.basepath || "/"]
         }) : createBrowserHistory());
@@ -98,16 +96,28 @@ class RouterCore {
         });
         setupScrollRestoration(this);
       }
-      if (typeof window !== "undefined" && "CSS" in window && // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-      typeof ((_a = window.CSS) == null ? void 0 : _a.supports) === "function") {
+      if (typeof window !== "undefined" && "CSS" in window && typeof ((_a = window.CSS) == null ? void 0 : _a.supports) === "function") {
         this.isViewTransitionTypesSupported = window.CSS.supports(
           "selector(:active-view-transition-type(a)"
         );
       }
+      if (this.latestLocation.search.__TSS_SHELL) {
+        this.isShell = true;
+      }
     };
     this.buildRouteTree = () => {
-      this.routesById = {};
-      this.routesByPath = {};
+      const { routesById, routesByPath, flatRoutes } = processRouteTree({
+        routeTree: this.routeTree,
+        initRoute: (route, i) => {
+          route.init({
+            originalIndex: i,
+            defaultSsr: this.options.defaultSsr
+          });
+        }
+      });
+      this.routesById = routesById;
+      this.routesByPath = routesByPath;
+      this.flatRoutes = flatRoutes;
       const notFoundRoute = this.options.notFoundRoute;
       if (notFoundRoute) {
         notFoundRoute.init({
@@ -116,77 +126,6 @@ class RouterCore {
         });
         this.routesById[notFoundRoute.id] = notFoundRoute;
       }
-      const recurseRoutes = (childRoutes) => {
-        childRoutes.forEach((childRoute, i) => {
-          childRoute.init({
-            originalIndex: i,
-            defaultSsr: this.options.defaultSsr
-          });
-          const existingRoute = this.routesById[childRoute.id];
-          invariant(
-            !existingRoute,
-            `Duplicate routes found with id: ${String(childRoute.id)}`
-          );
-          this.routesById[childRoute.id] = childRoute;
-          if (!childRoute.isRoot && childRoute.path) {
-            const trimmedFullPath = trimPathRight(childRoute.fullPath);
-            if (!this.routesByPath[trimmedFullPath] || childRoute.fullPath.endsWith("/")) {
-              this.routesByPath[trimmedFullPath] = childRoute;
-            }
-          }
-          const children = childRoute.children;
-          if (children == null ? void 0 : children.length) {
-            recurseRoutes(children);
-          }
-        });
-      };
-      recurseRoutes([this.routeTree]);
-      const scoredRoutes = [];
-      const routes = Object.values(this.routesById);
-      routes.forEach((d, i) => {
-        var _a;
-        if (d.isRoot || !d.path) {
-          return;
-        }
-        const trimmed = trimPathLeft(d.fullPath);
-        const parsed = parsePathname(trimmed);
-        while (parsed.length > 1 && ((_a = parsed[0]) == null ? void 0 : _a.value) === "/") {
-          parsed.shift();
-        }
-        const scores = parsed.map((segment) => {
-          if (segment.value === "/") {
-            return 0.75;
-          }
-          if (segment.type === "param") {
-            return 0.5;
-          }
-          if (segment.type === "wildcard") {
-            return 0.25;
-          }
-          return 1;
-        });
-        scoredRoutes.push({ child: d, trimmed, parsed, index: i, scores });
-      });
-      this.flatRoutes = scoredRoutes.sort((a, b) => {
-        const minLength = Math.min(a.scores.length, b.scores.length);
-        for (let i = 0; i < minLength; i++) {
-          if (a.scores[i] !== b.scores[i]) {
-            return b.scores[i] - a.scores[i];
-          }
-        }
-        if (a.scores.length !== b.scores.length) {
-          return b.scores.length - a.scores.length;
-        }
-        for (let i = 0; i < minLength; i++) {
-          if (a.parsed[i].value !== b.parsed[i].value) {
-            return a.parsed[i].value > b.parsed[i].value ? 1 : -1;
-          }
-        }
-        return a.index - b.index;
-      }).map((d, i) => {
-        d.child.rank = i;
-        return d.child;
-      });
     };
     this.subscribe = (eventType, fn) => {
       const listener = {
@@ -259,37 +198,16 @@ class RouterCore {
         return this.matchRoutesInternal(pathnameOrNext, locationSearchOrOpts);
       }
     };
-    this.getMatchedRoutes = (next, dest) => {
-      let routeParams = {};
-      const trimmedPath = trimPathRight(next.pathname);
-      const getMatchedParams = (route) => {
-        const result = matchPathname(this.basepath, trimmedPath, {
-          to: route.fullPath,
-          caseSensitive: route.options.caseSensitive ?? this.options.caseSensitive,
-          fuzzy: true
-        });
-        return result;
-      };
-      let foundRoute = (dest == null ? void 0 : dest.to) !== void 0 ? this.routesByPath[dest.to] : void 0;
-      if (foundRoute) {
-        routeParams = getMatchedParams(foundRoute);
-      } else {
-        foundRoute = this.flatRoutes.find((route) => {
-          const matchedParams = getMatchedParams(route);
-          if (matchedParams) {
-            routeParams = matchedParams;
-            return true;
-          }
-          return false;
-        });
-      }
-      let routeCursor = foundRoute || this.routesById[rootRouteId];
-      const matchedRoutes = [routeCursor];
-      while (routeCursor.parentRoute) {
-        routeCursor = routeCursor.parentRoute;
-        matchedRoutes.unshift(routeCursor);
-      }
-      return { matchedRoutes, routeParams, foundRoute };
+    this.getMatchedRoutes = (pathname, routePathname) => {
+      return getMatchedRoutes({
+        pathname,
+        routePathname,
+        basepath: this.basepath,
+        caseSensitive: this.options.caseSensitive,
+        routesByPath: this.routesByPath,
+        routesById: this.routesById,
+        flatRoutes: this.flatRoutes
+      });
     };
     this.cancelMatch = (id) => {
       const match = this.getMatch(id);
@@ -502,10 +420,16 @@ class RouterCore {
             maskedNext = build(maskedDest);
           }
         }
-        const nextMatches = this.getMatchedRoutes(next, dest);
+        const nextMatches = this.getMatchedRoutes(
+          next.pathname,
+          dest.to
+        );
         const final = build(dest, nextMatches);
         if (maskedNext) {
-          const maskedMatches = this.getMatchedRoutes(maskedNext, maskedDest);
+          const maskedMatches = this.getMatchedRoutes(
+            maskedNext.pathname,
+            maskedDest == null ? void 0 : maskedDest.to
+          );
           const maskedFinal = build(maskedDest, maskedMatches);
           final.maskedLocation = maskedFinal;
         }
@@ -616,6 +540,13 @@ class RouterCore {
       });
     };
     this.navigate = ({ to, reloadDocument, href, ...rest }) => {
+      if (!reloadDocument && href) {
+        try {
+          new URL(`${href}`);
+          reloadDocument = true;
+        } catch {
+        }
+      }
       if (reloadDocument) {
         if (!href) {
           const location = this.buildLocation({ to, ...rest });
@@ -634,8 +565,23 @@ class RouterCore {
         to
       });
     };
-    this.load = async (opts) => {
+    this.beforeLoad = () => {
+      this.cancelMatches();
       this.latestLocation = this.parseLocation(this.latestLocation);
+      const pendingMatches = this.matchRoutes(this.latestLocation);
+      this.__store.setState((s) => ({
+        ...s,
+        status: "pending",
+        isLoading: true,
+        location: this.latestLocation,
+        pendingMatches,
+        // If a cached moved to pendingMatches, remove it from cachedMatches
+        cachedMatches: s.cachedMatches.filter((d) => {
+          return !pendingMatches.find((e) => e.id === d.id);
+        })
+      }));
+    };
+    this.load = async (opts) => {
       let redirect;
       let notFound;
       let loadPromise;
@@ -643,24 +589,9 @@ class RouterCore {
         this.startTransition(async () => {
           var _a;
           try {
+            this.beforeLoad();
             const next = this.latestLocation;
             const prevLocation = this.state.resolvedLocation;
-            this.cancelMatches();
-            let pendingMatches;
-            batch(() => {
-              pendingMatches = this.matchRoutes(next);
-              this.__store.setState((s) => ({
-                ...s,
-                status: "pending",
-                isLoading: true,
-                location: next,
-                pendingMatches,
-                // If a cached moved to pendingMatches, remove it from cachedMatches
-                cachedMatches: s.cachedMatches.filter((d) => {
-                  return !pendingMatches.find((e) => e.id === d.id);
-                })
-              }));
-            });
             if (!this.state.redirect) {
               this.emit({
                 type: "onBeforeNavigate",
@@ -679,7 +610,7 @@ class RouterCore {
             });
             await this.loadMatches({
               sync: opts == null ? void 0 : opts.sync,
-              matches: pendingMatches,
+              matches: this.state.pendingMatches,
               location: next,
               // eslint-disable-next-line @typescript-eslint/require-await
               onReady: async () => {
@@ -728,11 +659,11 @@ class RouterCore {
               }
             });
           } catch (err) {
-            if (isResolvedRedirect(err)) {
+            if (isRedirect(err)) {
               redirect = err;
               if (!this.isServer) {
                 this.navigate({
-                  ...redirect,
+                  ...redirect.options,
                   replace: true,
                   ignoreBlocker: true
                 });
@@ -742,7 +673,7 @@ class RouterCore {
             }
             this.__store.setState((s) => ({
               ...s,
-              statusCode: redirect ? redirect.statusCode : notFound ? 404 : s.matches.some((d) => d.status === "error") ? 500 : 200,
+              statusCode: redirect ? redirect.status : notFound ? 404 : s.matches.some((d) => d.status === "error") ? 500 : 200,
               redirect
             }));
           }
@@ -840,12 +771,14 @@ class RouterCore {
       };
       const handleRedirectAndNotFound = (match, err) => {
         var _a, _b, _c, _d;
-        if (isResolvedRedirect(err)) {
-          if (!err.reloadDocument) {
-            throw err;
-          }
-        }
         if (isRedirect(err) || isNotFound(err)) {
+          if (isRedirect(err)) {
+            if (err.redirectHandled) {
+              if (!err.options.reloadDocument) {
+                throw err;
+              }
+            }
+          }
           updateMatch(match.id, (prev) => ({
             ...prev,
             status: isRedirect(err) ? "redirected" : isNotFound(err) ? "notFound" : "error",
@@ -862,7 +795,9 @@ class RouterCore {
           (_c = match.loadPromise) == null ? void 0 : _c.resolve();
           if (isRedirect(err)) {
             rendered = true;
-            err = this.resolveRedirect({ ...err, _fromLocation: location });
+            err.options._fromLocation = location;
+            err.redirectHandled = true;
+            err = this.resolveRedirect(err);
             throw err;
           } else if (isNotFound(err)) {
             this._handleNotFound(matches, err, {
@@ -1185,8 +1120,8 @@ class RouterCore {
                               loaderPromise: void 0
                             }));
                           } catch (err) {
-                            if (isResolvedRedirect(err)) {
-                              await this.navigate(err);
+                            if (isRedirect(err)) {
+                              await this.navigate(err.options);
                             }
                           }
                         })();
@@ -1252,10 +1187,13 @@ class RouterCore {
       });
       return this.load({ sync: opts == null ? void 0 : opts.sync });
     };
-    this.resolveRedirect = (err) => {
-      const redirect = err;
-      if (!redirect.href) {
-        redirect.href = this.buildLocation(redirect).href;
+    this.resolveRedirect = (redirect) => {
+      if (!redirect.options.href) {
+        redirect.options.href = this.buildLocation(redirect.options).href;
+        redirect.headers.set("Location", redirect.options.href);
+      }
+      if (!redirect.headers.get("Location")) {
+        redirect.headers.set("Location", redirect.options.href);
       }
       return redirect;
     };
@@ -1357,11 +1295,11 @@ class RouterCore {
         return matches;
       } catch (err) {
         if (isRedirect(err)) {
-          if (err.reloadDocument) {
+          if (err.options.reloadDocument) {
             return void 0;
           }
           return await this.preloadRoute({
-            ...err,
+            ...err.options,
             _fromLocation: next
           });
         }
@@ -1465,9 +1403,10 @@ class RouterCore {
     return this.routesById;
   }
   matchRoutesInternal(next, opts) {
+    var _a;
     const { foundRoute, matchedRoutes, routeParams } = this.getMatchedRoutes(
-      next,
-      opts == null ? void 0 : opts.dest
+      next.pathname,
+      (_a = opts == null ? void 0 : opts.dest) == null ? void 0 : _a.to
     );
     let isGlobalNotFound = false;
     if (
@@ -1498,9 +1437,9 @@ class RouterCore {
       return rootRouteId;
     })();
     const parseErrors = matchedRoutes.map((route) => {
-      var _a;
+      var _a2;
       let parsedParamsError;
-      const parseParams = ((_a = route.options.params) == null ? void 0 : _a.parse) ?? route.options.parseParams;
+      const parseParams = ((_a2 = route.options.params) == null ? void 0 : _a2.parse) ?? route.options.parseParams;
       if (parseParams) {
         try {
           const parsedParams = parseParams(routeParams);
@@ -1524,7 +1463,7 @@ class RouterCore {
       return parentContext;
     };
     matchedRoutes.forEach((route, index) => {
-      var _a, _b;
+      var _a2, _b;
       const parentMatch = matches[index - 1];
       const [preMatchSearch, strictMatchSearch, searchError] = (() => {
         const parentSearch = (parentMatch == null ? void 0 : parentMatch.search) ?? next.search;
@@ -1552,7 +1491,7 @@ class RouterCore {
           return [parentSearch, {}, searchParamError];
         }
       })();
-      const loaderDeps = ((_b = (_a = route.options).loaderDeps) == null ? void 0 : _b.call(_a, {
+      const loaderDeps = ((_b = (_a2 = route.options).loaderDeps) == null ? void 0 : _b.call(_a2, {
         search: preMatchSearch
       })) ?? "";
       const loaderDepsHash = loaderDeps ? JSON.stringify(loaderDeps) : "";
@@ -1630,7 +1569,7 @@ class RouterCore {
       matches.push(match);
     });
     matches.forEach((match, index) => {
-      var _a, _b;
+      var _a2, _b;
       const route = this.looseRoutesById[match.routeId];
       const existingMatch = this.getMatch(match.id);
       if (!existingMatch && (opts == null ? void 0 : opts._buildLocation) !== true) {
@@ -1648,7 +1587,7 @@ class RouterCore {
           preload: !!match.preload,
           matches
         };
-        match.__routeContext = ((_b = (_a = route.options).context) == null ? void 0 : _b.call(_a, contextFnContext)) ?? {};
+        match.__routeContext = ((_b = (_a2 = route.options).context) == null ? void 0 : _b.call(_a2, contextFnContext)) ?? {};
         match.context = {
           ...parentContext,
           ...match.__routeContext,
@@ -1718,6 +1657,141 @@ function routeNeedsPreload(route) {
   }
   return false;
 }
+function processRouteTree({
+  routeTree,
+  initRoute
+}) {
+  const routesById = {};
+  const routesByPath = {};
+  const recurseRoutes = (childRoutes) => {
+    childRoutes.forEach((childRoute, i) => {
+      initRoute == null ? void 0 : initRoute(childRoute, i);
+      const existingRoute = routesById[childRoute.id];
+      invariant(
+        !existingRoute,
+        `Duplicate routes found with id: ${String(childRoute.id)}`
+      );
+      routesById[childRoute.id] = childRoute;
+      if (!childRoute.isRoot && childRoute.path) {
+        const trimmedFullPath = trimPathRight(childRoute.fullPath);
+        if (!routesByPath[trimmedFullPath] || childRoute.fullPath.endsWith("/")) {
+          routesByPath[trimmedFullPath] = childRoute;
+        }
+      }
+      const children = childRoute.children;
+      if (children == null ? void 0 : children.length) {
+        recurseRoutes(children);
+      }
+    });
+  };
+  recurseRoutes([routeTree]);
+  const scoredRoutes = [];
+  const routes = Object.values(routesById);
+  routes.forEach((d, i) => {
+    var _a;
+    if (d.isRoot || !d.path) {
+      return;
+    }
+    const trimmed = trimPathLeft(d.fullPath);
+    const parsed = parsePathname(trimmed);
+    while (parsed.length > 1 && ((_a = parsed[0]) == null ? void 0 : _a.value) === "/") {
+      parsed.shift();
+    }
+    const scores = parsed.map((segment) => {
+      if (segment.value === "/") {
+        return 0.75;
+      }
+      if (segment.type === "param" && segment.prefixSegment && segment.suffixSegment) {
+        return 0.55;
+      }
+      if (segment.type === "param" && segment.prefixSegment) {
+        return 0.52;
+      }
+      if (segment.type === "param" && segment.suffixSegment) {
+        return 0.51;
+      }
+      if (segment.type === "param") {
+        return 0.5;
+      }
+      if (segment.type === "wildcard" && segment.prefixSegment && segment.suffixSegment) {
+        return 0.3;
+      }
+      if (segment.type === "wildcard" && segment.prefixSegment) {
+        return 0.27;
+      }
+      if (segment.type === "wildcard" && segment.suffixSegment) {
+        return 0.26;
+      }
+      if (segment.type === "wildcard") {
+        return 0.25;
+      }
+      return 1;
+    });
+    scoredRoutes.push({ child: d, trimmed, parsed, index: i, scores });
+  });
+  const flatRoutes = scoredRoutes.sort((a, b) => {
+    const minLength = Math.min(a.scores.length, b.scores.length);
+    for (let i = 0; i < minLength; i++) {
+      if (a.scores[i] !== b.scores[i]) {
+        return b.scores[i] - a.scores[i];
+      }
+    }
+    if (a.scores.length !== b.scores.length) {
+      return b.scores.length - a.scores.length;
+    }
+    for (let i = 0; i < minLength; i++) {
+      if (a.parsed[i].value !== b.parsed[i].value) {
+        return a.parsed[i].value > b.parsed[i].value ? 1 : -1;
+      }
+    }
+    return a.index - b.index;
+  }).map((d, i) => {
+    d.child.rank = i;
+    return d.child;
+  });
+  return { routesById, routesByPath, flatRoutes };
+}
+function getMatchedRoutes({
+  pathname,
+  routePathname,
+  basepath,
+  caseSensitive,
+  routesByPath,
+  routesById,
+  flatRoutes
+}) {
+  let routeParams = {};
+  const trimmedPath = trimPathRight(pathname);
+  const getMatchedParams = (route) => {
+    var _a;
+    const result = matchPathname(basepath, trimmedPath, {
+      to: route.fullPath,
+      caseSensitive: ((_a = route.options) == null ? void 0 : _a.caseSensitive) ?? caseSensitive,
+      fuzzy: true
+    });
+    return result;
+  };
+  let foundRoute = routePathname !== void 0 ? routesByPath[routePathname] : void 0;
+  if (foundRoute) {
+    routeParams = getMatchedParams(foundRoute);
+  } else {
+    foundRoute = flatRoutes.find((route) => {
+      const matchedParams = getMatchedParams(route);
+      if (matchedParams) {
+        routeParams = matchedParams;
+        return true;
+      }
+      return false;
+    });
+  }
+  let routeCursor = foundRoute || routesById[rootRouteId];
+  const matchedRoutes = [routeCursor];
+  while (routeCursor.parentRoute) {
+    routeCursor = routeCursor.parentRoute;
+    matchedRoutes.unshift(routeCursor);
+  }
+  return { matchedRoutes, routeParams, foundRoute };
+}
 export {
   PathParamError,
   RouterCore,
@@ -1726,6 +1800,8 @@ export {
   defaultSerializeError,
   getInitialRouterState,
   getLocationChangeInfo,
-  lazyFn
+  getMatchedRoutes,
+  lazyFn,
+  processRouteTree
 };
 //# sourceMappingURL=router.js.map