@xmachines/play-router 2.2.0 → 4.0.0

package/dist/router-sync.d.ts

@@ -67,7 +67,7 @@ export declare function sanitizePathname(pathname: string): string | null;
  * @param pathname - The concrete URL pathname, for example `/profile/alice`
  * @param pattern  - The template of the URL pattern, for example `/profile/:username`
  * @returns The record of the parameter values of the read, or `{}` for a static pattern.
- * @throws {URLPatternUnavailableError} When `URLPattern` is absent and the pattern holds a parameter.
+ * @throws {InvalidRoutePatternError} When URLPattern cannot compile the pattern.
  *
  * @example
  * ```typescript

package/dist/router-sync.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"router-sync.d.ts","sourceRoot":"","sources":["../src/router-sync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAWjD,MAAM,WAAW,UAAU;IAC1B,EAAE,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,0BAA0B;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,KAAK,EAAE,CAAC,iBAAiB,EAAE,MAAM,KAAK,UAAU,CAAC;CACjD;AAED,MAAM,WAAW,gBAAgB;IAChC,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC1D,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACxD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC5B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,gBAAgB,EAC1B,aAAa,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC1E,UAAU,CAUZ;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAKhE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAmB5F;AAeD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAUnE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAClC,OAAO,EAAE,0BAA0B,GACjC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,cAAc,CAAA;CAAE,GAAG,IAAI,CAsBpD"}
+{"version":3,"file":"router-sync.d.ts","sourceRoot":"","sources":["../src/router-sync.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,MAAM,WAAW,UAAU;IAC1B,EAAE,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,0BAA0B;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,KAAK,EAAE,CAAC,iBAAiB,EAAE,MAAM,KAAK,UAAU,CAAC;CACjD;AAED,MAAM,WAAW,gBAAgB;IAChC,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC1D,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACxD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC5B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,gBAAgB,EAC1B,aAAa,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC1E,UAAU,CAUZ;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAUhE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAyB5F;AAeD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAgBnE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAClC,OAAO,EAAE,0BAA0B,GACjC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,cAAc,CAAA;CAAE,GAAG,IAAI,CAsBpD"}

package/dist/router-sync.js

@@ -1,5 +1,4 @@
-import { getURLPatternCtor, getNormalizedParamNameMap, getCompiledPattern, isParameterizedPattern, } from "./url-pattern-utils.js";
-import { URLPatternUnavailableError } from "./errors.js";
+import { getCompiledPattern, getNormalizedParamNameMap, isParameterizedPattern, } from "@xmachines/play-url";
 /**
  * Matches a clean pathname against a route map, and reads each param of the match.
  *
@@ -43,8 +42,13 @@ export function matchRouteMap(pathname, routeMap, extractParams) {
 export function sanitizePathname(pathname) {
     if (pathname.length > 2048)
         return null;
-    const withoutQuery = pathname.split("?")[0];
-    const withoutHash = withoutQuery.split("#")[0];
+    // `slice` to the first separator. `split` allocates an array for a value that the
+    // code reads once, and its first element reads `string | undefined` although a split
+    // answers one element always.
+    const queryAt = pathname.indexOf("?");
+    const withoutQuery = queryAt === -1 ? pathname : pathname.slice(0, queryAt);
+    const hashAt = withoutQuery.indexOf("#");
+    const withoutHash = hashAt === -1 ? withoutQuery : withoutQuery.slice(0, hashAt);
     return withoutHash.replace(/\/+/g, "/");
 }
 /**
@@ -70,7 +74,7 @@ export function sanitizePathname(pathname) {
  * @param pathname - The concrete URL pathname, for example `/profile/alice`
  * @param pattern  - The template of the URL pattern, for example `/profile/:username`
  * @returns The record of the parameter values of the read, or `{}` for a static pattern.
- * @throws {URLPatternUnavailableError} When `URLPattern` is absent and the pattern holds a parameter.
+ * @throws {InvalidRoutePatternError} When URLPattern cannot compile the pattern.
  *
  * @example
  * ```typescript
@@ -84,27 +88,32 @@ export function sanitizePathname(pathname) {
  * ```
  */
 export function extractRouteParams(pathname, pattern) {
-    const Ctor = getURLPatternCtor();
-    if (!Ctor)
-        throw new URLPatternUnavailableError();
     if (!isParameterizedPattern(pattern))
         return {};
     // Compile the pattern with the SAME normalization as the match in RouteMap.
     // Without it, URLPattern reads ":cat-id" as the group ":cat" and the literal "-id",
     // and the read of the params then contradicts the map that matched the path.
-    const urlPattern = getCompiledPattern(pattern, Ctor);
+    const urlPattern = getCompiledPattern(pattern);
     const match = urlPattern.exec({ pathname });
     if (!match?.pathname.groups)
         return {};
     // Map each normalized group name (":cat_id") back to its original param name ("cat-id").
     const nameMap = getNormalizedParamNameMap(pattern);
-    const params = {};
+    // A null prototype for the accumulator, exactly as `cleanFrameworkParams` uses: a plain
+    // `{}` turns `params["__proto__"] = value` into a write of the PROTOTYPE setter, which
+    // drops the value in silence. A machine that declares `/:__proto__` then received `{}`
+    // from this extraction while the parse of Vue Router or SolidJS Router carried the
+    // value, so the two sources of the same params disagreed.
+    const params = Object.create(null);
     for (const [key, value] of Object.entries(match.pathname.groups)) {
         if (value !== undefined) {
             params[nameMap.get(key) ?? key] = decodeParamValue(value); // nosemgrep: gitlab.eslint.detect-object-injection
         }
     }
-    return params;
+    // Spread at the boundary: `event.params` reaches a machine of the user, and a plain
+    // object is what it received before. A spread creates OWN properties, so a param named
+    // "__proto__" stays a key while the value keeps a prototype.
+    return { ...params };
 }
 /**
  * Decodes each percent sequence of a URLPattern group value. It keeps the raw value
@@ -125,11 +134,17 @@ function decodeParamValue(value) {
  */
 export function extractQuery(search) {
     try {
-        const params = {};
+        // A null prototype for the accumulator, and a spread at the boundary: the same two
+        // steps as `extractRouteParams` above, and for the same reason. A plain `{}` turns
+        // `params["__proto__"] = value` into a write of the PROTOTYPE setter, which drops
+        // the value in silence — so a location of `?__proto__=nav` reached the machine with
+        // an EMPTY query, while the same name in the path reached it as a param. The two
+        // halves of one `play.route` event answered one name differently.
+        const params = Object.create(null);
         new URLSearchParams(search).forEach((value, key) => {
             params[key] = value; // nosemgrep: gitlab.eslint.detect-object-injection
         });
-        return params;
+        return { ...params };
     }
     catch {
         return {};

package/dist/router-sync.js.map

@@ -1 +1 @@
-{"version":3,"file":"router-sync.js","sourceRoot":"","sources":["../src/router-sync.ts"],"names":[],"mappings":"AACA,OAAO,EAGN,iBAAiB,EACjB,yBAAyB,EACzB,kBAAkB,EAClB,sBAAsB,GACtB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAkBzD;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAC5B,QAAgB,EAChB,QAA0B,EAC1B,aAA4E;IAE5E,MAAM,OAAO,GAAG,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACpD,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IACjC,CAAC;IAED,OAAO;QACN,EAAE,EAAE,OAAO;QACX,MAAM,EAAE,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC;KACxC,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAgB;IAChD,IAAI,QAAQ,CAAC,MAAM,GAAG,IAAI;QAAE,OAAO,IAAI,CAAC;IACxC,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/C,OAAO,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,UAAU,kBAAkB,CAAC,QAAgB,EAAE,OAAe;IACnE,MAAM,IAAI,GAA+B,iBAAiB,EAAE,CAAC;IAC7D,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,0BAA0B,EAAE,CAAC;IAClD,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC;QAAE,OAAO,EAAE,CAAC;IAChD,4EAA4E;IAC5E,oFAAoF;IACpF,6EAA6E;IAC7E,MAAM,UAAU,GAAmB,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACrE,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC5C,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvC,yFAAyF;IACzF,MAAM,OAAO,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;IACnD,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAClE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,mDAAmD;QAC/G,CAAC;IACF,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,KAAa;IACtC,IAAI,CAAC;QACJ,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,KAAK,CAAC;IACd,CAAC;AACF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc;IAC1C,IAAI,CAAC;QACJ,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAClD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,mDAAmD;QACzE,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IACf,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,EAAE,CAAC;IACX,CAAC;AACF,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAClC,OAAmC;IAEnC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACpD,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAEnC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACtC,IAAI,CAAC,KAAK,CAAC,EAAE;QAAE,OAAO,IAAI,CAAC;IAE3B,iFAAiF;IACjF,6EAA6E;IAC7E,8EAA8E;IAC9E,8EAA8E;IAC9E,MAAM;IACN,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,EAAE,EAAE,CAAC;IAChE,OAAO;QACN,QAAQ;QACR,KAAK,EAAE;YACN,IAAI,EAAE,YAAY;YAClB,EAAE;YACF,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,EAAE;YAC1B,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;SACzC;KACD,CAAC;AACH,CAAC"}
+{"version":3,"file":"router-sync.js","sourceRoot":"","sources":["../src/router-sync.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,kBAAkB,EAClB,yBAAyB,EACzB,sBAAsB,GAEtB,MAAM,qBAAqB,CAAC;AAmB7B;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAC5B,QAAgB,EAChB,QAA0B,EAC1B,aAA4E;IAE5E,MAAM,OAAO,GAAG,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACpD,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IACjC,CAAC;IAED,OAAO;QACN,EAAE,EAAE,OAAO;QACX,MAAM,EAAE,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC;KACxC,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAgB;IAChD,IAAI,QAAQ,CAAC,MAAM,GAAG,IAAI;QAAE,OAAO,IAAI,CAAC;IACxC,kFAAkF;IAClF,qFAAqF;IACrF,8BAA8B;IAC9B,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,YAAY,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5E,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACjF,OAAO,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,UAAU,kBAAkB,CAAC,QAAgB,EAAE,OAAe;IACnE,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC;QAAE,OAAO,EAAE,CAAC;IAChD,4EAA4E;IAC5E,oFAAoF;IACpF,6EAA6E;IAC7E,MAAM,UAAU,GAAmB,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAC/D,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC5C,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvC,yFAAyF;IACzF,MAAM,OAAO,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;IACnD,wFAAwF;IACxF,uFAAuF;IACvF,uFAAuF;IACvF,mFAAmF;IACnF,0DAA0D;IAC1D,MAAM,MAAM,GAA2B,MAAM,CAAC,MAAM,CAAC,IAAI,CAA2B,CAAC;IACrF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAClE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,mDAAmD;QAC/G,CAAC;IACF,CAAC;IACD,oFAAoF;IACpF,uFAAuF;IACvF,6DAA6D;IAC7D,OAAO,EAAE,GAAG,MAAM,EAAE,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,KAAa;IACtC,IAAI,CAAC;QACJ,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,KAAK,CAAC;IACd,CAAC;AACF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc;IAC1C,IAAI,CAAC;QACJ,mFAAmF;QACnF,mFAAmF;QACnF,kFAAkF;QAClF,oFAAoF;QACpF,iFAAiF;QACjF,kEAAkE;QAClE,MAAM,MAAM,GAA2B,MAAM,CAAC,MAAM,CAAC,IAAI,CAA2B,CAAC;QACrF,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAClD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,mDAAmD;QACzE,CAAC,CAAC,CAAC;QACH,OAAO,EAAE,GAAG,MAAM,EAAE,CAAC;IACtB,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,EAAE,CAAC;IACX,CAAC;AACF,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAClC,OAAmC;IAEnC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACpD,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAEnC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACtC,IAAI,CAAC,KAAK,CAAC,EAAE;QAAE,OAAO,IAAI,CAAC;IAE3B,iFAAiF;IACjF,6EAA6E;IAC7E,8EAA8E;IAC9E,8EAA8E;IAC9E,MAAM;IACN,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,EAAE,EAAE,CAAC;IAChE,OAAO;QACN,QAAQ;QACR,KAAK,EAAE;YACN,IAAI,EAAE,YAAY;YAClB,EAAE;YACF,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,EAAE;YAC1B,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;SACzC;KACD,CAAC;AACH,CAAC"}

package/dist/types.d.ts

@@ -1,48 +1,146 @@
-import type { Graph } from "@statelyai/graph";
-import type { BasePathOptions } from "./base-path.js";
+import type { BasePathOptions } from "@xmachines/play-url";
 import type { Signal } from "@xmachines/play-signals";
-import type { PlaySpec } from "@xmachines/play-actor";
 /**
- * The data on each node of the graph that represents the machine.
- * It holds the state metadata that the route extraction and the queries need.
+ * The type definitions of the routing protocol of @xmachines/play-router
+ *
+ * PlayRouteEvent, RouterBridge, RouteMetadata, and RouteObject are here. The routing
+ * therefore stays separate from the base event protocol of @xmachines/play.
  */
-export interface MachineNodeData {
-    /** The XState state ID, for example "test.dashboard.overview" */
-    stateId: string;
-    /** The state type of XState */
-    type: "atomic" | "compound" | "parallel" | "final" | "history";
-    /** The original meta object of the state */
-    meta?: Record<string, unknown>;
-    /** The route path of meta.route, in its string form */
-    route?: string;
-}
 /**
- * The data on each edge of the graph that represents the machine.
- * It holds the event of the transition and the information of its guard.
+ * The resolved extra data of a route. It reaches the consumer on the `data` field of a
+ * `play.route` event.
  */
-export interface MachineEdgeData {
-    /** The event type that starts this transition */
-    eventType: string;
-    /**
-     * The guard as a string, when a guard is present
-     *
-     * @deprecated Will be removed in the next major.
-     */
-    guardType?: string;
-}
+export type RouteData = Record<string, unknown>;
 /**
- * The type definitions of the routing protocol of @xmachines/play-router
+ * The function form of {@link RouteObject.data}.
  *
- * PlayRouteEvent, RouterBridge, RouteMetadata, and RouteObject are here. The routing
- * therefore stays separate from the base event protocol of @xmachines/play.
+ * The signature mirrors `WithDynamicParams` of XState: the resolver reads the context
+ * of the machine and the event that asks for the route, and it returns the data.
+ *
+ * The resolver reads every field of the event, and `event.data` among them: that field
+ * carries what the SENDER of the event supplied, and the resolver decides how it
+ * combines with what the state declares. The `data` that the resolver RETURNS goes to
+ * `context.data`, and it does not go back onto the event.
  */
+export type RouteDataResolver = (args: {
+    context: unknown;
+    event: PlayRouteEvent;
+}) => RouteData;
 /**
  * A route object, with more metadata.
  */
 export interface RouteObject {
-    /** The template of the route path, for example '/user/:id' */
+    /** The template of the route path, for example `"/user/:id"`. */
     path: string;
-    /** The additional metadata of the route: a title, a breadcrumb, and so on */
+    /**
+     * The `reenter` flag of the generated `play.route` transition.
+     *
+     * The default is `false`, which is also the default of XState.
+     *
+     * The flag spares the DOMAIN of the transition, and not every ancestor that stays
+     * active. Under the default placement `handler: "root"` the domain is the root of
+     * the machine, so `false` spares the root alone: each ancestor BETWEEN the root and
+     * the target still runs its `exit` and its `entry` actions, because XState re-enters
+     * every descendant of the domain that lies on the path to the target. A move between
+     * two siblings therefore still runs the `entry` action of their shared parent.
+     *
+     * {@link RouteObject.handler} is the field that spares those intermediate ancestors:
+     * `"local"` and `"both"` move the domain down to the parent of the state. Use the
+     * two fields together where an `entry` action must run one time for each state that
+     * the actor really enters.
+     *
+     * Set the field to `true` where the domain must run its `entry` actions again on
+     * every route to a descendant.
+     *
+     * The flag does not decide the destination. The value of the machine after a route
+     * is identical under both settings. A route to a state that has children still
+     * enters the `initial` child of that state, because the generated transition targets
+     * the state by its id, and XState enters the initial child of an id target under
+     * both settings.
+     *
+     * @see [Play RFC](../../docs/rfc/play.md)
+     */
+    reenter?: boolean;
+    /**
+     * Where the generated `play.route` transition sits.
+     *
+     * `"root"` is the default, and it is what XState does: `formatRouteTransitions`
+     * installs every route transition on the ROOT of the machine, and each one targets
+     * its state by the ID. A route from any state therefore reaches this state. The cost
+     * is that the root is the domain of the transition, so XState re-enters each
+     * ancestor on the path to the target, and those ancestors run their `entry` actions
+     * again although they stay active.
+     *
+     * `"local"` installs the transition on the PARENT of this state instead, and it
+     * targets this state relatively. XState offers the transitions of the deepest active
+     * state node first, so the parent answers the event itself and runs its `exit` and
+     * its `entry` actions NOT again.
+     *
+     * `"both"` installs one transition in each place. The local one answers while the
+     * parent is active, and the root one answers a route that arrives from outside the
+     * parent. Use `"both"` where an ancestor holds an `entry` action that must run one
+     * time for each real entry, such as an analytics event or an audit record.
+     *
+     * CAUTION: `"local"` makes this state reachable by a route ONLY while its parent is
+     * active. A `play.route` event that arrives from anywhere else matches no transition
+     * and the actor does not move. A browser URL for this state therefore leaves the URL
+     * and the actor divergent. Choose `"local"` to SCOPE a route on purpose, for example
+     * a step that a person reaches only inside its wizard. Choose `"both"` where the
+     * state must stay reachable from everywhere.
+     *
+     * The field has no effect on a state whose parent IS the root: the root transition
+     * of such a state is already local to its parent, so all three values agree.
+     */
+    handler?: "root" | "local" | "both";
+    /**
+     * The extra data that the state threads into its `play.route` event.
+     *
+     * The shape follows `WithDynamicParams` of XState, which is how XState itself
+     * parameterizes an action and a guard: the field holds a literal value, OR a
+     * function of `{ context, event }` that returns one.
+     *
+     * ```ts
+     * // The literal form. It survives a serialization of the machine.
+     * meta: { route: { path: "/doc/:docId", data: { titleKey: "doc.view" } } }
+     *
+     * // The function form, for a value that depends on the route.
+     * meta: {
+     *   route: {
+     *     path: "/doc/:docId",
+     *     data: ({ event }) => ({ title: `Document ${event.params?.docId}` }),
+     *   },
+     * }
+     * ```
+     *
+     * The generated transition resolves the value and assigns it to the `data` field of
+     * the context, beside `params` and `query`. The data of a state does NOT merge with
+     * the data of its ancestors: each state declares the whole value that its own route
+     * carries.
+     *
+     * This field and {@link PlayRouteEvent.data} are two different things, and they meet
+     * in the resolver. This field is what the STATE declares, in its machine.
+     * `PlayRouteEvent.data` is what the SENDER of the event supplies, such as a router
+     * bridge or the code of an application. A resolver reads `event.data` and returns
+     * whatever mix of the two the state needs.
+     *
+     * CAUTION: the function form holds a function inside `meta`, and a function does not
+     * survive `JSON.stringify`. A machine that Stately Studio reads, or that a process
+     * sends over a wire, must use the literal form.
+     */
+    data?: RouteData | RouteDataResolver;
+    /**
+     * The additional metadata of the route: a title, a breadcrumb, and so on.
+     *
+     * CAUTION: `path`, `handler`, `reenter` and `data` are RESERVED. The routing layer
+     * reads those four names, and a release before this one read `path` alone. A state
+     * that carries its own `handler` value now throws an `InvalidRouteHandlerError` from
+     * `formatPlayRouteTransitions`, so the machine builds never; a state that carries its
+     * own `data` value now writes that value to `context.data`, where the `/context`
+     * projection of every view reads it. A `reenter` value is read as the FLAG of the
+     * generated transition, and the literal `true` alone turns the reentry on: the
+     * default is `false`, and a release before this one generated every transition with
+     * `reenter: true`. Give such a field another name.
+     */
     [key: string]: unknown;
 }
 /**
@@ -112,7 +210,7 @@ export interface RouteNode {
  * - byStateId: it maps each state ID to its route node, for the target of a play.route event
  * - byPath: it maps each URL path to its route node, for the browser navigation
  */
-export interface RouteTree {
+export interface RouteTree<TGraph = unknown> {
     /** The root node of the routes */
     root: RouteNode;
     /**
@@ -127,17 +225,20 @@ export interface RouteTree {
     byPath: Map<string, RouteNode>;
     /**
      * The graph of the state machine, for an advanced query.
-     * extractMachineRoutes() fills it. Use it for a query of the hierarchy, for a test of
-     * the reachability, and for a navigation that knows the transitions, through the
-     * algorithms of @statelyai/graph.
+     *
+     * `TGraph` carries its type, and this package names none: a route tree is a map from a
+     * path to a state, and the graph of a MACHINE belongs to the package that reads a
+     * machine. `extractMachineRoutes` of `@xmachines/play-router/xstate` answers
+     * `RouteTree<MachineGraph>`, so a consumer of that function loses no type.
      *
      * @example
      * ```typescript
      * import { getSuccessors, hasPath } from "@statelyai/graph";
+     * // `tree` comes from `extractMachineRoutes` of `@xmachines/play-router/xstate`
      * const successors = getSuccessors(tree.graph!, "myMachine.home");
      * ```
      */
-    graph?: Graph<MachineNodeData, MachineEdgeData>;
+    graph?: TGraph;
 }
 /**
  * The routing event, with its parameters and its query
@@ -231,23 +332,43 @@ export interface PlayRouteEvent {
     readonly to: string;
     readonly params?: Record<string, string>;
     readonly query?: Record<string, string>;
+    /**
+     * The extra data that the SENDER of this event supplies: a router bridge, or the
+     * code of an application. It is not what the target state declares — that is
+     * {@link RouteObject.data}, and a resolver there reads this field.
+     */
+    readonly data?: RouteData;
     readonly match?: unknown;
-    [key: string]: unknown;
+}
+/**
+ * An optional capability: the routing support
+ */
+export interface Routable {
+    readonly currentRoute: Signal.Computed<string | null>;
+    readonly initialRoute: string | null;
 }
 /**
  * The minimal actor interface that `RouterBridgeBase` and every framework router
  * adapter require.
  *
- * This interface, and not `AbstractActor<AnyActorLogic> & Routable`, gives
- * `RouterBridgeBase.actor.send` the type that accepts a `PlayRouteEvent` directly.
- * It therefore removes the unsafe cast `(actor.send as (e: PlayRouteEvent) => void)`,
- * which the weaker `EventObject` constraint of the actor type needed before.
+ * It names `send` itself, and it therefore gives `RouterBridgeBase.actor.send` a type that
+ * accepts a `PlayRouteEvent` directly. That removes the unsafe cast
+ * `(actor.send as (e: PlayRouteEvent) => void)`.
+ *
+ * It is {@link Routable} with `send`. The two members of the capability are declared once,
+ * in `Routable`, and this interface extends it. A copy of them here drifts the day that
+ * one of the two files changes.
  *
- * Every `AbstractActor` subclass satisfies this interface structurally, for two
- * reasons:
- * - `AbstractActor` implements `send(event: TEvent): void`, and `TEvent` accepts each
- *   `EventObject`. Therefore it always accepts a `PlayRouteEvent`, which is a subtype.
- * - `Routable` gives `currentRoute` and `initialRoute`.
+ * **It names the view NOWHERE. Routing implies no rendering.** No file of this package,
+ * and no file of any of the eight router adapters, ever reads `currentView`. A provider
+ * whose renderer callback reads the view binds its own `TActor`, and a constraint keeps
+ * the concrete type of the actor whole, so that callback still reads the exact spec of
+ * that actor.
+ *
+ * Every `PlayActor` of `@xmachines/play-actor` that also implements `Routable`, and whose
+ * event union holds `PlayRouteEvent`, satisfies this interface structurally. A machine
+ * that declares no route event does NOT satisfy it, and that refusal is correct: a bridge
+ * cannot navigate an actor that receives no route event.
  *
  * @example
  * ```typescript
@@ -260,49 +381,10 @@ export interface PlayRouteEvent {
  * }
  * ```
  */
-export interface RoutableActor {
-    /** The TC39 Signal of the current URL path of the actor, or of its state ID. */
-    readonly currentRoute: Signal.Computed<string | null>;
-    /**
-     * The route of the initial state of the machine. The constructor fixes it.
-     * A router bridge compares it with the browser URL. It therefore separates a deep
-     * link, where the router wins, from a restore of a session, where the actor wins.
-     */
-    readonly initialRoute: string | null;
+export interface RoutableActor extends Routable {
     /** Sends a route navigation event to the actor. */
     send(event: PlayRouteEvent): void;
 }
-/**
- * The complete actor shape of the `PlayRouterProvider` component of each framework
- * adapter: `play-solid-router`, `play-vue-router`, `play-react-router`, and each
- * adapter on the shared framework router bridge bases.
- *
- * The shape extends `RoutableActor` with `currentView`, because the provider renders
- * the current view spec and also keeps the routes in step. It therefore needs both
- * capabilities.
- *
- * - Use `RoutableActor` when you need the routing alone, for example in a
- *   `RouterBridgeBase` subclass, or in `connectRouter`.
- * - Use `PlayActor` when the component also renders the current view spec, for
- *   example for the renderer callback parameter of `PlayRouterProvider`, and in
- *   `PlayRenderer`.
- *
- * Every `AbstractActor` subclass that implements both `Routable` and `Viewable`
- * satisfies this interface structurally.
- *
- * @example
- * ```typescript
- * import type { PlayActor } from "@xmachines/play-router";
- *
- * function MyRouterProvider({ actor }: { actor: PlayActor }) {
- *   // it reads actor.currentRoute for the routing, and actor.currentView for the render
- * }
- * ```
- */
-export interface PlayActor extends RoutableActor {
-    /** The TC39 Signal of the current view spec of the actor, or `null` when no view is active. */
-    readonly currentView: Signal.State<PlaySpec | null>;
-}
 /**
  * The RouterBridge interface of a runtime infrastructure adapter
  *
@@ -462,4 +544,21 @@ export interface LocationLike {
     readonly pathname: string;
     readonly search: string;
 }
+/**
+ * The options of `createRouteMap` and of `createRouteMapFromTree`.
+ */
+export interface RouteMapOptions {
+    /**
+     * The maximum number of the resolved parameterized path lookups in the cache.
+     *
+     * `RouteMap.getStateIdByPath()` resolves a parameterized pattern, for example
+     * `/profile/:userId`, with URLPattern on each call. The map keeps each path of a
+     * frequent visit in an LRU cache, and a later lookup of that path is therefore
+     * O(1).
+     *
+     * Raise this value for an application with a large set of parameterized routes, or
+     * with a high frequency of the navigation. The default is `500`.
+     */
+    cacheSize?: number;
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC;IAChB,+BAA+B;IAC/B,IAAI,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,GAAG,OAAO,GAAG,SAAS,CAAC;IAC/D,4CAA4C;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,6EAA6E;IAC7E,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,WAAW,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB,oDAAoD;IACpD,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,4GAA4G;IAC5G,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oFAAoF;IACpF,UAAU,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB,kCAAkC;IAClC,QAAQ,EAAE,aAAa,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB,mDAAmD;IACnD,EAAE,EAAE,MAAM,CAAC;IACX;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,uGAAuG;IACvG,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wCAAwC;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB,uBAAuB;IACvB,QAAQ,EAAE,SAAS,EAAE,CAAC;IACtB,gDAAgD;IAChD,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IACzB,uCAAuC;IACvC,QAAQ,EAAE,aAAa,CAAC;CACxB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAS;IACzB,kCAAkC;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB;;;OAGG;IACH,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAClC;;;OAGG;IACH,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC/B;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;CAChD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsFG;AACH,MAAM,WAAW,cAAc;IAC9B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,aAAa;IAC7B,gFAAgF;IAChF,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACtD;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,mDAAmD;IACnD,IAAI,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI,CAAC;CAClC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,SAAU,SAAQ,aAAa;IAC/C,+FAA+F;IAC/F,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;CACpD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,WAAW,YAAY;IAC5B;;;;;;;;;;;;;;;OAeG;IACH,OAAO,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhC;;;;;;;;;;;;;OAaG;IACH,UAAU,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IAC1D,+FAA+F;IAC/F,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;;;;;;;OAQG;IACH,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1D;;;;;;OAMG;IACH,WAAW,CACV,QAAQ,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,EACtC,cAAc,CAAC,EAAE,eAAe,CAAC,gBAAgB,CAAC,GAChD,IAAI,CAAC;CACR;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,UAAU;IAC1B,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,CAAC;IACvE,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,CAAC;CAC1E;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACxB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAEtD;;;;;GAKG;AAEH;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEhD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,cAAc,CAAA;CAAE,KAAK,SAAS,CAAC;AAEjG;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,iBAAiB,CAAC;IACrC;;;;;;;;;;;;OAYG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,WAAW,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB,oDAAoD;IACpD,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,4GAA4G;IAC5G,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oFAAoF;IACpF,UAAU,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB,kCAAkC;IAClC,QAAQ,EAAE,aAAa,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB,mDAAmD;IACnD,EAAE,EAAE,MAAM,CAAC;IACX;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,uGAAuG;IACvG,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wCAAwC;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB,uBAAuB;IACvB,QAAQ,EAAE,SAAS,EAAE,CAAC;IACtB,gDAAgD;IAChD,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IACzB,uCAAuC;IACvC,QAAQ,EAAE,aAAa,CAAC;CACxB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAS,CAAC,MAAM,GAAG,OAAO;IAC1C,kCAAkC;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB;;;OAGG;IACH,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAClC;;;OAGG;IACH,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC/B;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsFG;AACH,MAAM,WAAW,cAAc;IAC9B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACxB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACtD,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CACrC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC9C,mDAAmD;IACnD,IAAI,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI,CAAC;CAClC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,WAAW,YAAY;IAC5B;;;;;;;;;;;;;;;OAeG;IACH,OAAO,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhC;;;;;;;;;;;;;OAaG;IACH,UAAU,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IAC1D,+FAA+F;IAC/F,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;;;;;;;OAQG;IACH,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1D;;;;;;OAMG;IACH,WAAW,CACV,QAAQ,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,EACtC,cAAc,CAAC,EAAE,eAAe,CAAC,gBAAgB,CAAC,GAChD,IAAI,CAAC;CACR;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,UAAU;IAC1B,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,CAAC;IACvE,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,CAAC;CAC1E;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B;;;;;;;;;;OAUG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/{create-route-map.d.ts → xstate/create-route-map.d.ts}

@@ -1,27 +1,13 @@
 import type { AnyStateMachine } from "xstate";
-import { RouteMap } from "./base-route-map.js";
-/**
- * The options of `createRouteMap` and of `createRouteMapFromTree`.
- */
-export interface RouteMapOptions {
-    /**
-     * The maximum number of the resolved parameterized path lookups in the cache.
-     *
-     * `RouteMap.getStateIdByPath()` resolves a parameterized pattern, for example
-     * `/profile/:userId`, with URLPattern on each call. The map keeps each path of a
-     * frequent visit in an LRU cache, and a later lookup of that path is therefore
-     * O(1).
-     *
-     * Raise this value for an application with a large set of parameterized routes, or
-     * with a high frequency of the navigation. The default is `500`.
-     */
-    cacheSize?: number;
-}
+import { RouteMap } from "../base-route-map.js";
+import type { RouteMapOptions } from "../types.js";
 /**
  * Creates a `RouteMap` from an XState state machine.
  *
  * The function reads every state with a route, which means each state with a
- * `meta.route` field. It then builds the lookup structure between a path and a
+ * `meta.route` field. It keeps the routable states alone, and it drops the synthetic
+ * root of the tree. `createRouteMapFromTree` of the main entry point drops the same
+ * node, and the two functions therefore answer the same map for the same machine. It then builds the lookup structure between a path and a
  * stateId, for both directions. A subclass of `RouterBridgeBase` uses the map: it
  * converts each change of the browser URL into a `play.route` actor event, and each
  * actor route into a URL.
@@ -33,7 +19,7 @@ export interface RouteMapOptions {
  *
  * @example
  * ```typescript
- * import { createRouteMap } from '@xmachines/play-router';
+ * import { createRouteMap } from '@xmachines/play-router/xstate';
  * import { connectRouter } from '@xmachines/play-dom-router';
  *
  * const routeMap = createRouteMap(myMachine);

package/dist/xstate/create-route-map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-route-map.d.ts","sourceRoot":"","sources":["../../src/xstate/create-route-map.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAG9C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,QAAQ,CAU5F"}

package/dist/{create-route-map.js → xstate/create-route-map.js}

@@ -1,11 +1,13 @@
 import { extractMachineRoutes } from "./extract-routes.js";
 import { getRoutableRoutes } from "./query.js";
-import { RouteMap } from "./base-route-map.js";
+import { RouteMap } from "../base-route-map.js";
 /**
  * Creates a `RouteMap` from an XState state machine.
  *
  * The function reads every state with a route, which means each state with a
- * `meta.route` field. It then builds the lookup structure between a path and a
+ * `meta.route` field. It keeps the routable states alone, and it drops the synthetic
+ * root of the tree. `createRouteMapFromTree` of the main entry point drops the same
+ * node, and the two functions therefore answer the same map for the same machine. It then builds the lookup structure between a path and a
  * stateId, for both directions. A subclass of `RouterBridgeBase` uses the map: it
  * converts each change of the browser URL into a `play.route` actor event, and each
  * actor route into a URL.
@@ -17,7 +19,7 @@ import { RouteMap } from "./base-route-map.js";
  *
  * @example
  * ```typescript
- * import { createRouteMap } from '@xmachines/play-router';
+ * import { createRouteMap } from '@xmachines/play-router/xstate';
  * import { connectRouter } from '@xmachines/play-dom-router';
  *
  * const routeMap = createRouteMap(myMachine);

package/dist/xstate/create-route-map.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-route-map.js","sourceRoot":"","sources":["../../src/xstate/create-route-map.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAGhD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,cAAc,CAAC,OAAwB,EAAE,OAAyB;IACjF,MAAM,SAAS,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC5C,OAAO,IAAI,QAAQ,CAClB,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACrB,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,IAAI,EAAE,IAAI,CAAC,QAAQ;KACnB,CAAC,CAAC,EACH,OAAO,CACP,CAAC;AACH,CAAC"}

package/dist/{extract-routes.d.ts → xstate/extract-routes.d.ts}

@@ -1,5 +1,6 @@
 import type { AnyStateMachine } from "xstate";
-import type { RouteTree } from "./types.js";
+import type { RouteTree } from "../types.js";
+import { type MachineGraph } from "./machine-to-graph.js";
 /**
  * Reads the complete route tree from the graph of a state machine
  *
@@ -12,5 +13,5 @@ import type { RouteTree } from "./types.js";
  * @param machine - The XState v5 state machine
  * @returns The route tree, with its root, its byStateId map, its byPath map, and its graph
  */
-export declare const extractMachineRoutes: (machine: AnyStateMachine) => RouteTree;
+export declare const extractMachineRoutes: (machine: AnyStateMachine) => RouteTree<MachineGraph>;
 //# sourceMappingURL=extract-routes.d.ts.map

package/dist/xstate/extract-routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-routes.d.ts","sourceRoot":"","sources":["../../src/xstate/extract-routes.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,KAAK,EAAE,SAAS,EAA4B,MAAM,aAAa,CAAC;AAEvE,OAAO,EAAkB,KAAK,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAgF1E;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,oBAAoB,GAAI,SAAS,eAAe,KAAG,SAAS,CAAC,YAAY,CAoBrF,CAAC"}

package/dist/{extract-routes.js → xstate/extract-routes.js}

@@ -1,6 +1,7 @@
+import { isParameterizedPattern } from "@xmachines/play-url";
 import { machineToGraph } from "./machine-to-graph.js";
-import { validateRouteFormat, validateStateExists } from "./validate-routes.js";
-import { buildRouteTree } from "./build-tree.js";
+import { validateRouteFormat, validateStateExists } from "../validate-routes.js";
+import { buildRouteTree } from "../build-tree.js";
 /**
  * Builds the statePath of a graph node, and it walks the chain of the parentId
  * values.
@@ -37,7 +38,11 @@ const extractRouteFromNode = (graphNode, stateIds, graphNodeMap) => {
     validateStateExists(stateId, stateIds);
     // Build the statePath from the chain of the parentId values. This works for an explicit ID and also for a generated one
     const statePath = buildStatePath(graphNode, graphNodeMap);
-    const pattern = route.includes(":") ? route : undefined;
+    // The parse answers this, and not a search for a ":". `route.includes(":")` was the
+    // last expression that read the grammar on its own: it reported no pattern for
+    // `/docs/*`, for `/books{/:id}?` and for an escaped literal, so a consumer that reads
+    // `node.pattern` learned that a parameterized route is a literal path.
+    const pattern = isParameterizedPattern(route) ? route : undefined;
     // Build the original shape of the metadata again, from the data of the graph
     const metadata = meta && typeof meta === "object" && "route" in meta
         ? meta["route"]

package/dist/xstate/extract-routes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-routes.js","sourceRoot":"","sources":["../../src/xstate/extract-routes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAK7D,OAAO,EAAE,cAAc,EAAqB,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;;;;;;;;;GAWG;AACH,MAAM,cAAc,GAAG,CACtB,SAAqC,EACrC,YAAqD,EAC1C,EAAE;IACb,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,IAAI,OAAO,GAA2C,SAAS,CAAC;IAEhE,OAAO,OAAO,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;QAC/E,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnC,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,oBAAoB,GAAG,CAC5B,SAAqC,EACrC,QAAqB,EACrB,YAAqD,EAClC,EAAE;IACrB,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC;IAEhD,wBAAwB;IACxB,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IAExB,+CAA+C;IAC/C,mBAAmB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAEpC,mGAAmG;IACnG,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAEvC,wHAAwH;IACxH,MAAM,SAAS,GAAG,cAAc,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAE1D,oFAAoF;IACpF,+EAA+E;IAC/E,sFAAsF;IACtF,uEAAuE;IACvE,MAAM,OAAO,GAAG,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IAElE,6EAA6E;IAC7E,MAAM,QAAQ,GACb,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,IAAI;QAClD,CAAC,CAAE,IAAI,CAAC,OAAO,CAAmB;QAClC,CAAC,CAAC,KAAK,CAAC;IAEV,MAAM,MAAM,GAAc;QACzB,OAAO;QACP,SAAS;QACT,SAAS,EAAE,KAAK;QAChB,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;QACjC,QAAQ,EAAE,IAAI;QACd,QAAQ;KACR,CAAC;IAEF,IAAI,OAAO;QAAE,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;IAEtC,OAAO,MAAM,CAAC;AACf,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,OAAwB,EAA2B,EAAE;IACzF,sCAAsC;IACtC,MAAM,KAAK,GAAiB,cAAc,CAAC,OAAO,CAAC,CAAC;IAEpD,kGAAkG;IAClG,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACjE,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhE,wCAAwC;IACxC,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK;SACxB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,oBAAoB,CAAC,IAAI,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;SACjE,MAAM,CAAC,CAAC,CAAC,EAAkB,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;IAE5C,wDAAwD;IACxD,mFAAmF;IACnF,4EAA4E;IAC5E,2EAA2E;IAC3E,UAAU;IACV,MAAM,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IACpC,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,CAAC;AAC3B,CAAC,CAAC"}