@tanstack/router-core 1.124.2 → 1.125.1

package/dist/esm/router.js

@@ -110,8 +110,7 @@ class RouterCore {
         routeTree: this.routeTree,
         initRoute: (route, i) => {
           route.init({
-            originalIndex: i,
-            defaultSsr: this.options.defaultSsr
+            originalIndex: i
           });
         }
       });
@@ -121,8 +120,7 @@ class RouterCore {
       const notFoundRoute = this.options.notFoundRoute;
       if (notFoundRoute) {
         notFoundRoute.init({
-          originalIndex: 99999999999,
-          defaultSsr: this.options.defaultSsr
+          originalIndex: 99999999999
         });
         this.routesById[notFoundRoute.id] = notFoundRoute;
       }
@@ -213,7 +211,13 @@ class RouterCore {
       const match = this.getMatch(id);
       if (!match) return;
       match.abortController.abort();
-      clearTimeout(match.pendingTimeout);
+      this.updateMatch(id, (prev) => {
+        clearTimeout(prev.pendingTimeout);
+        return {
+          ...prev,
+          pendingTimeout: void 0
+        };
+      });
     };
     this.cancelMatches = () => {
       var _a;
@@ -496,7 +500,10 @@ class RouterCore {
           throw redirect({ href: nextLocation.href });
         }
       }
-      const pendingMatches = this.matchRoutes(this.latestLocation);
+      let pendingMatches = this.matchRoutes(this.latestLocation);
+      if (this.isShell) {
+        pendingMatches = pendingMatches.slice(0, 1);
+      }
       this.__store.setState((s) => ({
         ...s,
         status: "pending",
@@ -691,12 +698,41 @@ class RouterCore {
       const triggerOnReady = async () => {
         if (!rendered) {
           rendered = true;
+          if (!allPreload && !this.isServer) {
+            matches.forEach((match) => {
+              const {
+                id: matchId,
+                routeId,
+                _forcePending,
+                minPendingPromise
+              } = match;
+              const route = this.looseRoutesById[routeId];
+              const pendingMinMs = route.options.pendingMinMs ?? this.options.defaultPendingMinMs;
+              if (_forcePending && pendingMinMs && !minPendingPromise) {
+                const minPendingPromise2 = createControlledPromise();
+                updateMatch(matchId, (prev) => ({
+                  ...prev,
+                  minPendingPromise: minPendingPromise2
+                }));
+                setTimeout(() => {
+                  minPendingPromise2.resolve();
+                  updateMatch(matchId, (prev) => ({
+                    ...prev,
+                    minPendingPromise: void 0
+                  }));
+                }, pendingMinMs);
+              }
+            });
+          }
           await (onReady == null ? void 0 : onReady());
         }
       };
       const resolvePreload = (matchId) => {
         return !!(allPreload && !this.state.matches.find((d) => d.id === matchId));
       };
+      if (!this.isServer && this.state.matches.find((d) => d._forcePending)) {
+        triggerOnReady();
+      }
       const handleRedirectAndNotFound = (match, err) => {
         var _a, _b, _c, _d;
         if (isRedirect(err) || isNotFound(err)) {
@@ -739,6 +775,18 @@ class RouterCore {
           }
         }
       };
+      const shouldSkipLoader = (matchId) => {
+        const match = this.getMatch(matchId);
+        if (!this.isServer && match._dehydrated) {
+          return true;
+        }
+        if (this.isServer) {
+          if (match.ssr === false) {
+            return true;
+          }
+        }
+        return false;
+      };
       try {
         await new Promise((resolveAll, rejectAll) => {
           ;
@@ -779,23 +827,82 @@ class RouterCore {
               for (const [index, { id: matchId, routeId }] of matches.entries()) {
                 const existingMatch = this.getMatch(matchId);
                 const parentMatchId = (_a = matches[index - 1]) == null ? void 0 : _a.id;
+                const parentMatch = parentMatchId ? this.getMatch(parentMatchId) : void 0;
                 const route = this.looseRoutesById[routeId];
                 const pendingMs = route.options.pendingMs ?? this.options.defaultPendingMs;
+                if (this.isServer) {
+                  const defaultSsr = this.options.defaultSsr ?? true;
+                  let ssr;
+                  if ((parentMatch == null ? void 0 : parentMatch.ssr) === false) {
+                    ssr = false;
+                  } else {
+                    let tempSsr;
+                    if (route.options.ssr === void 0) {
+                      tempSsr = defaultSsr;
+                    } else if (typeof route.options.ssr === "function") {
+                      let makeMaybe = function(value, error) {
+                        if (error) {
+                          return { status: "error", error };
+                        }
+                        return { status: "success", value };
+                      };
+                      const { search, params } = this.getMatch(matchId);
+                      const ssrFnContext = {
+                        search: makeMaybe(search, existingMatch.searchError),
+                        params: makeMaybe(params, existingMatch.paramsError),
+                        location,
+                        matches: matches.map((match) => ({
+                          index: match.index,
+                          pathname: match.pathname,
+                          fullPath: match.fullPath,
+                          staticData: match.staticData,
+                          id: match.id,
+                          routeId: match.routeId,
+                          search: makeMaybe(match.search, match.searchError),
+                          params: makeMaybe(match.params, match.paramsError),
+                          ssr: match.ssr
+                        }))
+                      };
+                      tempSsr = await route.options.ssr(ssrFnContext) ?? defaultSsr;
+                    } else {
+                      tempSsr = route.options.ssr;
+                    }
+                    if (tempSsr === true && (parentMatch == null ? void 0 : parentMatch.ssr) === "data-only") {
+                      ssr = "data-only";
+                    } else {
+                      ssr = tempSsr;
+                    }
+                  }
+                  updateMatch(matchId, (prev) => ({
+                    ...prev,
+                    ssr
+                  }));
+                }
+                if (shouldSkipLoader(matchId)) {
+                  continue;
+                }
                 const shouldPending = !!(onReady && !this.isServer && !resolvePreload(matchId) && (route.options.loader || route.options.beforeLoad || routeNeedsPreload(route)) && typeof pendingMs === "number" && pendingMs !== Infinity && (route.options.pendingComponent ?? ((_b = this.options) == null ? void 0 : _b.defaultPendingComponent)));
                 let executeBeforeLoad = true;
-                if (
-                  // If we are in the middle of a load, either of these will be present
-                  // (not to be confused with `loadPromise`, which is always defined)
-                  existingMatch.beforeLoadPromise || existingMatch.loaderPromise
-                ) {
-                  if (shouldPending) {
-                    setTimeout(() => {
+                const setupPendingTimeout = () => {
+                  if (shouldPending && this.getMatch(matchId).pendingTimeout === void 0) {
+                    const pendingTimeout = setTimeout(() => {
                       try {
                         triggerOnReady();
                       } catch {
                       }
                     }, pendingMs);
+                    updateMatch(matchId, (prev) => ({
+                      ...prev,
+                      pendingTimeout
+                    }));
                   }
+                };
+                if (
+                  // If we are in the middle of a load, either of these will be present
+                  // (not to be confused with `loadPromise`, which is always defined)
+                  existingMatch.beforeLoadPromise || existingMatch.loaderPromise
+                ) {
+                  setupPendingTimeout();
                   await existingMatch.beforeLoadPromise;
                   const match = this.getMatch(matchId);
                   if (match.status === "error") {
@@ -816,16 +923,6 @@ class RouterCore {
                         beforeLoadPromise: createControlledPromise()
                       };
                     });
-                    const abortController = new AbortController();
-                    let pendingTimeout;
-                    if (shouldPending) {
-                      pendingTimeout = setTimeout(() => {
-                        try {
-                          triggerOnReady();
-                        } catch {
-                        }
-                      }, pendingMs);
-                    }
                     const { paramsError, searchError } = this.getMatch(matchId);
                     if (paramsError) {
                       handleSerialError(index, paramsError, "PARSE_PARAMS");
@@ -833,15 +930,16 @@ class RouterCore {
                     if (searchError) {
                       handleSerialError(index, searchError, "VALIDATE_SEARCH");
                     }
-                    const getParentMatchContext = () => parentMatchId ? this.getMatch(parentMatchId).context : this.options.context ?? {};
+                    setupPendingTimeout();
+                    const abortController = new AbortController();
+                    const parentMatchContext = (parentMatch == null ? void 0 : parentMatch.context) ?? this.options.context ?? {};
                     updateMatch(matchId, (prev) => ({
                       ...prev,
                       isFetching: "beforeLoad",
                       fetchCount: prev.fetchCount + 1,
                       abortController,
-                      pendingTimeout,
                       context: {
-                        ...getParentMatchContext(),
+                        ...parentMatchContext,
                         ...prev.__routeContext
                       }
                     }));
@@ -868,7 +966,7 @@ class RouterCore {
                         ...prev,
                         __beforeLoadContext: beforeLoadContext,
                         context: {
-                          ...getParentMatchContext(),
+                          ...parentMatchContext,
                           ...prev.__routeContext,
                           ...beforeLoadContext
                         },
@@ -894,10 +992,61 @@ class RouterCore {
               validResolvedMatches.forEach(({ id: matchId, routeId }, index) => {
                 matchPromises.push(
                   (async () => {
+                    var _a2, _b2;
                     let loaderShouldRunAsync = false;
                     let loaderIsRunningAsync = false;
+                    const route = this.looseRoutesById[routeId];
+                    const executeHead = async () => {
+                      var _a3, _b3, _c2, _d2, _e, _f;
+                      const match = this.getMatch(matchId);
+                      if (!match) {
+                        return;
+                      }
+                      const assetContext = {
+                        matches,
+                        match,
+                        params: match.params,
+                        loaderData: match.loaderData
+                      };
+                      const headFnContent = await ((_b3 = (_a3 = route.options).head) == null ? void 0 : _b3.call(_a3, assetContext));
+                      const meta = headFnContent == null ? void 0 : headFnContent.meta;
+                      const links = headFnContent == null ? void 0 : headFnContent.links;
+                      const headScripts = headFnContent == null ? void 0 : headFnContent.scripts;
+                      const styles = headFnContent == null ? void 0 : headFnContent.styles;
+                      const scripts = await ((_d2 = (_c2 = route.options).scripts) == null ? void 0 : _d2.call(_c2, assetContext));
+                      const headers = await ((_f = (_e = route.options).headers) == null ? void 0 : _f.call(_e, assetContext));
+                      return {
+                        meta,
+                        links,
+                        headScripts,
+                        headers,
+                        scripts,
+                        styles
+                      };
+                    };
+                    const potentialPendingMinPromise = async () => {
+                      const latestMatch = this.getMatch(matchId);
+                      if (latestMatch.minPendingPromise) {
+                        await latestMatch.minPendingPromise;
+                      }
+                    };
                     const prevMatch = this.getMatch(matchId);
-                    if (prevMatch.loaderPromise) {
+                    if (shouldSkipLoader(matchId)) {
+                      if (this.isServer) {
+                        const head = await executeHead();
+                        updateMatch(matchId, (prev) => ({
+                          ...prev,
+                          ...head
+                        }));
+                        (_a2 = this.serverSsr) == null ? void 0 : _a2.onMatchSettled({
+                          router: this,
+                          match: this.getMatch(matchId)
+                        });
+                        return this.getMatch(matchId);
+                      } else {
+                        await potentialPendingMinPromise();
+                      }
+                    } else if (prevMatch.loaderPromise) {
                       if (prevMatch.status === "success" && !sync && !prevMatch.preload) {
                         return this.getMatch(matchId);
                       }
@@ -908,7 +1057,6 @@ class RouterCore {
                       }
                     } else {
                       const parentMatchPromise = matchPromises[index - 1];
-                      const route = this.looseRoutesById[routeId];
                       const getLoaderContext = () => {
                         const {
                           params,
@@ -941,55 +1089,28 @@ class RouterCore {
                         loaderPromise: createControlledPromise(),
                         preload: !!preload && !this.state.matches.find((d) => d.id === matchId)
                       }));
-                      const executeHead = async () => {
-                        var _a2, _b2, _c2, _d2, _e, _f;
-                        const match = this.getMatch(matchId);
-                        if (!match) {
-                          return;
-                        }
-                        const assetContext = {
-                          matches,
-                          match,
-                          params: match.params,
-                          loaderData: match.loaderData
-                        };
-                        const headFnContent = await ((_b2 = (_a2 = route.options).head) == null ? void 0 : _b2.call(_a2, assetContext));
-                        const meta = headFnContent == null ? void 0 : headFnContent.meta;
-                        const links = headFnContent == null ? void 0 : headFnContent.links;
-                        const headScripts = headFnContent == null ? void 0 : headFnContent.scripts;
-                        const styles = headFnContent == null ? void 0 : headFnContent.styles;
-                        const scripts = await ((_d2 = (_c2 = route.options).scripts) == null ? void 0 : _d2.call(_c2, assetContext));
-                        const headers = await ((_f = (_e = route.options).headers) == null ? void 0 : _f.call(_e, assetContext));
-                        return {
-                          meta,
-                          links,
-                          headScripts,
-                          headers,
-                          scripts,
-                          styles
-                        };
-                      };
                       const runLoader = async () => {
-                        var _a2, _b2, _c2, _d2, _e;
+                        var _a3, _b3, _c2, _d2, _e;
                         try {
-                          const potentialPendingMinPromise = async () => {
-                            const latestMatch = this.getMatch(matchId);
-                            if (latestMatch.minPendingPromise) {
-                              await latestMatch.minPendingPromise;
-                            }
-                          };
                           try {
-                            this.loadRouteChunk(route);
+                            if (!this.isServer || this.isServer && this.getMatch(matchId).ssr === true) {
+                              this.loadRouteChunk(route);
+                            }
                             updateMatch(matchId, (prev) => ({
                               ...prev,
                               isFetching: "loader"
                             }));
-                            const loaderData = await ((_b2 = (_a2 = route.options).loader) == null ? void 0 : _b2.call(_a2, getLoaderContext()));
+                            const loaderData = await ((_b3 = (_a3 = route.options).loader) == null ? void 0 : _b3.call(_a3, getLoaderContext()));
                             handleRedirectAndNotFound(
                               this.getMatch(matchId),
                               loaderData
                             );
+                            updateMatch(matchId, (prev) => ({
+                              ...prev,
+                              loaderData
+                            }));
                             await route._lazyPromise;
+                            const head = await executeHead();
                             await potentialPendingMinPromise();
                             await route._componentsPromise;
                             updateMatch(matchId, (prev) => ({
@@ -998,11 +1119,6 @@ class RouterCore {
                               status: "success",
                               isFetching: false,
                               updatedAt: Date.now(),
-                              loaderData
-                            }));
-                            const head = await executeHead();
-                            updateMatch(matchId, (prev) => ({
-                              ...prev,
                               ...head
                             }));
                           } catch (e) {
@@ -1041,10 +1157,10 @@ class RouterCore {
                           handleRedirectAndNotFound(this.getMatch(matchId), err);
                         }
                       };
-                      const { status, invalid } = this.getMatch(matchId);
+                      const { status, invalid, _forcePending } = this.getMatch(matchId);
                       loaderShouldRunAsync = status === "success" && (invalid || (shouldReload ?? age > staleAge));
                       if (preload && route.options.preload === false) {
-                      } else if (loaderShouldRunAsync && !sync) {
+                      } else if (loaderShouldRunAsync && !sync && !_forcePending) {
                         loaderIsRunningAsync = true;
                         (async () => {
                           try {
@@ -1065,11 +1181,18 @@ class RouterCore {
                       } else if (status !== "success" || loaderShouldRunAsync && sync) {
                         await runLoader();
                       } else {
+                        if (_forcePending) {
+                          await potentialPendingMinPromise();
+                        }
                         const head = await executeHead();
                         updateMatch(matchId, (prev) => ({
                           ...prev,
                           ...head
                         }));
+                        (_b2 = this.serverSsr) == null ? void 0 : _b2.onMatchSettled({
+                          router: this,
+                          match: this.getMatch(matchId)
+                        });
                       }
                     }
                     if (!loaderIsRunningAsync) {
@@ -1077,12 +1200,18 @@ class RouterCore {
                       loaderPromise == null ? void 0 : loaderPromise.resolve();
                       loadPromise == null ? void 0 : loadPromise.resolve();
                     }
-                    updateMatch(matchId, (prev) => ({
-                      ...prev,
-                      isFetching: loaderIsRunningAsync ? prev.isFetching : false,
-                      loaderPromise: loaderIsRunningAsync ? prev.loaderPromise : void 0,
-                      invalid: false
-                    }));
+                    updateMatch(matchId, (prev) => {
+                      clearTimeout(prev.pendingTimeout);
+                      return {
+                        ...prev,
+                        isFetching: loaderIsRunningAsync ? prev.isFetching : false,
+                        loaderPromise: loaderIsRunningAsync ? prev.loaderPromise : void 0,
+                        invalid: false,
+                        pendingTimeout: void 0,
+                        _dehydrated: void 0,
+                        _forcePending: void 0
+                      };
+                    });
                     return this.getMatch(matchId);
                   })()
                 );