@remix-run/router 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -1,4 +1,11 @@
-# @remix-run/router
+# `@remix-run/router`
+
+## 1.0.1
+
+### Patch Changes
+
+- Preserve state from `initialEntries` ([#9288](https://github.com/remix-run/react-router/pull/9288))
+- Preserve `?index` for fetcher get submissions to index routes ([#9312](https://github.com/remix-run/react-router/pull/9312))
 
 ## 1.0.0
 
@@ -6,7 +13,7 @@ This is the first stable release of `@remix-run/router`, which provides all the
 
 For an overview of the features provided by `react-router`, we recommend you go check out the [docs][rr-docs], especially the [feature overview][rr-feature-overview] and the [tutorial][rr-tutorial].
 
-For an overview of the features provided by `@remix-run/router`, please check out the [README][remix-router-readme].
+For an overview of the features provided by `@remix-run/router`, please check out the [`README`][remix-router-readme].
 
 [rr-docs]: https://reactrouter.com/
 [rr-feature-overview]: https://reactrouter.com/en/v6.4.0/start/overview

package/dist/router.cjs.js

@@ -1,5 +1,5 @@
 /**
- * @remix-run/router v1.0.0
+ * @remix-run/router v1.0.1
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -73,7 +73,7 @@ function createMemoryHistory(options) {
   } = options;
   let entries; // Declare so we can access from createMemoryLocation
 
-  entries = initialEntries.map((entry, index) => createMemoryLocation(entry, null, index === 0 ? "default" : undefined));
+  entries = initialEntries.map((entry, index) => createMemoryLocation(entry, typeof entry === "string" ? null : entry.state, index === 0 ? "default" : undefined));
   let index = clampIndex(initialIndex == null ? entries.length - 1 : initialIndex);
   let action = exports.Action.Pop;
   let listener = null;
@@ -187,8 +187,6 @@ function createBrowserHistory(options) {
   }
 
   function createBrowserLocation(window, globalHistory) {
-    var _globalHistory$state, _globalHistory$state2;
-
     let {
       pathname,
       search,
@@ -199,7 +197,7 @@ function createBrowserHistory(options) {
       search,
       hash
     }, // state defaults to `null` because `window.history.state` does
-    ((_globalHistory$state = globalHistory.state) == null ? void 0 : _globalHistory$state.usr) || null, ((_globalHistory$state2 = globalHistory.state) == null ? void 0 : _globalHistory$state2.key) || "default");
+    globalHistory.state && globalHistory.state.usr || null, globalHistory.state && globalHistory.state.key || "default");
   }
 
   function createBrowserHref(window, to) {
@@ -238,8 +236,6 @@ function createHashHistory(options) {
   }
 
   function createHashLocation(window, globalHistory) {
-    var _globalHistory$state3, _globalHistory$state4;
-
     let {
       pathname = "/",
       search = "",
@@ -250,7 +246,7 @@ function createHashHistory(options) {
       search,
       hash
     }, // state defaults to `null` because `window.history.state` does
-    ((_globalHistory$state3 = globalHistory.state) == null ? void 0 : _globalHistory$state3.usr) || null, ((_globalHistory$state4 = globalHistory.state) == null ? void 0 : _globalHistory$state4.key) || "default");
+    globalHistory.state && globalHistory.state.usr || null, globalHistory.state && globalHistory.state.key || "default");
   }
 
   function createHashHref(window, to) {
@@ -326,7 +322,7 @@ function createLocation(current, to, state, key) {
     // full Locations now and avoid the need to run through this flow at all
     // But that's a pretty big refactor to the current test suite so going to
     // keep as is for the time being and just let any incoming keys take precedence
-    key: (to == null ? void 0 : to.key) || key || createKey()
+    key: to && to.key || key || createKey()
   });
 
   return location;
@@ -402,7 +398,7 @@ function getUrlBasedHistory(getLocation, createHref, validateLocation, options)
   function push(to, state) {
     action = exports.Action.Push;
     let location = createLocation(history.location, to, state);
-    validateLocation == null ? void 0 : validateLocation(location, to);
+    if (validateLocation) validateLocation(location, to);
     let historyState = getHistoryState(location);
     let url = history.createHref(location); // try...catch because iOS limits us to 100 pushState calls :/
 
@@ -425,7 +421,7 @@ function getUrlBasedHistory(getLocation, createHref, validateLocation, options)
   function replace(to, state) {
     action = exports.Action.Replace;
     let location = createLocation(history.location, to, state);
-    validateLocation == null ? void 0 : validateLocation(location, to);
+    if (validateLocation) validateLocation(location, to);
     let historyState = getHistoryState(location);
     let url = history.createHref(location);
     globalHistory.replaceState(historyState, "", url);
@@ -1031,8 +1027,6 @@ class DeferredData {
   }
 
   onSettle(promise, key, error, data) {
-    var _this$subscriber2;
-
     if (this.controller.signal.aborted && error instanceof AbortedDeferredError) {
       this.unlistenAbortSignal();
       Object.defineProperty(promise, "_error", {
@@ -1048,20 +1042,20 @@ class DeferredData {
       this.unlistenAbortSignal();
     }
 
-    if (error) {
-      var _this$subscriber;
+    const subscriber = this.subscriber;
 
+    if (error) {
       Object.defineProperty(promise, "_error", {
         get: () => error
       });
-      (_this$subscriber = this.subscriber) == null ? void 0 : _this$subscriber.call(this, false);
+      subscriber && subscriber(false);
       return Promise.reject(error);
     }
 
     Object.defineProperty(promise, "_data", {
       get: () => data
     });
-    (_this$subscriber2 = this.subscriber) == null ? void 0 : _this$subscriber2.call(this, false);
+    subscriber && subscriber(false);
     return data;
   }
 
@@ -1070,11 +1064,10 @@ class DeferredData {
   }
 
   cancel() {
-    var _this$subscriber3;
-
     this.controller.abort();
     this.pendingKeys.forEach((v, k) => this.pendingKeys.delete(k));
-    (_this$subscriber3 = this.subscriber) == null ? void 0 : _this$subscriber3.call(this, true);
+    let subscriber = this.subscriber;
+    subscriber && subscriber(true);
   }
 
   async resolveData(signal) {
@@ -1213,8 +1206,6 @@ const IDLE_FETCHER = {
  */
 
 function createRouter(init) {
-  var _init$hydrationData, _init$hydrationData2, _init$hydrationData3;
-
   invariant(init.routes.length > 0, "You must provide a non-empty routes array to createRouter");
   let dataRoutes = convertRoutesToDataRoutes(init.routes); // Cleanup function for history
 
@@ -1260,9 +1251,9 @@ function createRouter(init) {
     restoreScrollPosition: null,
     preventScrollReset: false,
     revalidation: "idle",
-    loaderData: ((_init$hydrationData = init.hydrationData) == null ? void 0 : _init$hydrationData.loaderData) || {},
-    actionData: ((_init$hydrationData2 = init.hydrationData) == null ? void 0 : _init$hydrationData2.actionData) || null,
-    errors: ((_init$hydrationData3 = init.hydrationData) == null ? void 0 : _init$hydrationData3.errors) || initialErrors,
+    loaderData: init.hydrationData && init.hydrationData.loaderData || {},
+    actionData: init.hydrationData && init.hydrationData.actionData || null,
+    errors: init.hydrationData && init.hydrationData.errors || initialErrors,
     fetchers: new Map()
   }; // -- Stateful internal variables to manage navigations --
   // Current navigation in progress (to be committed in completeNavigation)
@@ -1329,14 +1320,12 @@ function createRouter(init) {
 
 
   function dispose() {
-    var _pendingNavigationCon;
-
     if (unlistenHistory) {
       unlistenHistory();
     }
 
     subscribers.clear();
-    (_pendingNavigationCon = pendingNavigationController) == null ? void 0 : _pendingNavigationCon.abort();
+    pendingNavigationController && pendingNavigationController.abort();
     state.fetchers.forEach((_, key) => deleteFetcher(key));
   } // Subscribe to state updates for the router
 
@@ -1412,8 +1401,8 @@ function createRouter(init) {
       submission,
       error
     } = normalizeNavigateOptions(to, opts);
-    let location = createLocation(state.location, path, opts == null ? void 0 : opts.state);
-    let historyAction = (opts == null ? void 0 : opts.replace) === true || submission != null ? exports.Action.Replace : exports.Action.Push;
+    let location = createLocation(state.location, path, opts && opts.state);
+    let historyAction = (opts && opts.replace) === true || submission != null ? exports.Action.Replace : exports.Action.Push;
     let preventScrollReset = opts && "preventScrollReset" in opts ? opts.preventScrollReset === true : undefined;
     return await startNavigation(historyAction, location, {
       submission,
@@ -1421,7 +1410,7 @@ function createRouter(init) {
       // render at the right error boundary after we match routes
       pendingError: error,
       preventScrollReset,
-      replace: opts == null ? void 0 : opts.replace
+      replace: opts && opts.replace
     });
   } // Revalidate all current loaders.  If a navigation is in progress or if this
   // is interrupted by a navigation, allow this to "succeed" by calling all
@@ -1461,20 +1450,18 @@ function createRouter(init) {
 
 
   async function startNavigation(historyAction, location, opts) {
-    var _pendingNavigationCon2;
-
     // Abort any in-progress navigations and start a new one. Unset any ongoing
     // uninterrupted revalidations unless told otherwise, since we want this
     // new navigation to update history normally
-    (_pendingNavigationCon2 = pendingNavigationController) == null ? void 0 : _pendingNavigationCon2.abort();
+    pendingNavigationController && pendingNavigationController.abort();
     pendingNavigationController = null;
     pendingAction = historyAction;
-    isUninterruptedRevalidation = (opts == null ? void 0 : opts.startUninterruptedRevalidation) === true; // Save the current scroll position every time we start a new navigation,
+    isUninterruptedRevalidation = (opts && opts.startUninterruptedRevalidation) === true; // Save the current scroll position every time we start a new navigation,
     // and track whether we should reset scroll on completion
 
     saveScrollPosition(state.location, state.matches);
-    pendingPreventScrollReset = (opts == null ? void 0 : opts.preventScrollReset) === true;
-    let loadingNavigation = opts == null ? void 0 : opts.overrideNavigation;
+    pendingPreventScrollReset = (opts && opts.preventScrollReset) === true;
+    let loadingNavigation = opts && opts.overrideNavigation;
     let matches = matchRoutes(dataRoutes, location, init.basename); // Short circuit with a 404 on the root error boundary if we match nothing
 
     if (!matches) {
@@ -1505,11 +1492,11 @@ function createRouter(init) {
 
 
     pendingNavigationController = new AbortController();
-    let request = createRequest(location, pendingNavigationController.signal, opts == null ? void 0 : opts.submission);
+    let request = createRequest(location, pendingNavigationController.signal, opts && opts.submission);
     let pendingActionData;
     let pendingError;
 
-    if (opts != null && opts.pendingError) {
+    if (opts && opts.pendingError) {
       // If we have a pendingError, it means the user attempted a GET submission
       // with binary FormData so assign here and skip to handleLoaders.  That
       // way we handle calling loaders above the boundary etc.  It's not really
@@ -1517,7 +1504,7 @@ function createRouter(init) {
       pendingError = {
         [findNearestBoundary(matches).route.id]: opts.pendingError
       };
-    } else if (opts != null && opts.submission) {
+    } else if (opts && opts.submission) {
       // Call action if we received an action submission
       let actionOutput = await handleAction(request, location, opts.submission, matches, {
         replace: opts.replace
@@ -1543,7 +1530,7 @@ function createRouter(init) {
       shortCircuited,
       loaderData,
       errors
-    } = await handleLoaders(request, location, matches, loadingNavigation, opts == null ? void 0 : opts.submission, opts == null ? void 0 : opts.replace, pendingActionData, pendingError);
+    } = await handleLoaders(request, location, matches, loadingNavigation, opts && opts.submission, opts && opts.replace, pendingActionData, pendingError);
 
     if (shortCircuited) {
       return;
@@ -1595,7 +1582,7 @@ function createRouter(init) {
         location: createLocation(state.location, result.location)
       }, submission);
 
-      await startRedirectNavigation(result, redirectNavigation, opts == null ? void 0 : opts.replace);
+      await startRedirectNavigation(result, redirectNavigation, opts && opts.replace);
       return {
         shortCircuited: true
       };
@@ -1609,7 +1596,7 @@ function createRouter(init) {
       // back to PUSH so that the user can use the back button to get back to
       // the pre-submission form location to try again
 
-      if ((opts == null ? void 0 : opts.replace) !== true) {
+      if ((opts && opts.replace) !== true) {
         pendingAction = exports.Action.Push;
       }
 
@@ -1653,7 +1640,7 @@ function createRouter(init) {
     // about to reload.  Note that if this is an action reload we would have
     // already cancelled all pending deferreds so this would be a no-op
 
-    cancelActiveDeferreds(routeId => !(matches != null && matches.some(m => m.route.id === routeId)) || (matchesToLoad == null ? void 0 : matchesToLoad.some(m => m.route.id === routeId))); // Short circuit if we have no loaders to run
+    cancelActiveDeferreds(routeId => !(matches && matches.some(m => m.route.id === routeId)) || matchesToLoad && matchesToLoad.some(m => m.route.id === routeId)); // Short circuit if we have no loaders to run
 
     if (matchesToLoad.length === 0 && revalidatingFetchers.length === 0) {
       completeNavigation(location, {
@@ -1674,12 +1661,11 @@ function createRouter(init) {
 
     if (!isUninterruptedRevalidation) {
       revalidatingFetchers.forEach(_ref2 => {
-        var _state$fetchers$get;
-
         let [key] = _ref2;
+        const fetcher = state.fetchers.get(key);
         let revalidatingFetcher = {
           state: "loading",
-          data: (_state$fetchers$get = state.fetchers.get(key)) == null ? void 0 : _state$fetchers$get.data,
+          data: fetcher && fetcher.data,
           formMethod: undefined,
           formAction: undefined,
           formEncType: undefined,
@@ -1777,7 +1763,7 @@ function createRouter(init) {
     let {
       path,
       submission
-    } = normalizeNavigateOptions(href, opts);
+    } = normalizeNavigateOptions(href, opts, true);
     let match = getTargetMatch(matches, path);
 
     if (submission) {
@@ -1794,8 +1780,6 @@ function createRouter(init) {
 
 
   async function handleFetcherAction(key, routeId, path, match, submission) {
-    var _state$fetchers$get2;
-
     interruptActiveLoads();
     fetchLoadMatches.delete(key);
 
@@ -1808,10 +1792,12 @@ function createRouter(init) {
     } // Put this fetcher into it's submitting state
 
 
+    let existingFetcher = state.fetchers.get(key);
+
     let fetcher = _extends({
       state: "submitting"
     }, submission, {
-      data: ((_state$fetchers$get2 = state.fetchers.get(key)) == null ? void 0 : _state$fetchers$get2.data) || undefined
+      data: existingFetcher && existingFetcher.data
     });
 
     state.fetchers.set(key, fetcher);
@@ -1894,12 +1880,11 @@ function createRouter(init) {
       let [staleKey] = _ref5;
       return staleKey !== key;
     }).forEach(_ref6 => {
-      var _state$fetchers$get3;
-
       let [staleKey] = _ref6;
+      let existingFetcher = state.fetchers.get(staleKey);
       let revalidatingFetcher = {
         state: "loading",
-        data: (_state$fetchers$get3 = state.fetchers.get(staleKey)) == null ? void 0 : _state$fetchers$get3.data,
+        data: existingFetcher && existingFetcher.data,
         formMethod: undefined,
         formAction: undefined,
         formEncType: undefined,
@@ -1954,10 +1939,8 @@ function createRouter(init) {
     // navigation and complete it with the fetcher data
 
     if (state.navigation.state === "loading" && loadId > pendingNavigationLoadId) {
-      var _pendingNavigationCon3;
-
       invariant(pendingAction, "Expected pending action");
-      (_pendingNavigationCon3 = pendingNavigationController) == null ? void 0 : _pendingNavigationCon3.abort();
+      pendingNavigationController && pendingNavigationController.abort();
       completeNavigation(state.navigation.location, {
         matches,
         loaderData,
@@ -1980,16 +1963,15 @@ function createRouter(init) {
 
 
   async function handleFetcherLoader(key, routeId, path, match) {
-    var _state$fetchers$get4;
+    let existingFetcher = state.fetchers.get(key); // Put this fetcher into it's loading state
 
-    // Put this fetcher into it's loading state
     let loadingFetcher = {
       state: "loading",
       formMethod: undefined,
       formAction: undefined,
       formEncType: undefined,
       formData: undefined,
-      data: ((_state$fetchers$get4 = state.fetchers.get(key)) == null ? void 0 : _state$fetchers$get4.data) || undefined
+      data: existingFetcher && existingFetcher.data
     };
     state.fetchers.set(key, loadingFetcher);
     updateState({
@@ -2588,7 +2570,11 @@ function getStaticContextFromError(routes, context, error) {
 } // Normalize navigation options by converting formMethod=GET formData objects to
 // URLSearchParams so they behave identically to links with query params
 
-function normalizeNavigateOptions(to, opts) {
+function normalizeNavigateOptions(to, opts, isFetcher) {
+  if (isFetcher === void 0) {
+    isFetcher = false;
+  }
+
   let path = typeof to === "string" ? to : createPath(to); // Return location verbatim on non-submission navigations
 
   if (!opts || !("formMethod" in opts) && !("formData" in opts)) {
@@ -2604,7 +2590,7 @@ function normalizeNavigateOptions(to, opts) {
       submission: {
         formMethod: opts.formMethod,
         formAction: createHref(parsePath(path)),
-        formEncType: (opts == null ? void 0 : opts.formEncType) || "application/x-www-form-urlencoded",
+        formEncType: opts && opts.formEncType || "application/x-www-form-urlencoded",
         formData: opts.formData
       }
     };
@@ -2621,7 +2607,14 @@ function normalizeNavigateOptions(to, opts) {
   let parsedPath = parsePath(path);
 
   try {
-    let searchParams = convertFormDataToSearchParams(opts.formData);
+    let searchParams = convertFormDataToSearchParams(opts.formData); // Since fetcher GET submissions only run a single loader (as opposed to
+    // navigation GET submissions which run all loaders), we need to preserve
+    // any incoming ?index params
+
+    if (isFetcher && parsedPath.search && hasNakedIndexQuery(parsedPath.search)) {
+      searchParams.append("index", "");
+    }
+
     parsedPath.search = "?" + searchParams;
   } catch (e) {
     return {
@@ -2678,7 +2671,7 @@ function getMatchesToLoad(state, matches, submission, location, isRevalidationRe
   cancelledDeferredRoutes.some(id => id === match.route.id) || shouldRevalidateLoader(state.location, state.matches[index], submission, location, match, isRevalidationRequired, actionResult))); // Pick fetcher.loads that need to be revalidated
 
   let revalidatingFetchers = [];
-  fetchLoadMatches == null ? void 0 : fetchLoadMatches.forEach((_ref10, key) => {
+  fetchLoadMatches && fetchLoadMatches.forEach((_ref10, key) => {
     let [href, match] = _ref10;
 
     // This fetcher was cancelled from a prior action submission - force reload
@@ -2707,12 +2700,11 @@ function isNewLoader(currentLoaderData, currentMatch, match) {
 }
 
 function isNewRouteInstance(currentMatch, match) {
-  var _currentMatch$route$p;
-
+  let currentPath = currentMatch.route.path;
   return (// param change for this match, /users/123 -> /users/456
     currentMatch.pathname !== match.pathname || // splat param changed, which is not present in match.path
     // e.g. /files/images/avatar.jpg -> files/finances.xls
-    ((_currentMatch$route$p = currentMatch.route.path) == null ? void 0 : _currentMatch$route$p.endsWith("*")) && currentMatch.params["*"] !== match.params["*"]
+    currentPath && currentPath.endsWith("*") && currentMatch.params["*"] !== match.params["*"]
   );
 }
 
@@ -2785,8 +2777,6 @@ async function callLoaderOrAction(type, request, match, skipRedirects, isRouteRe
   }
 
   if (result instanceof Response) {
-    var _result$headers$get;
-
     // Process redirects
     let status = result.status;
     let location = result.headers.get("Location"); // For SSR single-route requests, we want to hand Responses back directly
@@ -2813,8 +2803,9 @@ async function callLoaderOrAction(type, request, match, skipRedirects, isRouteRe
     }
 
     let data;
+    let contentType = result.headers.get("Content-Type");
 
-    if ((_result$headers$get = result.headers.get("Content-Type")) != null && _result$headers$get.startsWith("application/json")) {
+    if (contentType && contentType.startsWith("application/json")) {
       data = await result.json();
     } else {
       data = await result.text();
@@ -2926,7 +2917,7 @@ function processRouteLoaderData(matches, matchesToLoad, results, pendingError, a
         loaderHeaders[id] = result.headers;
       }
     } else if (isDeferredResult(result)) {
-      activeDeferreds == null ? void 0 : activeDeferreds.set(id, result.deferredData);
+      activeDeferreds && activeDeferreds.set(id, result.deferredData);
       loaderData[id] = result.deferredData.data; // TODO: Add statusCode/headers once we wire up streaming in Remix
     } else {
       loaderData[id] = result.data; // Error status codes always override success status codes, but if all
@@ -2967,11 +2958,9 @@ function processLoaderData(state, matches, matchesToLoad, results, pendingError,
     let result = fetcherResults[index]; // Process fetcher non-redirect errors
 
     if (isErrorResult(result)) {
-      var _errors;
-
       let boundaryMatch = findNearestBoundary(state.matches, match.route.id);
 
-      if (!((_errors = errors) != null && _errors[boundaryMatch.route.id])) {
+      if (!(errors && errors[boundaryMatch.route.id])) {
         errors = _extends({}, errors, {
           [boundaryMatch.route.id]: result.error
         });
@@ -3081,7 +3070,7 @@ function isErrorResult(result) {
 }
 
 function isRedirectResult(result) {
-  return (result == null ? void 0 : result.type) === ResultType.redirect;
+  return (result && result.type) === ResultType.redirect;
 }
 
 async function resolveDeferredResults(currentMatches, matchesToLoad, results, signal, isFetcher, currentLoaderData) {
@@ -3089,7 +3078,7 @@ async function resolveDeferredResults(currentMatches, matchesToLoad, results, si
     let result = results[index];
     let match = matchesToLoad[index];
     let currentMatch = currentMatches.find(m => m.route.id === match.route.id);
-    let isRevalidatingLoader = currentMatch != null && !isNewRouteInstance(currentMatch, match) && (currentLoaderData == null ? void 0 : currentLoaderData[match.route.id]) !== undefined;
+    let isRevalidatingLoader = currentMatch != null && !isNewRouteInstance(currentMatch, match) && (currentLoaderData && currentLoaderData[match.route.id]) !== undefined;
 
     if (isDeferredResult(result) && (isFetcher || isRevalidatingLoader)) {
       // Note: we do not have to touch activeDeferreds here since we race them