@tanstack/router-core 0.0.1-alpha.7 → 0.0.1-alpha.9

package/build/types/index.d.ts

@@ -81,9 +81,10 @@ interface RouterOptions<TRouteConfig extends AnyRouteConfig> {
     stringifySearch?: SearchSerializer;
     parseSearch?: SearchParser;
     filterRoutes?: FilterRoutesFn;
-    defaultLinkPreload?: false | 'intent';
-    defaultLinkPreloadMaxAge?: number;
-    defaultLinkPreloadDelay?: number;
+    defaultPreload?: false | 'intent';
+    defaultPreloadMaxAge?: number;
+    defaultPreloadGcMaxAge?: number;
+    defaultPreloadDelay?: number;
     useErrorBoundary?: boolean;
     defaultElement?: GetFrameworkGeneric<'Element'>;
     defaultErrorElement?: GetFrameworkGeneric<'Element'>;
@@ -193,8 +194,10 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
     matchCache: Record<string, MatchCacheEntry>;
     cleanMatchCache: () => void;
     getRoute: <TId extends keyof TAllRouteInfo['routeInfoById']>(id: TId) => Route<TAllRouteInfo, TAllRouteInfo['routeInfoById'][TId]>;
-    loadRoute: (navigateOpts: BuildNextOptions, loaderOpts: {
-        maxAge: number;
+    loadRoute: (navigateOpts: BuildNextOptions) => Promise<RouteMatch[]>;
+    preloadRoute: (navigateOpts: BuildNextOptions, loaderOpts: {
+        maxAge?: number;
+        gcMaxAge?: number;
     }) => Promise<RouteMatch[]>;
     matchRoutes: (pathname: string, opts?: {
         strictParseParams?: boolean;
@@ -204,9 +207,11 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
     } & ({
         preload: true;
         maxAge: number;
+        gcMaxAge: number;
     } | {
         preload?: false;
         maxAge?: never;
+        gcMaxAge?: never;
     })) => Promise<void>;
     invalidateRoute: (opts: MatchLocation) => void;
     reload: () => Promise<void>;
@@ -237,6 +242,7 @@ interface RouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo
     routeLoaderData: TRouteInfo['routeLoaderData'];
     isFetching: boolean;
     isPending: boolean;
+    invalidAt: number;
     __: {
         element?: GetFrameworkGeneric<'Element'>;
         errorElement?: GetFrameworkGeneric<'Element'>;
@@ -263,7 +269,9 @@ interface RouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo
         resolve: () => void;
     };
     cancel: () => void;
-    load: () => Promise<void>;
+    load: (opts?: {
+        maxAge?: number;
+    }) => Promise<void>;
     invalidate: () => void;
     hasLoaders: () => boolean;
 }
@@ -523,6 +531,7 @@ declare type LinkOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRoute
     activeOptions?: ActiveOptions;
     preload?: false | 'intent';
     preloadMaxAge?: number;
+    preloadGcMaxAge?: number;
     preloadDelay?: number;
     disabled?: boolean;
 };

package/build/umd/index.development.js

@@ -1365,12 +1365,10 @@
       isPending: false,
       isFetching: false,
       isInvalid: false,
+      invalidAt: Infinity,
       getIsInvalid: () => {
-        var _ref, _routeMatch$options$l;
-
         const now = Date.now();
-        const maxAge = (_ref = (_routeMatch$options$l = routeMatch.options.loaderMaxAge) != null ? _routeMatch$options$l : router.options.defaultLoaderMaxAge) != null ? _ref : 0;
-        return routeMatch.isInvalid || routeMatch.updatedAt + maxAge < now;
+        return routeMatch.isInvalid || routeMatch.invalidAt < now;
       },
       __: {
         abortController: new AbortController(),
@@ -1461,7 +1459,7 @@
       hasLoaders: () => {
         return !!(route.options.loader || route.options.import || elementTypes.some(d => typeof route.options[d] === 'function'));
       },
-      load: async () => {
+      load: async opts => {
         const id = '' + Date.now() + Math.random();
         routeMatch.__.latestId = id; // If the match was in an error state, set it
         // to a loading state again. Otherwise, keep it
@@ -1516,6 +1514,8 @@
 
             routeMatch.__.dataPromise = Promise.resolve().then(async () => {
               try {
+                var _ref, _ref2, _opts$maxAge;
+
                 if (routeMatch.options.loader) {
                   const data = await routeMatch.options.loader({
                     params: routeMatch.params,
@@ -1533,6 +1533,7 @@
                 routeMatch.error = undefined;
                 routeMatch.status = 'success';
                 routeMatch.updatedAt = Date.now();
+                routeMatch.invalidAt = routeMatch.updatedAt + ((_ref = (_ref2 = (_opts$maxAge = opts == null ? void 0 : opts.maxAge) != null ? _opts$maxAge : routeMatch.options.loaderMaxAge) != null ? _ref2 : router.options.defaultLoaderMaxAge) != null ? _ref : 0);
               } catch (err) {
                 if (id !== routeMatch.__.latestId) {
                   return routeMatch.__.loaderPromise;
@@ -1655,7 +1656,8 @@
     const originalOptions = _extends({
       defaultLoaderGcMaxAge: 5 * 60 * 1000,
       defaultLoaderMaxAge: 0,
-      defaultLinkPreloadDelay: 50
+      defaultPreloadMaxAge: 2000,
+      defaultPreloadDelay: 50
     }, userOptions, {
       stringifySearch: (_userOptions$stringif = userOptions == null ? void 0 : userOptions.stringifySearch) != null ? _userOptions$stringif : defaultStringifySearch,
       parseSearch: (_userOptions$parseSea = userOptions == null ? void 0 : userOptions.parseSearch) != null ? _userOptions$parseSea : defaultParseSearch
@@ -2052,7 +2054,21 @@
           delete router.matchCache[matchId];
         });
       },
-      loadRoute: async function loadRoute(navigateOpts, loaderOpts) {
+      loadRoute: async function loadRoute(navigateOpts) {
+        if (navigateOpts === void 0) {
+          navigateOpts = router.location;
+        }
+
+        const next = router.buildNext(navigateOpts);
+        const matches = router.matchRoutes(next.pathname, {
+          strictParseParams: true
+        });
+        await router.loadMatches(matches);
+        return matches;
+      },
+      preloadRoute: async function preloadRoute(navigateOpts, loaderOpts) {
+        var _ref4, _ref5, _loaderOpts$maxAge, _ref6, _ref7, _loaderOpts$gcMaxAge;
+
         if (navigateOpts === void 0) {
           navigateOpts = router.location;
         }
@@ -2063,7 +2079,8 @@
         });
         await router.loadMatches(matches, {
           preload: true,
-          maxAge: loaderOpts.maxAge
+          maxAge: (_ref4 = (_ref5 = (_loaderOpts$maxAge = loaderOpts.maxAge) != null ? _loaderOpts$maxAge : router.options.defaultPreloadMaxAge) != null ? _ref5 : router.options.defaultLoaderMaxAge) != null ? _ref4 : 0,
+          gcMaxAge: (_ref6 = (_ref7 = (_loaderOpts$gcMaxAge = loaderOpts.gcMaxAge) != null ? _loaderOpts$gcMaxAge : router.options.defaultPreloadGcMaxAge) != null ? _ref7 : router.options.defaultLoaderGcMaxAge) != null ? _ref6 : 0
         });
         return matches;
       },
@@ -2158,32 +2175,30 @@
       },
       loadMatches: async (resolvedMatches, loaderOpts) => {
         const now = Date.now();
+        const minMaxAge = loaderOpts != null && loaderOpts.preload ? Math.max(loaderOpts == null ? void 0 : loaderOpts.maxAge, loaderOpts == null ? void 0 : loaderOpts.gcMaxAge) : 0;
         const matchPromises = resolvedMatches.map(async match => {
           // Validate the match (loads search params etc)
-          match.__.validate(); // If the match doesn't have a loader, don't attempt to load it
+          match.__.validate(); // If this is a preload, add it to the preload cache
 
 
-          if (!match.hasLoaders()) {
-            return;
-          } // If this is a preload, add it to the preload cache
-
-
-          if (loaderOpts != null && loaderOpts.preload && (loaderOpts == null ? void 0 : loaderOpts.maxAge) > 0) {
+          if (loaderOpts != null && loaderOpts.preload && minMaxAge > 0) {
             // If the match is currently active, don't preload it
             if (router.state.matches.find(d => d.matchId === match.matchId)) {
               return;
             }
 
             router.matchCache[match.matchId] = {
-              gc: now + loaderOpts.maxAge,
-              // TODO: Should this use the route's maxAge?
+              gc: now + loaderOpts.gcMaxAge,
               match
             };
           } // If the match is invalid, errored or idle, trigger it to load
 
 
           if (match.status === 'success' && match.getIsInvalid() || match.status === 'error' || match.status === 'idle') {
-            match.load();
+            const maxAge = loaderOpts != null && loaderOpts.preload ? loaderOpts == null ? void 0 : loaderOpts.maxAge : undefined;
+            match.load({
+              maxAge
+            });
           }
 
           if (match.status === 'loading') {
@@ -2245,7 +2260,7 @@
         const next = router.buildNext(location);
         return router.commitLocation(next, location.replace);
       },
-      navigate: async _ref4 => {
+      navigate: async _ref8 => {
         let {
           from,
           to = '.',
@@ -2253,7 +2268,7 @@
           hash,
           replace,
           params
-        } = _ref4;
+        } = _ref8;
         // If this link simply reloads the current route,
         // make sure it has a new key so it will trigger a data refresh
         // If this `to` is a valid external URL, return
@@ -2277,8 +2292,8 @@
           params
         });
       },
-      buildLink: _ref5 => {
-        var _preload, _ref6, _ref7, _ref8;
+      buildLink: _ref9 => {
+        var _preload, _ref10;
 
         let {
           from,
@@ -2291,9 +2306,10 @@
           activeOptions,
           preload,
           preloadMaxAge: userPreloadMaxAge,
+          preloadGcMaxAge: userPreloadGcMaxAge,
           preloadDelay: userPreloadDelay,
           disabled
-        } = _ref5;
+        } = _ref9;
 
         // If this link simply reloads the current route,
         // make sure it has a new key so it will trigger a data refresh
@@ -2316,9 +2332,8 @@
           replace
         };
         const next = router.buildNext(nextOpts);
-        preload = (_preload = preload) != null ? _preload : router.options.defaultLinkPreload;
-        const preloadMaxAge = (_ref6 = (_ref7 = userPreloadMaxAge != null ? userPreloadMaxAge : router.options.defaultLinkPreloadMaxAge) != null ? _ref7 : router.options.defaultLoaderGcMaxAge) != null ? _ref6 : 0;
-        const preloadDelay = (_ref8 = userPreloadDelay != null ? userPreloadDelay : router.options.defaultLinkPreloadDelay) != null ? _ref8 : 0; // Compare path/hash for matches
+        preload = (_preload = preload) != null ? _preload : router.options.defaultPreload;
+        const preloadDelay = (_ref10 = userPreloadDelay != null ? userPreloadDelay : router.options.defaultPreloadDelay) != null ? _ref10 : 0; // Compare path/hash for matches
 
         const pathIsEqual = router.state.location.pathname === next.pathname;
         const currentPathSplit = router.state.location.pathname.split('/');
@@ -2346,9 +2361,10 @@
 
 
         const handleFocus = e => {
-          if (preload && preloadMaxAge > 0) {
-            router.loadRoute(nextOpts, {
-              maxAge: preloadMaxAge
+          if (preload) {
+            router.preloadRoute(nextOpts, {
+              maxAge: userPreloadMaxAge,
+              gcMaxAge: userPreloadGcMaxAge
             });
           }
         };
@@ -2356,15 +2372,16 @@
         const handleEnter = e => {
           const target = e.target || {};
 
-          if (preload && preloadMaxAge > 0) {
+          if (preload) {
             if (target.preloadTimeout) {
               return;
             }
 
             target.preloadTimeout = setTimeout(() => {
               target.preloadTimeout = null;
-              router.loadRoute(nextOpts, {
-                maxAge: preloadMaxAge
+              router.preloadRoute(nextOpts, {
+                maxAge: userPreloadMaxAge,
+                gcMaxAge: userPreloadGcMaxAge
               });
             }, preloadDelay);
           }