@remix-run/router 1.9.0-pre.0 → 1.9.0-pre.2

package/dist/router.umd.js

@@ -1,5 +1,5 @@
 /**
- * @remix-run/router v1.9.0-pre.0
+ * @remix-run/router v1.9.0-pre.2
  *
  * 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.
+   * `history.push` or `history.replace`. This 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
 
@@ -327,7 +324,7 @@
       try {
         // Welcome to debugging history!
         //
-        // This error is thrown as a convenience so you can more easily
+        // This error is thrown as a convenience, so you can more easily
         // find the source for a warning that appears in the console by
         // enabling "pause on exceptions" in your JavaScript debugger.
         throw new Error(message);
@@ -607,32 +604,29 @@
    * 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
+  //   Also, make them a type alias instead of an interface
   /**
    * 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
@@ -640,25 +634,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"]);
 
   /**
@@ -700,7 +690,7 @@
    */
 
   // Attempt to parse the given string segment. If it fails, then just return the
-  // plain string type as a default fallback. Otherwise return the union of the
+  // plain string type as a default fallback. Otherwise, return the union of the
   // parsed string literals that were referenced as dynamic segments in the route.
   /**
    * The parameters that were parsed from the URL path.
@@ -712,7 +702,7 @@
     return route.index === true;
   }
 
-  // Walk the route tree generating unique IDs where necessary so we are working
+  // Walk the route tree generating unique IDs where necessary, so we are working
   // solely with AgnosticDataRouteObject's within the Router
   function convertRoutesToDataRoutes(routes, mapRouteProperties, parentPath, manifest) {
     if (parentPath === void 0) {
@@ -775,6 +765,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 = [];
@@ -799,7 +803,7 @@
       let path = joinPaths([parentPath, meta.relativePath]);
       let routesMeta = parentsMeta.concat(meta);
 
-      // Add the children before adding this route to the array so we traverse the
+      // Add the children before adding this route to the array, so we traverse the
       // route tree depth-first and child routes appear before their parents in
       // the "flattened" version.
       if (route.children && route.children.length > 0) {
@@ -867,15 +871,15 @@
     let result = [];
 
     // All child paths with the prefix.  Do this for all children before the
-    // optional version for all children so we get consistent ordering where the
+    // optional version for all children, so we get consistent ordering where the
     // parent optional aspect is preferred as required.  Otherwise, we can get
     // child sections interspersed where deeper optional segments are higher than
-    // parent optional segments, where for example, /:two would explodes _earlier_
+    // parent optional segments, where for example, /:two would explode _earlier_
     // then /:one.  By always including the parent as required _for all children_
     // first, we avoid this issue
     result.push(...restExploded.map(subpath => subpath === "" ? required : [required, subpath].join("/")));
 
-    // Then if this is an optional value, add all child versions without
+    // Then, if this is an optional value, add all child versions without
     if (isOptional) {
       result.push(...restExploded);
     }
@@ -1063,7 +1067,7 @@
       regexpSource += "\\/*$";
     } else if (path !== "" && path !== "/") {
       // If our path is non-empty and contains anything beyond an initial slash,
-      // then we have _some_ form of path in our regex so we should expect to
+      // then we have _some_ form of path in our regex, so we should expect to
       // match only if we find the end of this path segment.  Look for an optional
       // non-captured trailing slash (to match a portion of the URL) or the end
       // of the path (if we've matched to the end).  We used to do this with a
@@ -2974,7 +2978,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;
@@ -4379,23 +4383,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 || "")) {
@@ -4551,6 +4538,7 @@
   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;