@tanstack/router-core 0.0.1-beta.1 → 0.0.1-beta.11

package/build/cjs/packages/router-core/src/router.js

@@ -23,9 +23,22 @@ var utils = require('./utils.js');
 
 var _window$document;
 // Detect if we're in the DOM
-const isServer = Boolean(typeof window === 'undefined' || !((_window$document = window.document) != null && _window$document.createElement)); // This is the default history object if none is defined
-
-const createDefaultHistory = () => !isServer ? index.createBrowserHistory() : index.createMemoryHistory();
+const isServer = typeof window === 'undefined' || !((_window$document = window.document) != null && _window$document.createElement); // This is the default history object if none is defined
+
+const createDefaultHistory = () => isServer ? index.createMemoryHistory() : index.createBrowserHistory();
+
+function getInitialRouterState() {
+  return {
+    status: 'idle',
+    location: null,
+    matches: [],
+    actions: {},
+    loaders: {},
+    lastUpdated: Date.now(),
+    isFetching: false,
+    isPreloading: false
+  };
+}
 
 function createRouter(userOptions) {
   var _userOptions$stringif, _userOptions$parseSea;
@@ -46,7 +59,6 @@ function createRouter(userOptions) {
     history,
     options: originalOptions,
     listeners: [],
-    removeActionQueue: [],
     // Resolved after construction
     basepath: '',
     routeTree: undefined,
@@ -57,16 +69,10 @@ function createRouter(userOptions) {
     navigationPromise: Promise.resolve(),
     resolveNavigation: () => {},
     matchCache: {},
-    state: {
-      status: 'idle',
-      location: null,
-      matches: [],
-      actions: {},
-      loaders: {},
-      loaderData: {},
-      lastUpdated: Date.now(),
-      isFetching: false,
-      isPreloading: false
+    state: getInitialRouterState(),
+    reset: () => {
+      router.state = getInitialRouterState();
+      router.notify();
     },
     startedLoadingAt: Date.now(),
     subscribe: listener => {
@@ -83,8 +89,28 @@ function createRouter(userOptions) {
         isFetching: router.state.status === 'loading' || router.state.matches.some(d => d.isFetching),
         isPreloading: Object.values(router.matchCache).some(d => d.match.isFetching && !router.state.matches.find(dd => dd.matchId === d.match.matchId))
       });
-      route.cascadeLoaderData(router.state.matches);
-      router.listeners.forEach(listener => listener());
+      cascadeLoaderData(router.state.matches);
+      router.listeners.forEach(listener => listener(router));
+    },
+    dehydrateState: () => {
+      return _rollupPluginBabelHelpers["extends"]({}, utils.pick(router.state, ['status', 'location', 'lastUpdated']), {
+        matches: router.state.matches.map(match => utils.pick(match, ['matchId', 'status', 'routeLoaderData', 'loaderData', 'isInvalid', 'invalidAt']))
+      });
+    },
+    hydrateState: dehydratedState => {
+      // Match the routes
+      const matches = router.matchRoutes(router.location.pathname, {
+        strictParseParams: true
+      });
+      matches.forEach((match, index) => {
+        const dehydratedMatch = dehydratedState.matches[index];
+        tinyInvariant["default"](dehydratedMatch, 'Oh no! Dehydrated route matches did not match the active state of the router 😬');
+        Object.assign(match, dehydratedMatch);
+      });
+      router.loadMatches(matches);
+      router.state = _rollupPluginBabelHelpers["extends"]({}, router.state, dehydratedState, {
+        matches
+      });
     },
     mount: () => {
       const next = router.__.buildLocation({
@@ -97,12 +123,11 @@ function createRouter(userOptions) {
 
       if (next.href !== router.location.href) {
         router.__.commitLocation(next, true);
-      } else {
-        router.loadLocation();
-      }
+      } // router.load()
 
-      const unsub = history.listen(event => {
-        router.loadLocation(router.__.parseLocation(event.location, router.location));
+
+      const unsub = router.history.listen(event => {
+        router.load(router.__.parseLocation(event.location, router.location));
       }); // addEventListener does not exist in React Native, but window does
       // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
 
@@ -113,16 +138,30 @@ function createRouter(userOptions) {
       }
 
       return () => {
-        unsub(); // Be sure to unsubscribe if a new handler is set
+        unsub();
 
-        window.removeEventListener('visibilitychange', router.onFocus);
-        window.removeEventListener('focus', router.onFocus);
+        if (!isServer && window.removeEventListener) {
+          // Be sure to unsubscribe if a new handler is set
+          window.removeEventListener('visibilitychange', router.onFocus);
+          window.removeEventListener('focus', router.onFocus);
+        }
       };
     },
     onFocus: () => {
-      router.loadLocation();
+      router.load();
     },
     update: opts => {
+      const newHistory = (opts == null ? void 0 : opts.history) !== router.history;
+
+      if (!router.location || newHistory) {
+        if (opts != null && opts.history) {
+          router.history = opts.history;
+        }
+
+        router.location = router.__.parseLocation(router.history.location);
+        router.state.location = router.location;
+      }
+
       Object.assign(router.options, opts);
       const {
         basepath,
@@ -143,35 +182,19 @@ function createRouter(userOptions) {
         match.cancel();
       });
     },
-    loadLocation: async next => {
+    load: async next => {
       const id = Math.random();
       router.startedLoadingAt = id;
 
       if (next) {
         // Ingest the new location
         router.location = next;
-      } // Clear out old actions
-
-
-      router.removeActionQueue.forEach(_ref => {
-        let {
-          action,
-          actionState
-        } = _ref;
-
-        if (router.state.currentAction === actionState) {
-          router.state.currentAction = undefined;
-        }
+      } // Cancel any pending matches
 
-        if (action.current === actionState) {
-          action.current = undefined;
-        }
-      });
-      router.removeActionQueue = []; // Cancel any pending matches
 
       router.cancelMatches(); // Match the routes
 
-      const matches = router.matchRoutes(location.pathname, {
+      const matches = router.matchRoutes(router.location.pathname, {
         strictParseParams: true
       });
       router.state = _rollupPluginBabelHelpers["extends"]({}, router.state, {
@@ -202,9 +225,12 @@ function createRouter(userOptions) {
           exiting.push(d);
         }
       });
+      const entering = matches.filter(d => {
+        return !previousMatches.find(dd => dd.matchId === d.matchId);
+      });
       const now = Date.now();
       exiting.forEach(d => {
-        var _ref2, _d$options$loaderGcMa, _ref3, _d$options$loaderMaxA;
+        var _ref, _d$options$loaderGcMa, _ref2, _d$options$loaderMaxA;
 
         d.__.onExit == null ? void 0 : d.__.onExit({
           params: d.params,
@@ -216,7 +242,7 @@ function createRouter(userOptions) {
           d.error = undefined;
         }
 
-        const gc = Math.max((_ref2 = (_d$options$loaderGcMa = d.options.loaderGcMaxAge) != null ? _d$options$loaderGcMa : router.options.defaultLoaderGcMaxAge) != null ? _ref2 : 0, (_ref3 = (_d$options$loaderMaxA = d.options.loaderMaxAge) != null ? _d$options$loaderMaxA : router.options.defaultLoaderMaxAge) != null ? _ref3 : 0);
+        const gc = Math.max((_ref = (_d$options$loaderGcMa = d.options.loaderGcMaxAge) != null ? _d$options$loaderGcMa : router.options.defaultLoaderGcMaxAge) != null ? _ref : 0, (_ref2 = (_d$options$loaderMaxA = d.options.loaderMaxAge) != null ? _d$options$loaderMaxA : router.options.defaultLoaderMaxAge) != null ? _ref2 : 0);
 
         if (gc > 0) {
           router.matchCache[d.matchId] = {
@@ -231,9 +257,6 @@ function createRouter(userOptions) {
           search: d.routeSearch
         });
       });
-      const entering = matches.filter(d => {
-        return !previousMatches.find(dd => dd.matchId === d.matchId);
-      });
       entering.forEach(d => {
         d.__.onExit = d.options.onMatch == null ? void 0 : d.options.onMatch({
           params: d.params,
@@ -242,16 +265,18 @@ function createRouter(userOptions) {
         delete router.matchCache[d.matchId];
       });
 
-      if (matches.some(d => d.status === 'loading')) {
-        router.notify();
-        await Promise.all(matches.map(d => d.__.loaderPromise || Promise.resolve()));
-      }
-
       if (router.startedLoadingAt !== id) {
         // Ignore side-effects of match loading
         return;
       }
 
+      matches.forEach(match => {
+        // Clear actions
+        if (match.action) {
+          match.action.current = undefined;
+          match.action.submissions = [];
+        }
+      });
       router.state = _rollupPluginBabelHelpers["extends"]({}, router.state, {
         location: router.location,
         matches,
@@ -292,7 +317,7 @@ function createRouter(userOptions) {
       return matches;
     },
     preloadRoute: async function preloadRoute(navigateOpts, loaderOpts) {
-      var _ref4, _ref5, _loaderOpts$maxAge, _ref6, _ref7, _loaderOpts$gcMaxAge;
+      var _ref3, _ref4, _loaderOpts$maxAge, _ref5, _ref6, _loaderOpts$gcMaxAge;
 
       if (navigateOpts === void 0) {
         navigateOpts = router.location;
@@ -304,8 +329,8 @@ function createRouter(userOptions) {
       });
       await router.loadMatches(matches, {
         preload: true,
-        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
+        maxAge: (_ref3 = (_ref4 = (_loaderOpts$maxAge = loaderOpts.maxAge) != null ? _loaderOpts$maxAge : router.options.defaultPreloadMaxAge) != null ? _ref4 : router.options.defaultLoaderMaxAge) != null ? _ref3 : 0,
+        gcMaxAge: (_ref5 = (_ref6 = (_loaderOpts$gcMaxAge = loaderOpts.gcMaxAge) != null ? _loaderOpts$gcMaxAge : router.options.defaultPreloadGcMaxAge) != null ? _ref6 : router.options.defaultLoaderGcMaxAge) != null ? _ref5 : 0
       });
       return matches;
     },
@@ -395,7 +420,7 @@ function createRouter(userOptions) {
       };
 
       recurse([router.routeTree]);
-      route.cascadeLoaderData(matches);
+      cascadeLoaderData(matches);
       return matches;
     },
     loadMatches: async (resolvedMatches, loaderOpts) => {
@@ -407,9 +432,12 @@ function createRouter(userOptions) {
 
         if (match.status === 'loading') {
           // If requested, start the pending timers
-          if (loaderOpts != null && loaderOpts.withPending) match.__.startPending(); // Wait for the first sign of activity from the match
-          // This might be completion, error, or a pending state
+          if (loaderOpts != null && loaderOpts.withPending) match.__.startPending();
+        }
 
+        if (match.__.loadPromise) {
+          // Wait for the first sign of activity from the match
+          // This might be completion, error, or a pending state
           await match.__.loadPromise;
         }
       });
@@ -460,7 +488,7 @@ function createRouter(userOptions) {
         to: next.pathname
       }));
     },
-    navigate: async _ref8 => {
+    navigate: async _ref7 => {
       let {
         from,
         to = '.',
@@ -468,7 +496,7 @@ function createRouter(userOptions) {
         hash,
         replace,
         params
-      } = _ref8;
+      } = _ref7;
       // 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
@@ -492,8 +520,8 @@ function createRouter(userOptions) {
         params
       });
     },
-    buildLink: _ref9 => {
-      var _preload, _ref10;
+    buildLink: _ref8 => {
+      var _preload, _ref9;
 
       let {
         from,
@@ -509,7 +537,7 @@ function createRouter(userOptions) {
         preloadGcMaxAge: userPreloadGcMaxAge,
         preloadDelay: userPreloadDelay,
         disabled
-      } = _ref9;
+      } = _ref8;
 
       // If this link simply reloads the current route,
       // make sure it has a new key so it will trigger a data refresh
@@ -533,7 +561,7 @@ function createRouter(userOptions) {
       };
       const next = router.buildNext(nextOpts);
       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 preloadDelay = (_ref9 = userPreloadDelay != null ? userPreloadDelay : router.options.defaultPreloadDelay) != null ? _ref9 : 0; // Compare path/hash for matches
 
       const pathIsEqual = router.state.location.pathname === next.pathname;
       const currentPathSplit = router.state.location.pathname.split('/');
@@ -634,11 +662,7 @@ function createRouter(userOptions) {
         const recurseRoutes = (routeConfigs, parent) => {
           return routeConfigs.map(routeConfig => {
             const routeOptions = routeConfig.options;
-            const route$1 = route.createRoute(routeConfig, routeOptions, parent, router); // {
-            //   pendingMs: routeOptions.pendingMs ?? router.defaultPendingMs,
-            //   pendingMinMs: routeOptions.pendingMinMs ?? router.defaultPendingMinMs,
-            // }
-
+            const route$1 = route.createRoute(routeConfig, routeOptions, parent, router);
             const existingRoute = router.routesById[route$1.routeId];
 
             if (existingRoute) {
@@ -773,8 +797,6 @@ function createRouter(userOptions) {
       }
     }
   };
-  router.location = router.__.parseLocation(history.location);
-  router.state.location = router.location;
   router.update(userOptions); // Allow frameworks to hook into the router creation
 
   router.options.createRouter == null ? void 0 : router.options.createRouter(router);
@@ -785,5 +807,15 @@ function isCtrlEvent(e) {
   return !!(e.metaKey || e.altKey || e.ctrlKey || e.shiftKey);
 }
 
+function cascadeLoaderData(matches) {
+  matches.forEach((match, index) => {
+    const parent = matches[index - 1];
+
+    if (parent) {
+      match.loaderData = utils.replaceEqualDeep(match.loaderData, _rollupPluginBabelHelpers["extends"]({}, parent.loaderData, match.routeLoaderData));
+    }
+  });
+}
+
 exports.createRouter = createRouter;
 //# sourceMappingURL=router.js.map