@xmachines/docs 5.0.1 → 5.0.2

package/api/@xmachines/play-url/index/interfaces/ParsedPattern.md

@@ -2,7 +2,7 @@
 
 # Interface: ParsedPattern
 
-Defined in: [packages/play-pattern/src/pattern-grammar.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/pattern-grammar.ts#L117)
+Defined in: [packages/play-pattern/src/pattern-grammar.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/pattern-grammar.ts#L117)
 
 Everything that this library reads from one route pattern.
 
@@ -10,14 +10,14 @@ Everything that this library reads from one route pattern.
 
 | 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`.                                                                                                                                                                                                                                           | [packages/play-pattern/src/pattern-grammar.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/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.                                                                                                                                                                                                | [packages/play-pattern/src/pattern-grammar.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/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.                                                                                                                                                                                                                                                                                                                                                                              | [packages/play-pattern/src/pattern-grammar.ts:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/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. | [packages/play-pattern/src/pattern-grammar.ts:166](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/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.                                                                                                                                                                                   | [packages/play-pattern/src/pattern-grammar.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/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.                                                                                                                                                                                                                                                                                                                                                                    | [packages/play-pattern/src/pattern-grammar.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/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.                                                                                                                                           | [packages/play-pattern/src/pattern-grammar.ts:146](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/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.                                                                                                                                                                                                                                                                                                                                                                                                                          | [packages/play-pattern/src/pattern-grammar.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/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.                                                                                                                                                                                                                                                                                                                                                                                                                                 | [packages/play-pattern/src/pattern-grammar.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/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.                                                                                                                                                                                                                                                                                             | [packages/play-pattern/src/pattern-grammar.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/pattern-grammar.ts#L137) |
-| <a id="property-source"></a> `source`               | `readonly` | `string`                                                   | The pattern as the caller wrote it.                                                                                                                                                                                                                                                                                                                                                                                                                                                     | [packages/play-pattern/src/pattern-grammar.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/pattern-grammar.ts#L119) |
+| <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`.                                                                                                                                                                                                                                           | [packages/play-pattern/src/pattern-grammar.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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.                                                                                                                                                                                                | [packages/play-pattern/src/pattern-grammar.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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.                                                                                                                                                                                                                                                                                                                                                                              | [packages/play-pattern/src/pattern-grammar.ts:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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. | [packages/play-pattern/src/pattern-grammar.ts:166](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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.                                                                                                                                                                                   | [packages/play-pattern/src/pattern-grammar.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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.                                                                                                                                                                                                                                                                                                                                                                    | [packages/play-pattern/src/pattern-grammar.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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.                                                                                                                                           | [packages/play-pattern/src/pattern-grammar.ts:146](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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.                                                                                                                                                                                                                                                                                                                                                                                                                          | [packages/play-pattern/src/pattern-grammar.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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.                                                                                                                                                                                                                                                                                                                                                                                                                                 | [packages/play-pattern/src/pattern-grammar.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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.                                                                                                                                                                                                                                                                                             | [packages/play-pattern/src/pattern-grammar.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/pattern-grammar.ts#L137) |
+| <a id="property-source"></a> `source`               | `readonly` | `string`                                                   | The pattern as the caller wrote it.                                                                                                                                                                                                                                                                                                                                                                                                                                                     | [packages/play-pattern/src/pattern-grammar.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/pattern-grammar.ts#L119) |

package/api/@xmachines/play-url/index/interfaces/PatternCache.md

@@ -2,7 +2,7 @@
 
 # Interface: PatternCache\<V\>
 
-Defined in: [packages/play-pattern/src/cache.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/cache.ts#L53)
+Defined in: [packages/play-pattern/src/cache.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/cache.ts#L53)
 
 What this package needs from a cache: a read and a write, both by a string key.
 
@@ -27,7 +27,7 @@ parser runs again for an entry that is absent.
 get(key): V | undefined;
 ```
 
-Defined in: [packages/play-pattern/src/cache.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/cache.ts#L55)
+Defined in: [packages/play-pattern/src/cache.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/cache.ts#L55)
 
 Reads one entry, or `undefined` when the cache holds none for the key.
 
@@ -49,7 +49,7 @@ Reads one entry, or `undefined` when the cache holds none for the key.
 set(key, value): void;
 ```
 
-Defined in: [packages/play-pattern/src/cache.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/cache.ts#L57)
+Defined in: [packages/play-pattern/src/cache.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/cache.ts#L57)
 
 Writes one entry.
 

package/api/@xmachines/play-url/index/interfaces/PatternParam.md

@@ -2,7 +2,7 @@
 
 # Interface: PatternParam
 
-Defined in: [packages/play-pattern/src/pattern-grammar.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/pattern-grammar.ts#L101)
+Defined in: [packages/play-pattern/src/pattern-grammar.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/pattern-grammar.ts#L101)
 
 One named param of a pattern, with the question that every caller asks about it.
 
@@ -10,6 +10,6 @@ One named param of a pattern, with the question that every caller asks about it.
 
 | Property                                    | Modifier   | Type      | Description                                                                                                                                                                                                                                                           | Defined in                                                                                                                                                     |
 | ------------------------------------------- | ---------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-groupname"></a> `groupName` | `readonly` | `string`  | The name that URLPattern compiles, for example `cat_id`.                                                                                                                                                                                                              | [packages/play-pattern/src/pattern-grammar.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/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`.                                                                                                                                                                                                            | [packages/play-pattern/src/pattern-grammar.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/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. | [packages/play-pattern/src/pattern-grammar.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/pattern-grammar.ts#L113) |
+| <a id="property-groupname"></a> `groupName` | `readonly` | `string`  | The name that URLPattern compiles, for example `cat_id`.                                                                                                                                                                                                              | [packages/play-pattern/src/pattern-grammar.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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`.                                                                                                                                                                                                            | [packages/play-pattern/src/pattern-grammar.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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. | [packages/play-pattern/src/pattern-grammar.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/pattern-grammar.ts#L113) |

package/api/@xmachines/play-url/index/interfaces/ResolvedBasePath.md

@@ -2,7 +2,7 @@
 
 # Interface: ResolvedBasePath
 
-Defined in: [packages/play-url/src/base-path.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-url/src/base-path.ts#L82)
+Defined in: [packages/play-url/src/base-path.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/base-path.ts#L82)
 
 A base path that is ready for a use in both directions.
 
@@ -10,5 +10,5 @@ A base path that is ready for a use in both directions.
 
 | Property                              | Modifier   | Type                           | Description                                                                                                                                                                     | Defined in                                                                                                                               |
 | ------------------------------------- | ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-params"></a> `params` | `readonly` | `Record`\<`string`, `string`\> | The values of each `:param` of the prefix, for the `params` of a `play.route` event. The object is empty for a prefix without a param, and for a pattern that nothing resolved. | [packages/play-url/src/base-path.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-url/src/base-path.ts#L93) |
-| <a id="property-path"></a> `path`     | `readonly` | `string`                       | The normalized prefix: it starts with `/`, it carries no trailing `/`, and it holds no duplicate slash. The empty string means "no prefix".                                     | [packages/play-url/src/base-path.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-url/src/base-path.ts#L87) |
+| <a id="property-params"></a> `params` | `readonly` | `Record`\<`string`, `string`\> | The values of each `:param` of the prefix, for the `params` of a `play.route` event. The object is empty for a prefix without a param, and for a pattern that nothing resolved. | [packages/play-url/src/base-path.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/base-path.ts#L93) |
+| <a id="property-path"></a> `path`     | `readonly` | `string`                       | The normalized prefix: it starts with `/`, it carries no trailing `/`, and it holds no duplicate slash. The empty string means "no prefix".                                     | [packages/play-url/src/base-path.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/base-path.ts#L87) |

package/api/@xmachines/play-url/index/interfaces/SplitLocation.md

@@ -2,7 +2,7 @@
 
 # Interface: SplitLocation
 
-Defined in: [packages/play-url/src/location.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-url/src/location.ts#L17)
+Defined in: [packages/play-url/src/location.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/location.ts#L17)
 
 The parts of one location string.
 
@@ -10,7 +10,7 @@ The parts of one location string.
 
 | Property                                  | Modifier   | Type     | Description                                                                                                                                                                                                                       | Defined in                                                                                                                             |
 | ----------------------------------------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-fragment"></a> `fragment` | `readonly` | `string` | The fragment, WITH its leading `#`. It is `""` when the location carries none.                                                                                                                                                    | [packages/play-url/src/location.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-url/src/location.ts#L23) |
-| <a id="property-pathname"></a> `pathname` | `readonly` | `string` | The pathname, with no query and no fragment.                                                                                                                                                                                      | [packages/play-url/src/location.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-url/src/location.ts#L19) |
-| <a id="property-query"></a> `query`       | `readonly` | `string` | The query, with no leading `?`. It is `""` when the location carries none.                                                                                                                                                        | [packages/play-url/src/location.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-url/src/location.ts#L21) |
-| <a id="property-suffix"></a> `suffix`     | `readonly` | `string` | Every character behind the pathname, as the location wrote them. A caller that rebuilds a location keeps this string rather than the two parts above, because it carries the `?` and the order of the two marks without a change. | [packages/play-url/src/location.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-url/src/location.ts#L30) |
+| <a id="property-fragment"></a> `fragment` | `readonly` | `string` | The fragment, WITH its leading `#`. It is `""` when the location carries none.                                                                                                                                                    | [packages/play-url/src/location.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/location.ts#L23) |
+| <a id="property-pathname"></a> `pathname` | `readonly` | `string` | The pathname, with no query and no fragment.                                                                                                                                                                                      | [packages/play-url/src/location.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/location.ts#L19) |
+| <a id="property-query"></a> `query`       | `readonly` | `string` | The query, with no leading `?`. It is `""` when the location carries none.                                                                                                                                                        | [packages/play-url/src/location.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/location.ts#L21) |
+| <a id="property-suffix"></a> `suffix`     | `readonly` | `string` | Every character behind the pathname, as the location wrote them. A caller that rebuilds a location keeps this string rather than the two parts above, because it carries the `?` and the order of the two marks without a change. | [packages/play-url/src/location.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/location.ts#L30) |

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

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

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

@@ -6,7 +6,7 @@
 type PathParams = Readonly<Record<string, unknown>>;
 ```
 
-Defined in: [packages/play-pattern/src/pattern-grammar.ts:681](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/pattern-grammar.ts#L681)
+Defined in: [packages/play-pattern/src/pattern-grammar.ts:681](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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-url/index/type-aliases/PatternModifier.md

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

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

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

package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md

@@ -6,7 +6,7 @@
 type URLPatternCtor = (init) => URLPatternLike;
 ```
 
-Defined in: [packages/play-url/src/url-pattern-utils.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-url/src/url-pattern-utils.ts#L59)
+Defined in: [packages/play-url/src/url-pattern-utils.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L59)
 
 The constructor type of a URLPatternLike instance.
 

package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md

@@ -6,7 +6,7 @@
 type URLPatternLike = object;
 ```
 
-Defined in: [packages/play-url/src/url-pattern-utils.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-url/src/url-pattern-utils.ts#L51)
+Defined in: [packages/play-url/src/url-pattern-utils.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L51)
 
 The minimal structural type of the part of URLPattern that this package uses.
 
@@ -28,7 +28,7 @@ exec(input):
   | null;
 ```
 
-Defined in: [packages/play-url/src/url-pattern-utils.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-url/src/url-pattern-utils.ts#L52)
+Defined in: [packages/play-url/src/url-pattern-utils.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L52)
 
 #### Parameters
 
@@ -54,7 +54,7 @@ Defined in: [packages/play-url/src/url-pattern-utils.ts:52](https://gitlab.com/x
 test(input): boolean;
 ```
 
-Defined in: [packages/play-url/src/url-pattern-utils.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-url/src/url-pattern-utils.ts#L55)
+Defined in: [packages/play-url/src/url-pattern-utils.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L55)
 
 #### Parameters
 

package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md

@@ -6,7 +6,7 @@
 const NO_BASE_PATH: ResolvedBasePath;
 ```
 
-Defined in: [packages/play-url/src/base-path.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-url/src/base-path.ts#L106)
+Defined in: [packages/play-url/src/base-path.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/base-path.ts#L106)
 
 The base path of a bridge that has no `basePath` option.
 

package/api/@xmachines/play-url/index/variables/URLPattern.md

@@ -6,7 +6,7 @@
 const URLPattern: URLPatternCtor;
 ```
 
-Defined in: [packages/play-url/src/url-pattern-utils.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-url/src/url-pattern-utils.ts#L74)
+Defined in: [packages/play-url/src/url-pattern-utils.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L74)
 
 The URLPattern constructor that this library uses: the native API when the runtime
 carries one, and the polyfill when it does not.

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

@@ -4,7 +4,7 @@
 
 The shared view half of every renderer of the XMachines Play Architecture.
 
-[![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.1-blue)](https://www.npmjs.com/package/@xmachines/play-view)
+[![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.2-blue)](https://www.npmjs.com/package/@xmachines/play-view)
 
 ## Installation
 

package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md

@@ -2,7 +2,7 @@
 
 # Class: ReadOnlyContextError
 
-Defined in: [packages/play-view/src/errors.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/errors.ts#L34)
+Defined in: [packages/play-view/src/errors.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/errors.ts#L34)
 
 A write reached the context projection of the view store.
 
@@ -37,7 +37,7 @@ try {
 new ReadOnlyContextError(path, stateKey): ReadOnlyContextError;
 ```
 
-Defined in: [packages/play-view/src/errors.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/errors.ts#L42)
+Defined in: [packages/play-view/src/errors.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/errors.ts#L42)
 
 #### Parameters
 
@@ -59,11 +59,11 @@ Defined in: [packages/play-view/src/errors.ts:42](https://gitlab.com/xmachin-es/
 | Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                           |
 | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
 | <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause)                     | -                                                                                                                                    |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L76)           |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L76)           |
 | <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message)                 | -                                                                                                                                    |
 | <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name)                       | -                                                                                                                                    |
-| <a id="property-path"></a> `path`                       | `readonly` | `string`  | The JSON pointer of the write that the store refused, as the caller gave it.                                                                                                                                                                                                                                                                                                                                                                      | -                                                                                                                                                | [packages/play-view/src/errors.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/errors.ts#L36) |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L66)           |
+| <a id="property-path"></a> `path`                       | `readonly` | `string`  | The JSON pointer of the write that the store refused, as the caller gave it.                                                                                                                                                                                                                                                                                                                                                                      | -                                                                                                                                                | [packages/play-view/src/errors.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/errors.ts#L36) |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L66)           |
 | <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack)                     | -                                                                                                                                    |
 | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | -                                                                                                                                    |
 

package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md

@@ -6,7 +6,7 @@
 function attachRenderErrorHandler<TRegistry>(registry, handler): TRegistry;
 ```
 
-Defined in: [packages/play-view/src/provider-guards.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/provider-guards.ts#L68)
+Defined in: [packages/play-view/src/provider-guards.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/provider-guards.ts#L68)
 
 Copies a component registry, and puts an `onRenderError` handler into the copy.
 

package/api/@xmachines/play-view/index/functions/composePlayState.md

@@ -6,7 +6,7 @@
 function composePlayState(authoredState, slice): Record<string, unknown> | undefined;
 ```
 
-Defined in: [packages/play-view/src/context-projection.ts:208](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/context-projection.ts#L208)
+Defined in: [packages/play-view/src/context-projection.ts:208](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/context-projection.ts#L208)
 
 Composes the effective state of a view: the authored `spec.state` and the
 `/context` slice.

package/api/@xmachines/play-view/index/functions/createFailureLatch.md

@@ -6,7 +6,7 @@
 function createFailureLatch(): FailureLatch;
 ```
 
-Defined in: [packages/play-view/src/failure-latch.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/failure-latch.ts#L202)
+Defined in: [packages/play-view/src/failure-latch.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/failure-latch.ts#L202)
 
 Makes a [FailureLatch](../interfaces/FailureLatch.md).
 

package/api/@xmachines/play-view/index/functions/createReportGuard.md

@@ -6,7 +6,7 @@
 function createReportGuard(messages): ReportGuard;
 ```
 
-Defined in: [packages/play-view/src/failure-latch.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/failure-latch.ts#L134)
+Defined in: [packages/play-view/src/failure-latch.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/failure-latch.ts#L134)
 
 Makes a [ReportGuard](../interfaces/ReportGuard.md).
 

package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md

@@ -6,7 +6,7 @@
 function createViewStoreLifecycle(createStore): ViewStoreLifecycle;
 ```
 
-Defined in: [packages/play-view/src/view-store-lifecycle.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-store-lifecycle.ts#L94)
+Defined in: [packages/play-view/src/view-store-lifecycle.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-store-lifecycle.ts#L94)
 
 Creates a coordinator of the lifecycle.
 

package/api/@xmachines/play-view/index/functions/guardContextWrites.md

@@ -6,7 +6,7 @@
 function guardContextWrites(store): StateStore;
 ```
 
-Defined in: [packages/play-view/src/context-projection.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/context-projection.ts#L137)
+Defined in: [packages/play-view/src/context-projection.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/context-projection.ts#L137)
 
 ## Parameters
 

package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md

@@ -6,7 +6,7 @@
 function refreshContextSubtree(store, view): void;
 ```
 
-Defined in: [packages/play-view/src/context-projection.ts:190](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/context-projection.ts#L190)
+Defined in: [packages/play-view/src/context-projection.ts:190](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/context-projection.ts#L190)
 
 Refreshes the `/context` subtree of a live store from the composed state of a
 derived view. An emission with the same `viewKey` means that only the projection

package/api/@xmachines/play-view/index/functions/reuseComposedState.md

@@ -6,7 +6,7 @@
 function reuseComposedState(prev, next): PlaySpec | null;
 ```
 
-Defined in: [packages/play-view/src/context-projection.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/context-projection.ts#L73)
+Defined in: [packages/play-view/src/context-projection.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/context-projection.ts#L73)
 
 Reuses the composed `state` of the previous emission, or the complete previous
 spec, when the value of the projection did not change.

package/api/@xmachines/play-view/index/functions/sameViewInputs.md

@@ -6,7 +6,7 @@
 function sameViewInputs(a, b): boolean;
 ```
 
-Defined in: [packages/play-view/src/failure-latch.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/failure-latch.ts#L45)
+Defined in: [packages/play-view/src/failure-latch.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/failure-latch.ts#L45)
 
 Answers whether two sets of inputs are the SAME attempt.
 

package/api/@xmachines/play-view/index/functions/toAtomState.md

@@ -6,7 +6,7 @@
 function toAtomState(state): Record<string, unknown>;
 ```
 
-Defined in: [packages/play-view/src/provider-guards.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/provider-guards.ts#L39)
+Defined in: [packages/play-view/src/provider-guards.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/provider-guards.ts#L39)
 
 Converts the `state` field of a spec into a plain object for `createAtom`, in a safe way.
 

package/api/@xmachines/play-view/index/functions/typedSpec.md

@@ -6,7 +6,7 @@
 function typedSpec(spec): PlaySpec;
 ```
 
-Defined in: [packages/play-view/src/view-types.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L76)
+Defined in: [packages/play-view/src/view-types.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-types.ts#L76)
 
 The identity helper gives a view spec literal the type `PlaySpec` at the
 definition site. The compiler therefore checks the spec, and the IDE completes it.

package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md

@@ -2,7 +2,7 @@
 
 # Interface: BaseActorProviderProps\<TRegistry, TActor\>
 
-Defined in: [packages/play-view/src/view-types.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L164)
+Defined in: [packages/play-view/src/view-types.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-types.ts#L164)
 
 The framework-agnostic base props. Every `ActorProvider` implementation shares
 them: React, Vue, Solid, and Svelte. `TRegistry` holds the
@@ -43,7 +43,7 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
 
 | Property                                              | Type                                                                         | Description                                                                                                                                                                                                                                                                       | Defined in                                                                                                                                     |
 | ----------------------------------------------------- | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                   | `TActor`                                                                     | The actor instance with the currentView atom. It requires the Viewable capability.                                                                                                                                                                                                | [packages/play-view/src/view-types.ts:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L169) |
-| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../../../play-dom/type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry.                                                                                                                                             | [packages/play-view/src/view-types.ts:183](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L183) |
-| <a id="property-registryresult"></a> `registryResult` | `TRegistry`                                                                  | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.                                                                                                                                                                  | [packages/play-view/src/view-types.ts:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L171) |
-| <a id="property-store"></a> `store?`                  | `StateStore`                                                                 | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [packages/play-view/src/view-types.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L178) |
+| <a id="property-actor"></a> `actor`                   | `TActor`                                                                     | The actor instance with the currentView atom. It requires the Viewable capability.                                                                                                                                                                                                | [packages/play-view/src/view-types.ts:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-types.ts#L169) |
+| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../../../play-dom/type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry.                                                                                                                                             | [packages/play-view/src/view-types.ts:183](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-types.ts#L183) |
+| <a id="property-registryresult"></a> `registryResult` | `TRegistry`                                                                  | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.                                                                                                                                                                  | [packages/play-view/src/view-types.ts:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-types.ts#L171) |
+| <a id="property-store"></a> `store?`                  | `StateStore`                                                                 | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [packages/play-view/src/view-types.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-types.ts#L178) |

package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md

@@ -2,7 +2,7 @@
 
 # Interface: BaseViewContextValue\<TRegistry\>
 
-Defined in: [packages/play-view/src/view-types.ts:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L108)
+Defined in: [packages/play-view/src/view-types.ts:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-types.ts#L108)
 
 The framework-agnostic base of the `ViewContextValue` type in each framework.
 
@@ -28,7 +28,7 @@ same generic parameter as in `BaseActorProviderProps`.
 
 | Property                                  | Type                                  | Description                                                                                                            | Defined in                                                                                                                                     |
 | ----------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore.                                                             | [packages/play-view/src/view-types.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L112) |
-| <a id="property-registry"></a> `registry` | `TRegistry`                           | The component registry, from registryResult.registry.                                                                  | [packages/play-view/src/view-types.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L114) |
-| <a id="property-spec"></a> `spec`         | [`PlaySpec`](PlaySpec.md)             | The current PlaySpec to render.                                                                                        | [packages/play-view/src/view-types.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L110) |
-| <a id="property-store"></a> `store`       | `StateStore`                          | The active StateStore. Give it to JSONUIProvider or JsonUIProvider as `store`, and the providers then share the state. | [packages/play-view/src/view-types.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L118) |
+| <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore.                                                             | [packages/play-view/src/view-types.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-types.ts#L112) |
+| <a id="property-registry"></a> `registry` | `TRegistry`                           | The component registry, from registryResult.registry.                                                                  | [packages/play-view/src/view-types.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-types.ts#L114) |
+| <a id="property-spec"></a> `spec`         | [`PlaySpec`](PlaySpec.md)             | The current PlaySpec to render.                                                                                        | [packages/play-view/src/view-types.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-types.ts#L110) |
+| <a id="property-store"></a> `store`       | `StateStore`                          | The active StateStore. Give it to JSONUIProvider or JsonUIProvider as `store`, and the providers then share the state. | [packages/play-view/src/view-types.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-types.ts#L118) |

package/api/@xmachines/play-view/index/interfaces/FailureLatch.md

@@ -2,7 +2,7 @@
 
 # Interface: FailureLatch
 
-Defined in: [packages/play-view/src/failure-latch.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/failure-latch.ts#L174)
+Defined in: [packages/play-view/src/failure-latch.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/failure-latch.ts#L174)
 
 The record of what a provider reported. See [createFailureLatch](../functions/createFailureLatch.md).
 
@@ -14,7 +14,7 @@ The record of what a provider reported. See [createFailureLatch](../functions/cr
 clear(): void;
 ```
 
-Defined in: [packages/play-view/src/failure-latch.ts:191](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/failure-latch.ts#L191)
+Defined in: [packages/play-view/src/failure-latch.ts:191](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/failure-latch.ts#L191)
 
 Forgets the record, so the next failure reports again.
 
@@ -40,7 +40,7 @@ shouldReport(
 ): boolean;
 ```
 
-Defined in: [packages/play-view/src/failure-latch.ts:181](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/failure-latch.ts#L181)
+Defined in: [packages/play-view/src/failure-latch.ts:181](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/failure-latch.ts#L181)
 
 Answers whether a failure of these three inputs is new, and records it.
 

package/api/@xmachines/play-view/index/interfaces/PlaySpec.md

@@ -2,7 +2,7 @@
 
 # Interface: PlaySpec
 
-Defined in: [packages/play-view/src/view-types.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L32)
+Defined in: [packages/play-view/src/view-types.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-types.ts#L32)
 
 The XMachines extension of the `Spec` type of `@xmachines/json-render-core`.
 
@@ -23,4 +23,4 @@ spec reads only the paths that it needs.
 | <a id="property-elements"></a> `elements` | `public`   | `Record`\<`string`, `UIElement`\> | Flat map of elements by key                                                                                                                                                                                                                                                                                                                                  | `Spec.elements` | -                                                                                                                                            |
 | <a id="property-root"></a> `root`         | `public`   | `string`                          | Root element key                                                                                                                                                                                                                                                                                                                                             | `Spec.root`     | -                                                                                                                                            |
 | <a id="property-state"></a> `state?`      | `public`   | `Record`\<`string`, `unknown`\>   | Optional initial state to seed the state model. Components using statePath will read from / write to this state.                                                                                                                                                                                                                                             | `Spec.state`    | -                                                                                                                                            |
-| <a id="property-viewkey"></a> `viewKey?`  | `readonly` | `string`                          | The identity of the view of this derived spec. `deriveCurrentView` sets it from the meta entry that the derivation selected. A provider uses it as the key of its store lifecycle: a new `viewKey` seeds the store again, and the same `viewKey` refreshes `/context` in place, which keeps the ephemeral view state. Never write this field in `meta.view`. | -               | [packages/play-view/src/view-types.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L40) |
+| <a id="property-viewkey"></a> `viewKey?`  | `readonly` | `string`                          | The identity of the view of this derived spec. `deriveCurrentView` sets it from the meta entry that the derivation selected. A provider uses it as the key of its store lifecycle: a new `viewKey` seeds the store again, and the same `viewKey` refreshes `/context` in place, which keeps the ephemeral view state. Never write this field in `meta.view`. | -               | [packages/play-view/src/view-types.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-types.ts#L40) |