@xmachines/docs 6.1.0 → 7.1.0

package/api/@xmachines/play-pattern/interfaces/ParamPart.md

@@ -2,7 +2,7 @@
 
 # Interface: ParamPart
 
-Defined in: [play-pattern/src/pattern-grammar.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L71)
+Defined in: [play-pattern/src/pattern-grammar.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L71)
 
 A param: `:name`, `(\d+)`, or `*`.
 
@@ -11,11 +11,11 @@ this library reports it to no machine — see [ParsedPattern.params](ParsedPatte
 
 ## Properties
 
-| Property                                    | Modifier   | Type                                                    | Description                                                                                                                                                                                                                                                                                                                                                 | Defined in                                                                                                                                          |
-| ------------------------------------------- | ---------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-groupname"></a> `groupName` | `readonly` | `string` \| `null`                                      | The name that URLPattern compiles, with each hyphen rewritten to an underscore, or `null` for an anonymous param. The rewrite happens ONE time, here, and [ParsedPattern.normalized](ParsedPattern.md#property-normalized) carries the same characters. A caller that needs the group name of a param reads this field, and it rewrites nothing of its own. | [play-pattern/src/pattern-grammar.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L83) |
-| <a id="property-kind"></a> `kind`           | `readonly` | `"param"`                                               | -                                                                                                                                                                                                                                                                                                                                                           | [play-pattern/src/pattern-grammar.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L72) |
-| <a id="property-modifier"></a> `modifier`   | `readonly` | [`PatternModifier`](../type-aliases/PatternModifier.md) | -                                                                                                                                                                                                                                                                                                                                                           | [play-pattern/src/pattern-grammar.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L88) |
-| <a id="property-name"></a> `name`           | `readonly` | `string` \| `null`                                      | The declared name, with each hyphen kept, or `null` for an anonymous param.                                                                                                                                                                                                                                                                                 | [play-pattern/src/pattern-grammar.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L74) |
-| <a id="property-prefix"></a> `prefix`       | `readonly` | `string`                                                | The `/` that the param absorbed from the literal before it, or `""`.                                                                                                                                                                                                                                                                                        | [play-pattern/src/pattern-grammar.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L87) |
-| <a id="property-regexp"></a> `regexp`       | `readonly` | `string` \| `null`                                      | The source of the constraint of `:id(\d+)`, or `null` when the param declares none.                                                                                                                                                                                                                                                                         | [play-pattern/src/pattern-grammar.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L85) |
+| Property                                    | Modifier   | Type                                                    | Description                                                                                                                                                                                                                                                                                                                                                 | Defined in                                                                                                                                               |
+| ------------------------------------------- | ---------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-groupname"></a> `groupName` | `readonly` | `string` \| `null`                                      | The name that URLPattern compiles, with each hyphen rewritten to an underscore, or `null` for an anonymous param. The rewrite happens ONE time, here, and [ParsedPattern.normalized](ParsedPattern.md#property-normalized) carries the same characters. A caller that needs the group name of a param reads this field, and it rewrites nothing of its own. | [play-pattern/src/pattern-grammar.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L83) |
+| <a id="property-kind"></a> `kind`           | `readonly` | `"param"`                                               | -                                                                                                                                                                                                                                                                                                                                                           | [play-pattern/src/pattern-grammar.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L72) |
+| <a id="property-modifier"></a> `modifier`   | `readonly` | [`PatternModifier`](../type-aliases/PatternModifier.md) | -                                                                                                                                                                                                                                                                                                                                                           | [play-pattern/src/pattern-grammar.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L88) |
+| <a id="property-name"></a> `name`           | `readonly` | `string` \| `null`                                      | The declared name, with each hyphen kept, or `null` for an anonymous param.                                                                                                                                                                                                                                                                                 | [play-pattern/src/pattern-grammar.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L74) |
+| <a id="property-prefix"></a> `prefix`       | `readonly` | `string`                                                | The `/` that the param absorbed from the literal before it, or `""`.                                                                                                                                                                                                                                                                                        | [play-pattern/src/pattern-grammar.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L87) |
+| <a id="property-regexp"></a> `regexp`       | `readonly` | `string` \| `null`                                      | The source of the constraint of `:id(\d+)`, or `null` when the param declares none.                                                                                                                                                                                                                                                                         | [play-pattern/src/pattern-grammar.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L85) |

package/api/@xmachines/play-pattern/interfaces/ParseOptions.md

@@ -2,7 +2,7 @@
 
 # Interface: ParseOptions
 
-Defined in: [play-pattern/src/cache.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/cache.ts#L35)
+Defined in: [play-pattern/src/cache.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/cache.ts#L35)
 
 The options that every read of the pattern language takes.
 
@@ -14,6 +14,6 @@ positional argument gave each layer a different position to remember.
 
 ## Properties
 
-| Property                                           | Modifier   | Type                                                                       | Description                                                                                                              | Defined in                                                                                                                      |
-| -------------------------------------------------- | ---------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-patterncache"></a> `patternCache?` | `readonly` | [`KeyValueCache`](KeyValueCache.md)\<[`ParsedPattern`](ParsedPattern.md)\> | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process. | [play-pattern/src/cache.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/cache.ts#L41) |
+| Property                                           | Modifier   | Type                                                                       | Description                                                                                                              | Defined in                                                                                                                           |
+| -------------------------------------------------- | ---------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-patterncache"></a> `patternCache?` | `readonly` | [`KeyValueCache`](KeyValueCache.md)\<[`ParsedPattern`](ParsedPattern.md)\> | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process. | [play-pattern/src/cache.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/cache.ts#L41) |

package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md

@@ -2,22 +2,22 @@
 
 # Interface: ParsedPattern
 
-Defined in: [play-pattern/src/pattern-grammar.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L117)
+Defined in: [play-pattern/src/pattern-grammar.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L117)
 
 Everything that this library reads from one route pattern.
 
 ## Properties
 
-| Property                                            | Modifier   | Type                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Defined in                                                                                                                                            |
-| --------------------------------------------------- | ---------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-bareform"></a> `bareForm`           | `readonly` | `string` \| `null`                                         | The path that the pattern matches when every optional part is absent, or `null` when the pattern holds a part that a path must fill. `/settings/:section?` gives `/settings`, `/a/{b}?/c` gives `/a//c`, and `/profile/:userId` gives `null`.                                                                                                                                                                                                                                           | [play-pattern/src/pattern-grammar.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L154) |
-| <a id="property-declarednames"></a> `declaredNames` | `readonly` | `ReadonlyMap`\<`string`, `string`\>                        | The map from each rewritten group name back to the name that the pattern declares, for example `cat_id` to `cat-id`. The map holds an entry only for a name that the rewrite changed. It is empty for most patterns, and a caller that reads a group name falls back to the name itself.                                                                                                                                                                                                | [play-pattern/src/pattern-grammar.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L184) |
-| <a id="property-indexkey"></a> `indexKey`           | `readonly` | `string`                                                   | The key of the bucket index: the first path segment, or `"*"` when a param can stand in the first segment.                                                                                                                                                                                                                                                                                                                                                                              | [play-pattern/src/pattern-grammar.ts:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L171) |
-| <a id="property-literalpath"></a> `literalPath`     | `readonly` | `string` \| `null`                                         | The ONE path that the pattern matches, with each escape resolved, or `null` when the pattern describes a SET of paths. `/users` gives `/users`, `/tags/c\+\+` gives `/tags/c++`, `/x{y}z` gives `/xyz`, and `/profile/:userId` gives `null`. A bridge writes a real browser URL from this field. The SOURCE of the pattern is no substitute for it: `/tags/c\+\+` carries two backslashes that the address bar must not hold, and a location that carries them matches the route never. | [play-pattern/src/pattern-grammar.ts:166](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L166) |
-| <a id="property-names"></a> `names`                 | `readonly` | readonly `string`[]                                        | The name of every param of [params](#property-params), in the same order. `resolveFrameworkParams` runs on EVERY navigation and it needs this list each time. The parse holds it, so a navigation allocates none. A caller that hands the array to somebody else copies it: the cache holds this one.                                                                                                                                                                                   | [play-pattern/src/pattern-grammar.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L131) |
-| <a id="property-normalized"></a> `normalized`       | `readonly` | `string`                                                   | The pattern in the form that URLPattern compiles: each param name that holds a hyphen carries an underscore instead.                                                                                                                                                                                                                                                                                                                                                                    | [play-pattern/src/pattern-grammar.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L176) |
-| <a id="property-parameterized"></a> `parameterized` | `readonly` | `boolean`                                                  | True when the pattern needs a URLPattern match, and false when it is a literal path. A malformed pattern reports `true`, so that it reaches the URLPattern constructor and fails there with the error of the API. A parser that called it static would send it to the exact-match map instead, where it matches nothing and reports no fault.                                                                                                                                           | [play-pattern/src/pattern-grammar.ts:146](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L146) |
-| <a id="property-params"></a> `params`               | `readonly` | readonly [`PatternParam`](PatternParam.md)[]               | The NAMED params, in the order that the pattern declares them.                                                                                                                                                                                                                                                                                                                                                                                                                          | [play-pattern/src/pattern-grammar.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L123) |
-| <a id="property-parts"></a> `parts`                 | `readonly` | readonly [`PatternPart`](../type-aliases/PatternPart.md)[] | The parts, in the order that the pattern declares them.                                                                                                                                                                                                                                                                                                                                                                                                                                 | [play-pattern/src/pattern-grammar.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L121) |
-| <a id="property-requirednames"></a> `requiredNames` | `readonly` | readonly `string`[]                                        | The name of every param that a path must fill, in the order of [params](#property-params). The same rule as [names](#property-names): the parse holds the array, and a navigation reads it.                                                                                                                                                                                                                                                                                             | [play-pattern/src/pattern-grammar.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L137) |
-| <a id="property-source"></a> `source`               | `readonly` | `string`                                                   | The pattern as the caller wrote it.                                                                                                                                                                                                                                                                                                                                                                                                                                                     | [play-pattern/src/pattern-grammar.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L119) |
+| Property                                            | Modifier   | Type                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Defined in                                                                                                                                                 |
+| --------------------------------------------------- | ---------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-bareform"></a> `bareForm`           | `readonly` | `string` \| `null`                                         | The path that the pattern matches when every optional part is absent, or `null` when the pattern holds a part that a path must fill. `/settings/:section?` gives `/settings`, `/a/{b}?/c` gives `/a//c`, and `/profile/:userId` gives `null`.                                                                                                                                                                                                                                           | [play-pattern/src/pattern-grammar.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L154) |
+| <a id="property-declarednames"></a> `declaredNames` | `readonly` | `ReadonlyMap`\<`string`, `string`\>                        | The map from each rewritten group name back to the name that the pattern declares, for example `cat_id` to `cat-id`. The map holds an entry only for a name that the rewrite changed. It is empty for most patterns, and a caller that reads a group name falls back to the name itself.                                                                                                                                                                                                | [play-pattern/src/pattern-grammar.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L184) |
+| <a id="property-indexkey"></a> `indexKey`           | `readonly` | `string`                                                   | The key of the bucket index: the first path segment, or `"*"` when a param can stand in the first segment.                                                                                                                                                                                                                                                                                                                                                                              | [play-pattern/src/pattern-grammar.ts:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L171) |
+| <a id="property-literalpath"></a> `literalPath`     | `readonly` | `string` \| `null`                                         | The ONE path that the pattern matches, with each escape resolved, or `null` when the pattern describes a SET of paths. `/users` gives `/users`, `/tags/c\+\+` gives `/tags/c++`, `/x{y}z` gives `/xyz`, and `/profile/:userId` gives `null`. A bridge writes a real browser URL from this field. The SOURCE of the pattern is no substitute for it: `/tags/c\+\+` carries two backslashes that the address bar must not hold, and a location that carries them matches the route never. | [play-pattern/src/pattern-grammar.ts:166](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L166) |
+| <a id="property-names"></a> `names`                 | `readonly` | readonly `string`[]                                        | The name of every param of [params](#property-params), in the same order. `resolveFrameworkParams` runs on EVERY navigation and it needs this list each time. The parse holds it, so a navigation allocates none. A caller that hands the array to somebody else copies it: the cache holds this one.                                                                                                                                                                                   | [play-pattern/src/pattern-grammar.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L131) |
+| <a id="property-normalized"></a> `normalized`       | `readonly` | `string`                                                   | The pattern in the form that URLPattern compiles: each param name that holds a hyphen carries an underscore instead.                                                                                                                                                                                                                                                                                                                                                                    | [play-pattern/src/pattern-grammar.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L176) |
+| <a id="property-parameterized"></a> `parameterized` | `readonly` | `boolean`                                                  | True when the pattern needs a URLPattern match, and false when it is a literal path. A malformed pattern reports `true`, so that it reaches the URLPattern constructor and fails there with the error of the API. A parser that called it static would send it to the exact-match map instead, where it matches nothing and reports no fault.                                                                                                                                           | [play-pattern/src/pattern-grammar.ts:146](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L146) |
+| <a id="property-params"></a> `params`               | `readonly` | readonly [`PatternParam`](PatternParam.md)[]               | The NAMED params, in the order that the pattern declares them.                                                                                                                                                                                                                                                                                                                                                                                                                          | [play-pattern/src/pattern-grammar.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L123) |
+| <a id="property-parts"></a> `parts`                 | `readonly` | readonly [`PatternPart`](../type-aliases/PatternPart.md)[] | The parts, in the order that the pattern declares them.                                                                                                                                                                                                                                                                                                                                                                                                                                 | [play-pattern/src/pattern-grammar.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L121) |
+| <a id="property-requirednames"></a> `requiredNames` | `readonly` | readonly `string`[]                                        | The name of every param that a path must fill, in the order of [params](#property-params). The same rule as [names](#property-names): the parse holds the array, and a navigation reads it.                                                                                                                                                                                                                                                                                             | [play-pattern/src/pattern-grammar.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L137) |
+| <a id="property-source"></a> `source`               | `readonly` | `string`                                                   | The pattern as the caller wrote it.                                                                                                                                                                                                                                                                                                                                                                                                                                                     | [play-pattern/src/pattern-grammar.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L119) |

package/api/@xmachines/play-pattern/interfaces/PatternParam.md

@@ -2,14 +2,14 @@
 
 # Interface: PatternParam
 
-Defined in: [play-pattern/src/pattern-grammar.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L101)
+Defined in: [play-pattern/src/pattern-grammar.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L101)
 
 One named param of a pattern, with the question that every caller asks about it.
 
 ## Properties
 
-| Property                                    | Modifier   | Type      | Description                                                                                                                                                                                                                                                           | Defined in                                                                                                                                            |
-| ------------------------------------------- | ---------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-groupname"></a> `groupName` | `readonly` | `string`  | The name that URLPattern compiles, for example `cat_id`.                                                                                                                                                                                                              | [play-pattern/src/pattern-grammar.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L105) |
-| <a id="property-name"></a> `name`           | `readonly` | `string`  | The name as the pattern declares it, for example `cat-id`.                                                                                                                                                                                                            | [play-pattern/src/pattern-grammar.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L103) |
-| <a id="property-optional"></a> `optional`   | `readonly` | `boolean` | True when a matching path can carry no value for this param. The modifier `?` and the modifier `*` make a param optional, and so does EVERY group above it that carries one of the two. The modifier `+` does not: it repeats a param that one value must still fill. | [play-pattern/src/pattern-grammar.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L113) |
+| Property                                    | Modifier   | Type      | Description                                                                                                                                                                                                                                                           | Defined in                                                                                                                                                 |
+| ------------------------------------------- | ---------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-groupname"></a> `groupName` | `readonly` | `string`  | The name that URLPattern compiles, for example `cat_id`.                                                                                                                                                                                                              | [play-pattern/src/pattern-grammar.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L105) |
+| <a id="property-name"></a> `name`           | `readonly` | `string`  | The name as the pattern declares it, for example `cat-id`.                                                                                                                                                                                                            | [play-pattern/src/pattern-grammar.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L103) |
+| <a id="property-optional"></a> `optional`   | `readonly` | `boolean` | True when a matching path can carry no value for this param. The modifier `?` and the modifier `*` make a param optional, and so does EVERY group above it that carries one of the two. The modifier `+` does not: it repeats a param that one value must still fill. | [play-pattern/src/pattern-grammar.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L113) |

package/api/@xmachines/play-pattern/type-aliases/PathBuildResult.md

@@ -21,7 +21,7 @@ type PathBuildResult =
 	  };
 ```
 
-Defined in: [play-pattern/src/pattern-grammar.ts:651](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L651)
+Defined in: [play-pattern/src/pattern-grammar.ts:651](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L651)
 
 The answer of [buildPath](../functions/buildPath.md).
 

package/api/@xmachines/play-pattern/type-aliases/PathParams.md

@@ -6,7 +6,7 @@
 type PathParams = Readonly<Record<string, unknown>>;
 ```
 
-Defined in: [play-pattern/src/pattern-grammar.ts:681](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L681)
+Defined in: [play-pattern/src/pattern-grammar.ts:681](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L681)
 
 The values that a caller gives, keyed by the declared name of the param.
 

package/api/@xmachines/play-pattern/type-aliases/PatternModifier.md

@@ -6,6 +6,6 @@
 type PatternModifier = "" | "?" | "+" | "*";
 ```
 
-Defined in: [play-pattern/src/pattern-grammar.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L56)
+Defined in: [play-pattern/src/pattern-grammar.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L56)
 
 The modifier of a part. `""` means that the part carries none.

package/api/@xmachines/play-pattern/type-aliases/PatternPart.md

@@ -6,4 +6,4 @@
 type PatternPart = LiteralPart | ParamPart | GroupPart;
 ```
 
-Defined in: [play-pattern/src/pattern-grammar.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L98)
+Defined in: [play-pattern/src/pattern-grammar.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/pattern-grammar.ts#L98)

package/api/@xmachines/play-react/README.md

@@ -4,7 +4,7 @@
 
 React renderer for XMachines Play architecture with atom-driven rendering.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-6.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-react)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-7.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-react)
 
 ## Installation
 
@@ -15,15 +15,17 @@ pnpm add @xmachines/play-react
 **Peer dependencies.** Install them separately:
 
 ```bash
-pnpm add react react-dom @xmachines/core @xmachines/play @xmachines/play-atom @xstate/store @xmachines/json-render-react @xmachines/json-render-core @xmachines/json-render-xstate
+pnpm add react react-dom @xmachines/core @xmachines/play @xmachines/play-atom @xstate/store @xmachines/json-render-react@0.21.0-xm.6 @xmachines/json-render-core@0.21.0-xm.6 @xmachines/json-render-xstate@0.21.0-xm.6
 ```
 
+The json-render packages are exact peers: install the version that this release names, `0.21.0-xm.6`.
+
 Supported versions:
 
 - `react` / `react-dom`: `^18.0.0 || ^19.0.0`
 - [`@xmachines/core`](../core/README.md), [`@xmachines/play`](../play/README.md) and [`@xmachines/play-atom`](../play-atom/README.md): the version of this release
 - `@xstate/store`: `^4.2.3`
-- `@xmachines/json-render-*`: `^0.21.0-xm.2`
+- `@xmachines/json-render-*`: `0.21.0-xm.6`
 
 `@xstate/store` is the peer of [`@xmachines/play-atom`](../play-atom/README.md), and not of this
 package: this package reads the atom through [`@xmachines/play-atom`](../play-atom/README.md) and
@@ -36,27 +38,46 @@ imports the engine in no source file. Install ONE copy of it.
 The recommended pattern for actor-driven React rendering:
 
 ```tsx
-import { PlayUIProvider, PlayRenderer, defineRegistry } from "@xmachines/play-react";
+import { PlayUIProvider, PlayRenderer, defineRegistry, schema } from "@xmachines/play-react";
 import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
 import { withView } from "@xmachines/play-xstate/view";
-import { myMachine } from "./machine.js"; // your xstate machine (states carry meta.view specs)
-import { myCatalog } from "./catalog.js"; // the result of defineCatalog(schema, ...), with `schema` from "@xmachines/play-react"
-import { Login, Dashboard } from "./components.js"; // your React components
+import { defineCatalog } from "@xmachines/json-render-core";
+import type { AnyStateMachine } from "xstate";
+import { z } from "zod";
+
+declare const myMachine: AnyStateMachine; // your xstate machine (states carry meta.view specs)
+
+// 1. Define the catalog: the components and the actions that a view can name
+const myCatalog = defineCatalog(schema, {
+	components: {
+		Login: { props: z.object({ title: z.string() }) },
+		Dashboard: { props: z.object({ username: z.string() }) },
+	},
+	actions: {
+		login: { params: z.object({ username: z.string() }) },
+		logout: {},
+	},
+});
 
-// 1. Create and start the actor — a renderer needs the view capability
+// 2. Create and start the actor — a renderer needs the view capability
 const actor = definePlayer({ machine: myMachine, actor: compose(PlayerActor, withView) })();
 actor.start();
 
-// 2. Define the component registry with action handlers
+// 3. Define the component registry with action handlers
 const registryResult = defineRegistry(myCatalog, {
-	components: { Login, Dashboard },
+	components: {
+		Login: ({ props }) => <h1>{props.title}</h1>,
+		Dashboard: ({ props }) => <p>Welcome, {props.username}</p>,
+	},
 	actions: {
-		login: async ({ username }) => actor.send({ type: "auth.login", username }),
+		login: async (params) => {
+			if (params) actor.send({ type: "auth.login", username: params.username });
+		},
 		logout: async () => actor.send({ type: "auth.logout" }),
 	},
 });
 
-// 3. Render — atoms drive view transitions automatically
+// 4. Render — atoms drive view transitions automatically
 function App() {
 	return (
 		<PlayUIProvider actor={actor} registryResult={registryResult}>
@@ -71,15 +92,21 @@ function App() {
 Pass navigation and validation helpers through `PlayUIProvider`:
 
 ```tsx
+import { PlayUIProvider, PlayRenderer, type PlayUIProviderProps } from "@xmachines/play-react";
+
 // actor, registryResult from the Quick Start above
+declare const actor: PlayUIProviderProps["actor"];
+declare const registryResult: PlayUIProviderProps["registryResult"];
+declare const myRouter: { push(path: string): void }; // your router
+
 <PlayUIProvider
 	actor={actor}
 	registryResult={registryResult}
-	navigate={(path) => history.pushState(null, "", path)}
+	navigate={(path) => myRouter.push(path)}
 	validationFunctions={{ isEmail: (v) => /^.+@.+$/.test(String(v)) }}
 >
 	<PlayRenderer />
-</PlayUIProvider>
+</PlayUIProvider>;
 ```
 
 ### Custom provider composition
@@ -89,6 +116,7 @@ Use `ActorProvider` directly when you need to compose providers manually:
 ```tsx
 import type { ReactNode } from "react";
 import { ActorProvider, JSONUIProvider, PlayRenderer, usePlayView } from "@xmachines/play-react";
+import type { ActorProviderProps } from "@xmachines/play-react";
 
 // Handlers and store live in ViewContext, so an inner bridge component must
 // read them via usePlayView() and forward all three to JSONUIProvider —
@@ -103,6 +131,9 @@ function Bridge({ children }: { children: ReactNode }) {
 }
 
 // actor, registryResult from the Quick Start above
+declare const actor: ActorProviderProps["actor"];
+declare const registryResult: ActorProviderProps["registryResult"];
+
 <ActorProvider actor={actor} registryResult={registryResult}>
 	<Bridge>
 		<PlayRenderer />
@@ -125,10 +156,10 @@ function SubmitButton() {
 
 ```tsx
 import { useState } from "react";
-import { useAtomEffect } from "@xmachines/play-react";
+import { useAtomEffect, type PlayUIProviderProps } from "@xmachines/play-react";
 
-function MyComponent({ actor }) {
-	const [view, setView] = useState(null);
+function MyComponent({ actor }: { actor: PlayUIProviderProps["actor"] }) {
+	const [view, setView] = useState(() => actor.currentView.get());
 
 	// The first argument names every atom that runs the effect.
 	useAtomEffect(
@@ -172,7 +203,11 @@ function MyComponent({ actor }) {
 | `PlayErrorBoundaryState` | State shape for `<PlayErrorBoundary>`                                           |
 | `AnyPlayActor`           | Type alias for `PlayActor` — the bare actor type that the context providers use |
 | `ViewContextValue`       | The value shape that `usePlayView()` returns                                    |
-| `RenderErrorHandler`     | Error handler callback type for render errors                                   |
+| `DefineRegistryResult`   | The result of `defineRegistry`, for a registry that you declare or pass on      |
+| `OnRenderError`          | The `(error, name, info)` handler of `onRenderError`                            |
+| `RenderErrorInfo`        | The `info` of a report: `kind`, `key`, `type`, and `action`                     |
+| `RenderErrorKind`        | The kind of a failure, such as `"element"`, `"action"`, or `"root"`             |
+| `RenderErrorHandler`     | The older `(error, name)` handler type. It stays for compatibility              |
 
 ### Re-exports from `@xmachines/json-render-react`
 
@@ -233,11 +268,13 @@ composition. Read its source for the reference bridge.
 - [ActionProviderProps](interfaces/ActionProviderProps.md)
 - [ActorProviderProps](interfaces/ActorProviderProps.md)
 - [ComponentContext](interfaces/ComponentContext.md)
+- [DefineRegistryResult](interfaces/DefineRegistryResult.md)
 - [JSONUIProviderProps](interfaces/JSONUIProviderProps.md)
 - [PlayErrorBoundaryProps](interfaces/PlayErrorBoundaryProps.md)
 - [PlayErrorBoundaryState](interfaces/PlayErrorBoundaryState.md)
 - [PlayUIProviderProps](interfaces/PlayUIProviderProps.md)
 - [RendererProps](interfaces/RendererProps.md)
+- [RenderErrorInfo](interfaces/RenderErrorInfo.md)
 - [StateProviderProps](interfaces/StateProviderProps.md)
 - [ValidationProviderProps](interfaces/ValidationProviderProps.md)
 - [ViewContextValue](interfaces/ViewContextValue.md)
@@ -247,7 +284,9 @@ composition. Read its source for the reference bridge.
 
 - [AnyPlayActor](type-aliases/AnyPlayActor.md)
 - [ComponentFn](type-aliases/ComponentFn.md)
+- [OnRenderError](type-aliases/OnRenderError.md)
 - [RenderErrorHandler](type-aliases/RenderErrorHandler.md)
+- [RenderErrorKind](type-aliases/RenderErrorKind.md)
 
 ## Variables