@remix-run/router 1.1.0-pre.0 → 1.1.0

package/CHANGELOG.md

@@ -1,24 +1,32 @@
 # `@remix-run/router`
 
-## 1.1.0-pre.0
+## 1.1.0
+
+This release introduces support for [Optional Route Segments](https://github.com/remix-run/react-router/issues/9546). Now, adding a `?` to the end of any path segment will make that entire segment optional. This works for both static segments and dynamic parameters.
+
+**Optional Params Examples**
+
+- Path `lang?/about` will match:
+  - `/:lang/about`
+  - `/about`
+- Path `/multistep/:widget1?/widget2?/widget3?` will match:
+  - `/multistep`
+  - `/multistep/:widget1`
+  - `/multistep/:widget1/:widget2`
+  - `/multistep/:widget1/:widget2/:widget3`
+
+**Optional Static Segment Example**
+
+- Path `/home?` will match:
+  - `/`
+  - `/home`
+- Path `/fr?/about` will match:
+  - `/about`
+  - `/fr/about`
 
 ### Minor Changes
 
-- Support for optional path segments ([#9650](https://github.com/remix-run/react-router/pull/9650))
-  - You can now denote optional path segments with a `?` as the last character in a path segment
-  - Optional params examples
-    - `:lang?/about` will get expanded and match:
-      - `/:lang/about`
-      - `/about`
-    - `/multistep/:widget1?/widget2?/widget3?` will get expanded and match:
-      - `/multistep/:widget1/:widget2/:widget3`
-      - `/multistep/:widget1/:widget2`
-      - `/multistep/:widget1`
-      - `/multistep`
-  - Optional static segment example
-    - `/fr?/about` will get expanded and match:
-      - `/fr/about`
-      - `/about`
+- Allows optional routes and optional static segments ([#9650](https://github.com/remix-run/react-router/pull/9650))
 
 ### Patch Changes
 
@@ -44,9 +52,10 @@ function Comp() {
 }
 ```
 
-- Fix requests sent to revalidating loaders so they reflect a GET request ([#9660](https://github.com/remix-run/react-router/pull/9660))
 - Persist `headers` on `loader` `request`'s after SSR document `action` request ([#9721](https://github.com/remix-run/react-router/pull/9721))
-- `GET` forms now expose a submission on the loading navigation ([#9695](https://github.com/remix-run/react-router/pull/9695))
+- Fix requests sent to revalidating loaders so they reflect a GET request ([#9660](https://github.com/remix-run/react-router/pull/9660))
+- Fix issue with deeply nested optional segments ([#9727](https://github.com/remix-run/react-router/pull/9727))
+- GET forms now expose a submission on the loading navigation ([#9695](https://github.com/remix-run/react-router/pull/9695))
 - Fix error boundary tracking for multiple errors bubbling to the same boundary ([#9702](https://github.com/remix-run/react-router/pull/9702))
 
 ## 1.0.5

package/dist/router.cjs.js

@@ -1,5 +1,5 @@
 /**
- * @remix-run/router v1.1.0-pre.0
+ * @remix-run/router v1.1.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -691,22 +691,26 @@ function explodeOptionalSegments(path) {
   if (rest.length === 0) {
     // Intepret empty string as omitting an optional segment
     // `["one", "", "three"]` corresponds to omitting `:two` from `/one/:two?/three` -> `/one/three`
-    return isOptional ? ["", required] : [required];
+    return isOptional ? [required, ""] : [required];
   }
 
   let restExploded = explodeOptionalSegments(rest.join("/"));
-  return restExploded.flatMap(subpath => {
-    // /one + / + :two/three -> /one/:two/three
-    let requiredExploded = subpath === "" ? required : required + "/" + subpath; // For optional segments, return the exploded path _without_ current segment first (`subpath`)
-    // and exploded path _with_ current segment later (`subpath`)
-    // This ensures that exploded paths are emitted in priority order
-    // `/one/three/:four` will come before `/one/three/:five`
-
-    return isOptional ? [subpath, requiredExploded] : [requiredExploded];
-  }).map(exploded => {
-    // for absolute paths, ensure `/` instead of empty segment
-    return path.startsWith("/") && exploded === "" ? "/" : exploded;
-  });
+  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
+  // 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_
+  // 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
+
+  if (isOptional) {
+    result.push(...restExploded);
+  } // for absolute paths, ensure `/` instead of empty segment
+
+
+  return result.map(exploded => path.startsWith("/") && exploded === "" ? "/" : exploded);
 }
 
 function rankRouteBranches(branches) {