@xmachines/play-router 3.0.0 → 5.0.0

package/README.md

@@ -2,51 +2,40 @@
 
 Route tree extraction from XState v5 state machines. Part of [@xmachines/play](../play/README.md) Universal Player Architecture.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-3.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-router)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-5.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-router)
 
 This package extracts the routes from a machine graph and looks them up in both directions. The Actor therefore keeps the authority over the navigation.
 
 > **Browser floor: Chrome 110, Firefox 115, Safari 16.4.** This package calls the ES2023
 > change-by-copy array methods, so a browser below that floor throws
-> `TypeError: ... is not a function` at the extraction of the routes. Vite 8 resolves its
-> default `baseline-widely-available` target to Firefox 114, which is below it — raise
-> `build.target` when you bundle for the browser. The root README carries the table.
->
-> A **parameterized route** raises Firefox to **117**, which is the version that has the
-> URLPattern API. Load the `urlpattern-polyfill` for an older target, as the Installation
-> section below says.
+> `TypeError: ... is not a function` at the extraction of the routes. The root README
+> carries the table.
 
 ## Installation
 
 ```bash
-pnpm add xstate@^5.31.0
-pnpm add @xmachines/play-router
+pnpm add @xmachines/play-router @xmachines/play @xmachines/play-atom
 ```
 
-**Peer dependencies:**
-
-- `xstate` ^5.31.0 — XState v5 state machine runtime
+**Peer dependencies.** Install them with the package:
 
-**URLPattern polyfill (Node.js < 24 / older browsers):**
+- [`@xmachines/play`](../play/README.md) — the core protocol. This package reads `asCleanup` and `DISPOSE` from it, and the error classes from its `errors` subpath.
+- [`@xmachines/play-atom`](../play-atom/README.md) — the atom primitives. The bridge reads the route of the actor with `watchAtom`.
 
-`@xmachines/play-router` matches each dynamic route with the [URLPattern API](https://developer.mozilla.org/en-US/docs/Web/API/URLPattern). URLPattern is native in Node.js 24+ and in a modern browser (Chrome 95+, Firefox 117+, Safari 16.4+).
+**Optional peers.** The `@xmachines/play-router/xstate` subpath alone reads them. Install them when you read that subpath, and not before:
 
-In an environment without the native API, load a polyfill **before** you import this package:
-
-```typescript
-// Entry point — must run before any @xmachines/play-router import
-import "urlpattern-polyfill";
+```bash
+pnpm add xstate@^5.33.0 @statelyai/graph@^2.4.0
 ```
 
-Install the polyfill:
+- `xstate` ^5.33.0 — the XState v5 runtime.
+- `@statelyai/graph` ^2.4.0 — the graph of the machine that `extractMachineRoutes` walks.
 
-```bash
-pnpm add urlpattern-polyfill
-```
+A consumer of the root barrel installs neither one. `@statelyai/graph` was an ordinary dependency until this release, so every consumer of the root carried it; it now follows the same rule as `xstate`, which the same files read.
 
-`urlpattern-polyfill` is an optional peer dependency. A package manager does not install it for you. Install it and load it yourself when your runtime has no native URLPattern.
+**URLPattern:** this package matches each route with the [URLPattern API](https://developer.mozilla.org/en-US/docs/Web/API/URLPattern). It uses the native API when the runtime has one, and it falls back to `urlpattern-polyfill`, which [`@xmachines/play-url`](../play-url/README.md) carries as an ordinary dependency. **You install nothing and you load nothing.**
 
-**When you need it:** `RouteMap` compiles each parameterized route in its CONSTRUCTOR, and it throws a `URLPatternUnavailableError` there when no URLPattern is available. One route that holds a `:param` or a `*` therefore makes the polyfill a startup requirement on such a runtime. A route map whose paths are all static needs URLPattern never.
+The [routing guide](../docs/guides/routing.md) states the pattern language: the forms, the modifiers, the prefix rule, and the one divergence from the standard.
 
 ## Usage
 
@@ -54,7 +43,7 @@ pnpm add urlpattern-polyfill
 
 ```typescript
 import { createMachine } from "xstate";
-import { extractMachineRoutes, createRouteMap } from "@xmachines/play-router";
+import { extractMachineRoutes, createRouteMap } from "@xmachines/play-router/xstate";
 
 const machine = createMachine({
 	id: "app",
@@ -302,7 +291,7 @@ To register the routes of the machine in a host router that declares real route
 objects, ask for the list — and drop it again when the machine unloads:
 
 ```typescript
-import { extractMachineRoutes, getRouteMappings } from "@xmachines/play-router";
+import { extractMachineRoutes, getRouteMappings } from "@xmachines/play-router/xstate";
 
 const tree = extractMachineRoutes(machine);
 
@@ -320,30 +309,30 @@ Each `stateId` comes from the route tree, so it carries NO `#`. A host that keys
 route table on the target of a `play.route` event adds the `#` itself, because the
 event always carries the prefixed form.
 
-> Under a mount, `@xmachines/play-vue-router` and `@xmachines/play-solid-router` read
+> Under a mount, [`@xmachines/play-vue-router`](../play-vue-router/README.md) and [`@xmachines/play-solid-router`](../play-solid-router/README.md) read
 > the pre-parsed route params of their framework never: under a prefix the framework
 > matched a route of the HOST by construction, because the machine owns the suffix of
 > the path only. Those params therefore describe the route of the machine never, even
 > when a name collides — a collision carries the value of the HOST. Both adapters
-> resolve each param from the stripped path with `URLPattern` instead, and they
-> therefore need a polyfill on an older runtime when they are mounted.
+> resolve each param from the stripped path with `URLPattern` instead.
 >
-> Without a prefix both adapters keep the parse of their framework, with its decoding
-> and with no polyfill, but restricted to the names that the pattern of the machine
-> declares. A splat of a catch-all, and a param of a wrapper route, reach the actor
-> never.
+> Without a prefix both adapters keep the parse of their framework, with its decoding,
+> but restricted to the names that the pattern of the machine declares. A splat of a
+> catch-all, and a param of a wrapper route, reach the actor never. A name that the
+> pattern makes OPTIONAL is covered whether the framework reports it or not: a part that
+> did not match has no value, and that is a complete answer.
 >
-> A location that fills NO optional segment reaches URLPattern never. `/settings` is the
-> bare form of `/settings/:section?`, so the params are `{}`, and the adapters read that
-> from the path alone rather than from their framework. The route map that HOLDS that
-> pattern still needed URLPattern when it was built.
+> A location that fills NO optional part runs no match at all. `/settings` is the bare
+> form of `/settings/:section?`, so the params are `{}`, and the adapters read that from
+> the path alone rather than from their framework.
 
 ### How to write a `RouterBridgeBase` adapter
 
 Extend `RouterBridgeBase`, then implement the three abstract methods for your framework:
 
 ```typescript
-import { RouterBridgeBase, createRouteMap } from "@xmachines/play-router";
+import { RouterBridgeBase } from "@xmachines/play-router";
+import { createRouteMap } from "@xmachines/play-router/xstate";
 import type { RoutableActor } from "@xmachines/play-router";
 
 // Shape of your framework's router — adjust to its real API
@@ -401,13 +390,14 @@ bridge.disconnect();
 
 ### Route Extraction
 
-| Export                                   | Description                                                                       |
-| ---------------------------------------- | --------------------------------------------------------------------------------- |
-| `extractMachineRoutes(machine)`          | Converts an XState machine into a `RouteTree` with the state ID ↔ path maps       |
-| `createRouteMap(machine, options?)`      | Builds a `RouteMap` directly from a machine. An adapter uses this form            |
-| `createRouteMapFromTree(tree, options?)` | Builds a `RouteMap` from a `RouteTree` that you extracted before                  |
-| `buildRouteTree(routes)`                 | Builds a `RouteTree` from an array of `RouteInfo` objects                         |
-| `machineToGraph(machine)`                | Converts a machine into a typed `@statelyai/graph` `Graph`, for a graph algorithm |
+| Export                                   | Description                                                             |
+| ---------------------------------------- | ----------------------------------------------------------------------- |
+| `buildRouteTree(routes)`                 | Builds a `RouteTree` from an array of `RouteInfo` objects               |
+| `createRouteMapFromTree(tree, options?)` | Builds a `RouteMap` from a `RouteTree` that you extracted before        |
+| `ROOT_NODE_ID`                           | The ID of the synthetic root node. A walk of a tree must skip that node |
+
+The MAIN entry point reads no state machine. The machine half is
+`@xmachines/play-router/xstate`, below.
 
 ### Route Matching
 
@@ -417,16 +407,32 @@ bridge.disconnect();
 | `findRouteById(tree, id)`     | Finds a `RouteNode` by its state ID                                                                           |
 | `findRouteByPath(tree, path)` | Finds a `RouteNode` by its URL path. It also matches a dynamic pattern                                        |
 
-### Query Utilities
+### The machine half — subpath `@xmachines/play-router/xstate`
+
+A route of XMachines is a fact about a STATE. This entry point reads that fact out of an
+XState v5 machine. The main entry point reads it never, so `xstate` and `@statelyai/graph`
+are OPTIONAL peer dependencies of this package: a consumer that imports this entry point
+nowhere installs neither one.
+
+```typescript
+import { createRouteMap, extractMachineRoutes } from "@xmachines/play-router/xstate";
+```
 
 | Export                                            | Description                                                                                     |
 | ------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
+| `extractMachineRoutes(machine)`                   | Converts an XState machine into a `RouteTree` with the state ID ↔ path maps                     |
+| `createRouteMap(machine, options?)`               | Builds a `RouteMap` directly from a machine. An adapter uses this form                          |
+| `machineToGraph(machine)`                         | Converts a machine into a typed `@statelyai/graph` `Graph`, for a graph algorithm               |
 | `getRoutableRoutes(tree)`                         | Returns every routable `RouteNode` in one flat array                                            |
 | `getNavigableRoutes(tree, stateId)`               | Returns the child routes that a state can reach, through the hierarchy and through a transition |
 | `routeExists(tree, path)`                         | Tells you if the tree holds a path                                                              |
 | `getRouteMappings(tree, options?)`                | The `{ stateId, path }` entries for a route table of a host, with an optional prefix            |
 | `getTransitionReachableRoutes(graph, stateId)`    | Returns the route paths that a state can reach through an XState transition                     |
 | `isRouteReachable(graph, fromStateId, toStateId)` | Tells you if a transition path is present between two states                                    |
+| `MachineGraph`                                    | The typed `@statelyai/graph` Graph, with `MachineNodeData` and `MachineEdgeData`                |
+
+No framework router adapter re-exports `createRouteMap`. Each one names no state machine,
+so a consumer of an adapter imports the function from `@xmachines/play-router/xstate`.
 
 ### Router Bridge
 
@@ -461,8 +467,8 @@ it safe is the same in both, so it lives here.
 | Export                                         | Description                                                                                                                                                                                                                    |
 | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `resolveFrameworkParams(source)`               | Decides which params describe the route of the machine: `{}`, the parse of the framework, or the fallback                                                                                                                      |
-| `getPatternParamNames(pattern)`                | The names of every `:param` of a route pattern. A `*` wildcard carries none                                                                                                                                                    |
-| `getRequiredPatternParamNames(pattern)`        | The names the pattern REQUIRES, so an optional `:name?` is left out                                                                                                                                                            |
+| `parsePattern(pattern).names`                  | The names of every `:param` of a route pattern. An anonymous param carries none                                                                                                                                                |
+| `parsePattern(pattern).requiredNames`          | The names the pattern REQUIRES, so an optional `:name?` is left out                                                                                                                                                            |
 | `pickOwnParams(params, names, requiredNames?)` | The params that the pattern declares, or `null` when the framework covers them not. `requiredNames` says which names may NOT be absent; it defaults to every name, so a two-argument call treats an optional `:name?` as a gap |
 | `cleanFrameworkParams(params)`                 | The params of a framework with no absent value, each one a string                                                                                                                                                              |
 
@@ -498,43 +504,40 @@ props that a framework decides, which is why it is a type parameter.
 
 ### Key Types
 
-| Export                             | Description                                                                                                                        |
-| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
-| `RouterBridge`                     | The interface of the `connect()` and `disconnect()` lifecycle                                                                      |
-| `MountableRouterBridge`            | A `RouterBridge` whose mount can move — it adds `basePath` and `setBasePath()`                                                     |
-| `RouteTree`                        | The hierarchical tree, with `root`, `byStateId`, `byPath`, and an optional `graph`                                                 |
-| `RouteNode`                        | One node of the tree, with `id`, `path`, `fullPath`, `stateId`, `children`, and `parent`                                           |
-| `RouteInfo`                        | The flat route descriptor that comes from a state node                                                                             |
-| `PlayRouteEvent`                   | Routing event `{ type: "play.route", to, params?, query? }`                                                                        |
-| `RoutableActor`                    | The minimal actor interface that `RouterBridgeBase` requires: `currentRoute`, `initialRoute`, and `send(PlayRouteEvent)`           |
-| `PlayActor`                        | The complete actor interface that `PlayRouterProvider` uses. It extends `RoutableActor` with `currentView` (`Routable + Viewable`) |
-| `RouteMapping`                     | The `{ stateId, path }` pair that builds a `RouteMap`                                                                              |
-| `RouteMapping as BaseRouteMapping` | The alias of `RouteMapping`, for compatibility with an earlier version                                                             |
-| `MachineGraph`                     | The typed `@statelyai/graph` Graph, with `MachineNodeData` and `MachineEdgeData`                                                   |
-| `WindowLike`                       | The minimal `window` interface that you can inject for SSR and for a test                                                          |
-| `LocationLike`                     | The minimal `location` interface that you can inject for SSR and for a test                                                        |
+| Export                  | Description                                                                                                                              |
+| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| `RouterBridge`          | The interface of the `connect()` and `disconnect()` lifecycle                                                                            |
+| `MountableRouterBridge` | A `RouterBridge` whose mount can move — it adds `basePath` and `setBasePath()`                                                           |
+| `RouteTree`             | The hierarchical tree, with `root`, `byStateId`, `byPath`, and an optional `graph`                                                       |
+| `RouteNode`             | One node of the tree, with `id`, `path`, `fullPath`, `stateId`, `children`, and `parent`                                                 |
+| `RouteInfo`             | The flat route descriptor that comes from a state node                                                                                   |
+| `PlayRouteEvent`        | Routing event `{ type: "play.route", to, params?, query?, data? }`                                                                       |
+| `Routable`              | The optional routing capability of an actor: `currentRoute` and `initialRoute`                                                           |
+| `RoutableActor`         | The actor interface that `RouterBridgeBase` and `PlayRouterProvider` require: `currentRoute`, `initialRoute`, and `send(PlayRouteEvent)` |
+| `RouteMapping`          | The `{ stateId, path }` pair that builds a `RouteMap`                                                                                    |
+| `RouteObject`           | The object form of `meta.route`: `path`, and the `handler`, `reenter` and `data` fields                                                  |
+| `RouteMetadata`         | The union of the two forms of `meta.route`: the path string, or a `RouteObject`                                                          |
+| `RouteData`             | The resolved extra data of a route, which reaches the machine as `context.data`                                                          |
+| `RouteDataResolver`     | The function form of `RouteObject.data`: `({ context, event }) => RouteData`                                                             |
+| `WindowLike`            | The minimal `window` interface that you can inject for SSR and for a test                                                                |
+| `LocationLike`          | The minimal `location` interface that you can inject for SSR and for a test                                                              |
 
 ### Errors (subpath `@xmachines/play-router/errors`)
 
-| Class                        | Code                                    | When thrown                                                                                                     |
-| ---------------------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
-| `RouterSyncError`            | `PLAY_ROUTER_SYNC_FAILED`               | `syncActorFromRouter()` cannot send a `play.route` event                                                        |
-| `DuplicateBridgeError`       | `PLAY_ROUTER_DUPLICATE_BRIDGE`          | A second bridge tries to connect to an actor that already has one                                               |
-| `URLPatternUnavailableError` | `PLAY_ROUTE_MAP_URLPATTERN_UNAVAILABLE` | The URLPattern API is absent, and no polyfill is loaded                                                         |
-| `InvalidRoutePatternError`   | `PLAY_ROUTE_MAP_INVALID_PATTERN`        | A route pattern does not compile, or two of its params land on one URLPattern group                             |
-| `EmptyRoutePathError`        | `PLAY_ROUTE_EMPTY_PATH`                 | A state declares `meta.route: ""`                                                                               |
-| `InvalidStateIdError`        | `PLAY_ROUTE_INVALID_STATE_ID`           | A route names a state ID that the machine graph does not hold                                                   |
-| `DuplicateRoutePathError`    | `PLAY_ROUTE_DUPLICATE_PATH`             | Two or more states share the same URL path                                                                      |
-| `UnknownStateTypeError`      | `PLAY_ROUTE_UNKNOWN_STATE_TYPE`         | A state node has an XState `.type` value that the package does not know                                         |
-| `InvalidBasePathError`       | `PLAY_ROUTER_INVALID_BASE_PATH`         | A `basePath` resolves to one concrete prefix never (`*`, `:p?`, `$p`, `?`, `#`, a scheme, `.`/`..`, whitespace) |
-| `MissingBasePathParamError`  | `PLAY_ROUTER_MISSING_BASE_PATH_PARAM`   | A `:param` of a `basePath` has no value in `basePathParams`                                                     |
+| Class                       | Code                                  | When thrown                                                                                                     |
+| --------------------------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
+| `RouterSyncError`           | `PLAY_ROUTER_SYNC_FAILED`             | `syncActorFromRouter()` cannot send a `play.route` event                                                        |
+| `DuplicateBridgeError`      | `PLAY_ROUTER_DUPLICATE_BRIDGE`        | A second bridge tries to connect to an actor that already has one                                               |
+| `InvalidRoutePatternError`  | `PLAY_ROUTE_MAP_INVALID_PATTERN`      | A route pattern does not compile, or two of its params land on one URLPattern group                             |
+| `EmptyRoutePathError`       | `PLAY_ROUTE_EMPTY_PATH`               | A state declares `meta.route: ""`                                                                               |
+| `InvalidStateIdError`       | `PLAY_ROUTE_INVALID_STATE_ID`         | A route names a state ID that the machine graph does not hold                                                   |
+| `DuplicateRoutePathError`   | `PLAY_ROUTE_DUPLICATE_PATH`           | Two or more states share the same URL path                                                                      |
+| `UnknownStateTypeError`     | `PLAY_ROUTE_UNKNOWN_STATE_TYPE`       | A state node has an XState `.type` value that the package does not know                                         |
+| `InvalidBasePathError`      | `PLAY_ROUTER_INVALID_BASE_PATH`       | A `basePath` resolves to one concrete prefix never (`*`, `:p?`, `$p`, `?`, `#`, a scheme, `.`/`..`, whitespace) |
+| `MissingBasePathParamError` | `PLAY_ROUTER_MISSING_BASE_PATH_PARAM` | A `:param` of a `basePath` has no value in `basePathParams`                                                     |
 
 ```typescript
-import {
-	RouterSyncError,
-	DuplicateBridgeError,
-	URLPatternUnavailableError,
-} from "@xmachines/play-router/errors";
+import { RouterSyncError, DuplicateBridgeError } from "@xmachines/play-router/errors";
 
 // bridge from the adapter example above
 try {
@@ -575,6 +578,28 @@ states: {
 }
 ```
 
+### The object form
+
+The object form carries the path and any metadata of your own, such as a title or a
+breadcrumb. It also carries three fields that the routing layer reads:
+
+| Field     | Default  | What it does                                                                    |
+| --------- | -------- | ------------------------------------------------------------------------------- |
+| `path`    | required | The template of the route path                                                  |
+| `handler` | `"root"` | Where the generated `play.route` transition sits: `"root"`, `"local"`, `"both"` |
+| `reenter` | `false`  | Whether the transition re-enters its own domain. See the note below.            |
+| `data`    | none     | The extra data of the route: a literal value, or a function of the event        |
+
+[`@xmachines/play-xstate`](../play-xstate/README.md) reads `handler`, `reenter`, and `data` when it generates the
+transitions. See the README of that package for what each value does.
+
+**The four names are RESERVED, and this is a change of behaviour.** An earlier release
+read `path` alone, so a state could put any name of its own beside it. A state that
+carries its own `handler` value now throws an `InvalidRouteHandlerError` at the format
+time, and 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.
+Give such a field another name.
+
 ### Relative vs absolute paths
 
 A child route that starts with `/` is absolute, and it does not inherit the path of its parent. A child route without the first `/` is relative to its nearest routable ancestor:
@@ -600,47 +625,17 @@ states: {
 
 Always use `node.fullPath` to match a browser URL and to build a route map. Never use `node.path` for this.
 
-## Testing
-
-```bash
-# Run tests for this package
-pnpm --filter @xmachines/play-router test
-
-# Watch mode
-pnpm --filter @xmachines/play-router run test:watch
-```
-
-`@xmachines/play-router-shared` holds a contract test suite of the router bridge, for the
-author of an adapter. That suite drives a real actor. Therefore it is one layer above this
-package, and `@xmachines/play-router` keeps no dependency on an actor runtime.
-`@xmachines/play-router-shared` is a private workspace package. Thus only an adapter author
-in this repository can use the suite:
-
-```typescript
-import { runBridgeContractTests } from "@xmachines/play-router-shared/test/router-bridge-contract.js";
-
-runBridgeContractTests({
-	name: "MyRouterBridge",
-	createHarness(initialPath) {
-		// return ContractHarness with bridge, actor, simulateNavigation, getLastNavigatedPath
-	},
-	createRestoredHarness(routedPath) {
-		// return ContractHarness whose actor is restored to routedPath
-		// while the mock router starts at the machine's initial route
-	},
-});
-```
-
 ## Related Packages
 
 - **[@xmachines/play](../play/README.md)** — Core protocol types (`PlayEvent`, `PlayError`)
-- **[@xmachines/play-actor](../play-actor/README.md)** — the abstract actor base class (`AbstractActor`, `Routable`). Every `AbstractActor` subclass satisfies `RoutableActor` structurally
-- **[@xmachines/play-signals](../play-signals/README.md)** — the TC39 Signals polyfill that observes the actor route
+- **[@xmachines/play-actor](../play-actor/README.md)** — the actor contract (`PlayActor`). An actor that adds `Routable` of this package satisfies `RoutableActor` structurally
+- **[@xmachines/play-url](../play-url/README.md)** — the URL language. This package re-exports its base path and its framework params, for an adapter on `RouterBridgeBase`
+- **[@xmachines/play-atom](../play-atom/README.md)** — the atom primitives that observe the actor route
 - **[@xmachines/play-xstate](../play-xstate/README.md)** — the XState v5 logic adapter, which works with a route tree
 - **[@xmachines/play-tanstack-router](../play-tanstack-router/README.md)** — Shared TanStack Router bridge base (framework-agnostic)
 - **[@xmachines/play-tanstack-react-router](../play-tanstack-react-router/README.md)** — TanStack Router adapter (React)
 - **[@xmachines/play-tanstack-solid-router](../play-tanstack-solid-router/README.md)** — TanStack Router adapter (SolidJS)
-- **[@xmachines/play-react-router](../play-react-router/README.md)** — React Router v7 adapter
+- **[@xmachines/play-react-router](../play-react-router/README.md)** — React Router 7/8 adapter
 - **[@xmachines/play-vue-router](../play-vue-router/README.md)** — Vue Router adapter
 - **[@xmachines/play-solid-router](../play-solid-router/README.md)** — SolidJS Router adapter
 

package/dist/base-route-map.d.ts

@@ -10,6 +10,7 @@
  * segment, and that number is much smaller than the number of all the routes. The
  * class matches a parameterized route with URLPattern.
  */
+import type { RouteMapOptions } from "./types.js";
 /**
  * One entry of the map between a state ID and a path.
  *
@@ -42,14 +43,21 @@ export interface RouteMapping {
  * - A static path, without a `:param` → a `Map` lookup in O(1)
  * - A dynamic path → a scan of the bucket index in O(k), with `URLPattern`, where
  *   `k` is the number of the routes with the same first path segment
- * - The class keeps each result of a first match in an LRU cache. The default size
- *   is 500 entries, and the `cacheSize` constructor option changes it
+ * - The class keeps each result of a first match in an LRU cache. The default cache
+ *   holds between 500 and 1000 entries, and the `pathCache` constructor option
+ *   replaces it
  *
- * **The syntax of a pattern** (`:param`, `:param?`, and `*`):
+ * **The syntax of a pattern:** the whole URLPattern pathname grammar. The forms used most
+ * often are:
  * - `:param` — a necessary segment. It matches exactly one segment without a `/`
  * - `:param?` — an optional segment. It matches zero segments or one segment without a `/`
  * - `*` — a wildcard. It matches each number of segments, as URLPattern defines
  *
+ * A `{…}` group, a `:param(\d+)` constraint, a `+` modifier and a `\:` escape are read
+ * too. The [routing guide](../../docs/guides/routing.md) states every form, the prefix
+ * rule, and the one divergence from the standard: a param name of this library can hold a
+ * hyphen.
+ *
  * **The forms of a stateId:** you can register a stateId, and you can look one up,
  * in the form `"#stateId"` or in the form `"stateId"`. `RouteMap` makes the
  * canonical form itself. `getStateIdByPath` returns the stateId exactly as you
@@ -82,6 +90,16 @@ export declare class RouteMap {
     private pathToStateId;
     private patternBuckets;
     private pathMatchCache;
+    /** The key space of this ROUTE TABLE inside {@link pathMatchCache}, which a caller may share. */
+    private readonly pathCacheKey;
+    /**
+     * The caches that every parse and every compilation of this map reads.
+     *
+     * Each default stays SHARED on purpose. A map that built one of its own would keep its
+     * patterns out of the cache that `find-route.ts` and `router-sync.ts` read, so the same
+     * pattern would parse two times. A caller that wants the isolation passes a cache.
+     */
+    private compileOptions;
     /**
      * Builds a route map from an array of the mappings between a state ID and a path.
      *
@@ -92,17 +110,10 @@ export declare class RouteMap {
      *
      * @param mappings - The array of the `{ stateId, path }` entries. The order gives the
      *   priority when more than one pattern can match the same path.
-     * @param options - The optional configuration.
-     *   `options.cacheSize`: the maximum number of the resolved parameterized path
-     *   lookups in the cache. The default is `500`. Raise it for an application with
-     *   many different values in a parameterized URL, for example a page of a user
-     *   profile with thousands of different IDs. After an eviction, the path goes to the
-     *   bucket pattern scan in O(k) again, which is correct but slower. The smallest
-     *   effective value is `1`, because QuickLRU requires it.
+     * @param options - See {@link RouteMapOptions}. A map holds TWO caches, so no option is
+     *   named `cache`: each one names the cache that it carries.
      */
-    constructor(mappings: RouteMapping[], { cacheSize }?: {
-        cacheSize?: number;
-    });
+    constructor(mappings: RouteMapping[], options?: RouteMapOptions);
     /**
      * Resolves a URL path to its state ID.
      *

package/dist/base-route-map.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-route-map.d.ts","sourceRoot":"","sources":["../src/base-route-map.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AA0BH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,YAAY;IAC5B,8EAA8E;IAC9E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,uGAAuG;IACvG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,qBAAa,QAAQ;IACpB,8EAA8E;IAC9E,OAAO,CAAC,aAAa,CAAsB;IAC3C,OAAO,CAAC,aAAa,CAAsB;IAC3C,OAAO,CAAC,cAAc,CAGpB;IACF,OAAO,CAAC,cAAc,CAAkC;IAExD;;;;;;;;;;;;;;;;;OAiBG;gBACS,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE,SAAe,EAAE,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO;IAwCtF;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAuB7C;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;CAGhD"}
+{"version":3,"file":"base-route-map.d.ts","sourceRoot":"","sources":["../src/base-route-map.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAeH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAelD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,YAAY;IAC5B,8EAA8E;IAC9E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,uGAAuG;IACvG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACtB;AA+DD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,qBAAa,QAAQ;IACpB,8EAA8E;IAC9E,OAAO,CAAC,aAAa,CAAsB;IAC3C,OAAO,CAAC,aAAa,CAAsB;IAC3C,OAAO,CAAC,cAAc,CAGpB;IACF,OAAO,CAAC,cAAc,CAA8B;IACpD,iGAAiG;IACjG,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA2B;IACxD;;;;;;OAMG;IACH,OAAO,CAAC,cAAc,CAAiB;IAEvC;;;;;;;;;;;;OAYG;gBACS,QAAQ,EAAE,YAAY,EAAE,EAAE,OAAO,GAAE,eAAoB;IAqDnE;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IA4B7C;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;CAGhD"}