@remix-run/router 1.8.0 → 1.9.0-pre.1

package/dist/router.umd.js

@@ -1,5 +1,5 @@
 /**
- * @remix-run/router v1.8.0
+ * @remix-run/router v1.9.0-pre.1
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -47,25 +47,23 @@
    * The pathname, search, and hash values of a URL.
    */
 
+  // TODO: (v7) Change the Location generic default from `any` to `unknown` and
+  // remove Remix `useLocation` wrapper.
   /**
    * An entry in a history stack. A location contains information about the
    * URL path, as well as possibly some arbitrary state and a key.
    */
-
   /**
    * A change to the current location.
    */
-
   /**
    * A function that receives notifications about location changes.
    */
-
   /**
    * Describes a location that is the destination of some navigation, either via
    * `history.push` or `history.replace`. May be either a URL or the pieces of a
    * URL path.
    */
-
   /**
    * A history is an interface to the navigation stack. The history serves as the
    * source of truth for the current location, as well as provides a set of
@@ -74,7 +72,6 @@
    * It is similar to the DOM's `window.history` object, but with a smaller, more
    * focused API.
    */
-
   const PopStateEventType = "popstate";
   //#endregion
 
@@ -607,28 +604,28 @@
    * this as a private implementation detail in case they diverge in the future.
    */
 
+  // TODO: (v7) Change the defaults from any to unknown in and remove Remix wrappers:
+  //   ActionFunction, ActionFunctionArgs, LoaderFunction, LoaderFunctionArgs
   /**
    * Arguments passed to loader functions
    */
-
   /**
    * Arguments passed to action functions
    */
-
   /**
    * Loaders and actions can return anything except `undefined` (`null` is a
    * valid return value if there is no data to return).  Responses are preferred
    * and will ease any future migration to Remix
    */
-
   /**
    * Route loader function signature
    */
-
   /**
    * Route action function signature
    */
-
+  /**
+   * Arguments passed to shouldRevalidate function
+   */
   /**
    * Route shouldRevalidate function signature.  This runs after any submission
    * (navigation or fetcher), so we flatten the navigation/fetcher submission
@@ -636,25 +633,21 @@
    * or a fetcher, what really matters is the URLs and the formData since loaders
    * have to re-run based on the data models that were potentially mutated.
    */
-
   /**
    * Function provided by the framework-aware layers to set `hasErrorBoundary`
    * from the framework-aware `errorElement` prop
    *
    * @deprecated Use `mapRouteProperties` instead
    */
-
   /**
    * Function provided by the framework-aware layers to set any framework-specific
    * properties from framework-agnostic properties
    */
-
   /**
    * Keys we cannot change from within a lazy() function. We spread all other keys
    * onto the route. Either they're meaningful to the router, or they'll get
    * ignored.
    */
-
   const immutableRouteKeys = new Set(["lazy", "caseSensitive", "path", "id", "index", "children"]);
 
   /**
@@ -771,6 +764,20 @@
     }
     return matches;
   }
+  function convertRouteMatchToUiMatch(match, loaderData) {
+    let {
+      route,
+      pathname,
+      params
+    } = match;
+    return {
+      id: route.id,
+      pathname,
+      params,
+      data: loaderData[route.id],
+      handle: route.handle
+    };
+  }
   function flattenRoutes(routes, branches, parentsMeta, parentPath) {
     if (branches === void 0) {
       branches = [];
@@ -1467,7 +1474,7 @@
    * @private
    * Utility class we use to hold auto-unwrapped 4xx/5xx Response bodies
    */
-  class ErrorResponse {
+  class ErrorResponseImpl {
     constructor(status, statusText, data, internal) {
       if (internal === void 0) {
         internal = false;
@@ -1484,6 +1491,9 @@
     }
   }
 
+  // We don't want the class exported since usage of it at runtime is an
+  // implementation detail, but we do want to export the shape so folks can
+  // build their own abstractions around instances via isRouteErrorResponse()
   /**
    * Check if the given error is an ErrorResponse generated from a 4xx/5xx
    * Response thrown from an action/loader
@@ -2468,8 +2478,7 @@
             fetchers: new Map(state.fetchers)
           });
           return startRedirectNavigation(state, actionResult, {
-            submission,
-            isFetchActionRedirect: true
+            fetcherSubmission: submission
           });
         }
       }
@@ -2684,18 +2693,15 @@
     async function startRedirectNavigation(state, redirect, _temp) {
       let {
         submission,
-        replace,
-        isFetchActionRedirect
+        fetcherSubmission,
+        replace
       } = _temp === void 0 ? {} : _temp;
       if (redirect.revalidate) {
         isRevalidationRequired = true;
       }
-      let redirectLocation = createLocation(state.location, redirect.location, // TODO: This can be removed once we get rid of useTransition in Remix v2
-      _extends({
+      let redirectLocation = createLocation(state.location, redirect.location, {
         _isRedirect: true
-      }, isFetchActionRedirect ? {
-        _isFetchActionRedirect: true
-      } : {}));
+      });
       invariant(redirectLocation, "Expected a location on the redirect navigation");
       if (isBrowser) {
         let isDocumentReload = false;
@@ -2727,11 +2733,19 @@
 
       // Use the incoming submission if provided, fallback on the active one in
       // state.navigation
-      let activeSubmission = submission || getSubmissionFromNavigation(state.navigation);
+      let {
+        formMethod,
+        formAction,
+        formEncType
+      } = state.navigation;
+      if (!submission && !fetcherSubmission && formMethod && formAction && formEncType) {
+        submission = getSubmissionFromNavigation(state.navigation);
+      }
 
       // If this was a 307/308 submission we want to preserve the HTTP method and
       // re-submit the GET/POST/PUT/PATCH/DELETE as a submission navigation to the
       // redirected location
+      let activeSubmission = submission || fetcherSubmission;
       if (redirectPreserveMethodStatusCodes.has(redirect.status) && activeSubmission && isMutationMethod(activeSubmission.formMethod)) {
         await startNavigation(redirectHistoryAction, redirectLocation, {
           submission: _extends({}, activeSubmission, {
@@ -2740,20 +2754,14 @@
           // Preserve this flag across redirects
           preventScrollReset: pendingPreventScrollReset
         });
-      } else if (isFetchActionRedirect) {
-        // For a fetch action redirect, we kick off a new loading navigation
-        // without the fetcher submission, but we send it along for shouldRevalidate
-        await startNavigation(redirectHistoryAction, redirectLocation, {
-          overrideNavigation: getLoadingNavigation(redirectLocation),
-          fetcherSubmission: activeSubmission,
-          // Preserve this flag across redirects
-          preventScrollReset: pendingPreventScrollReset
-        });
       } else {
-        // If we have a submission, we will preserve it through the redirect navigation
-        let overrideNavigation = getLoadingNavigation(redirectLocation, activeSubmission);
+        // If we have a navigation submission, we will preserve it through the
+        // redirect navigation
+        let overrideNavigation = getLoadingNavigation(redirectLocation, submission);
         await startNavigation(redirectHistoryAction, redirectLocation, {
           overrideNavigation,
+          // Send fetcher submissions through for shouldRevalidate
+          fetcherSubmission,
           // Preserve this flag across redirects
           preventScrollReset: pendingPreventScrollReset
         });
@@ -2969,7 +2977,7 @@
     }
     function getScrollKey(location, matches) {
       if (getScrollRestorationKey) {
-        let key = getScrollRestorationKey(location, matches.map(m => createUseMatchesMatch(m, state.loaderData)));
+        let key = getScrollRestorationKey(location, matches.map(m => convertRouteMatchToUiMatch(m, state.loaderData)));
         return key || location.key;
       }
       return location.key;
@@ -3272,7 +3280,7 @@
         });
         if (request.signal.aborted) {
           let method = isRouteRequest ? "queryRoute" : "query";
-          throw new Error(method + "() call aborted");
+          throw new Error(method + "() call aborted: " + request.method + " " + request.url);
         }
       }
       if (isRedirectResult(result)) {
@@ -3391,7 +3399,7 @@
       }))]);
       if (request.signal.aborted) {
         let method = isRouteRequest ? "queryRoute" : "query";
-        throw new Error(method + "() call aborted");
+        throw new Error(method + "() call aborted: " + request.method + " " + request.url);
       }
 
       // Process and commit output from loaders
@@ -3848,7 +3856,17 @@
       if (match.route.lazy) {
         if (handler) {
           // Run statically defined handler in parallel with lazy()
-          let values = await Promise.all([runHandler(handler), loadLazyRouteModule(match.route, mapRouteProperties, manifest)]);
+          let handlerError;
+          let values = await Promise.all([
+          // If the handler throws, don't let it immediately bubble out,
+          // since we need to let the lazy() execution finish so we know if this
+          // route has a boundary that can handle the error
+          runHandler(handler).catch(e => {
+            handlerError = e;
+          }), loadLazyRouteModule(match.route, mapRouteProperties, manifest)]);
+          if (handlerError) {
+            throw handlerError;
+          }
           result = values[0];
         } else {
           // Load lazy route module, then run any returned handler
@@ -3956,7 +3974,7 @@
       if (resultType === ResultType.error) {
         return {
           type: resultType,
-          error: new ErrorResponse(status, result.statusText, data),
+          error: new ErrorResponseImpl(status, result.statusText, data),
           headers: result.headers
         };
       }
@@ -4235,7 +4253,7 @@
         errorMessage = "Invalid request method \"" + method.toUpperCase() + "\"";
       }
     }
-    return new ErrorResponse(status || 500, statusText, new Error(errorMessage), true);
+    return new ErrorResponseImpl(status || 500, statusText, new Error(errorMessage), true);
   }
 
   // Find any returned redirect errors, starting from the lowest match
@@ -4364,23 +4382,6 @@
   function hasNakedIndexQuery(search) {
     return new URLSearchParams(search).getAll("index").some(v => v === "");
   }
-
-  // Note: This should match the format exported by useMatches, so if you change
-  // this please also change that :)  Eventually we'll DRY this up
-  function createUseMatchesMatch(match, loaderData) {
-    let {
-      route,
-      pathname,
-      params
-    } = match;
-    return {
-      id: route.id,
-      pathname,
-      params,
-      data: loaderData[route.id],
-      handle: route.handle
-    };
-  }
   function getTargetMatch(matches, location) {
     let search = typeof location === "string" ? parsePath(location).search : location.search;
     if (matches[matches.length - 1].route.index && hasNakedIndexQuery(search || "")) {
@@ -4483,8 +4484,7 @@
         formData: submission.formData,
         json: submission.json,
         text: submission.text,
-        data,
-        " _hasFetcherDoneAnything ": true
+        data
       };
       return fetcher;
     } else {
@@ -4496,8 +4496,7 @@
         formData: undefined,
         json: undefined,
         text: undefined,
-        data,
-        " _hasFetcherDoneAnything ": true
+        data
       };
       return fetcher;
     }
@@ -4511,8 +4510,7 @@
       formData: submission.formData,
       json: submission.json,
       text: submission.text,
-      data: existingFetcher ? existingFetcher.data : undefined,
-      " _hasFetcherDoneAnything ": true
+      data: existingFetcher ? existingFetcher.data : undefined
     };
     return fetcher;
   }
@@ -4525,8 +4523,7 @@
       formData: undefined,
       json: undefined,
       text: undefined,
-      data,
-      " _hasFetcherDoneAnything ": true
+      data
     };
     return fetcher;
   }
@@ -4534,12 +4531,13 @@
 
   exports.AbortedDeferredError = AbortedDeferredError;
   exports.Action = Action;
-  exports.ErrorResponse = ErrorResponse;
   exports.IDLE_BLOCKER = IDLE_BLOCKER;
   exports.IDLE_FETCHER = IDLE_FETCHER;
   exports.IDLE_NAVIGATION = IDLE_NAVIGATION;
   exports.UNSAFE_DEFERRED_SYMBOL = UNSAFE_DEFERRED_SYMBOL;
   exports.UNSAFE_DeferredData = DeferredData;
+  exports.UNSAFE_ErrorResponseImpl = ErrorResponseImpl;
+  exports.UNSAFE_convertRouteMatchToUiMatch = convertRouteMatchToUiMatch;
   exports.UNSAFE_convertRoutesToDataRoutes = convertRoutesToDataRoutes;
   exports.UNSAFE_getPathContributingMatches = getPathContributingMatches;
   exports.UNSAFE_invariant = invariant;