@xmachines/docs 7.0.0 → 8.0.0-next.1

package/api/@xmachines/play-vue-router/index/interfaces/PlayRouteEvent.md

@@ -2,7 +2,7 @@
 
 # Interface: PlayRouteEvent
 
-Defined in: [packages/play-router/src/types.ts:336](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L336)
+Defined in: [packages/play-router/src/types.ts:336](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L336)
 
 The routing event, with its parameters and its query
 
@@ -120,11 +120,11 @@ analysis of the pattern.
 
 ## Properties
 
-| Property                               | Modifier   | Type                                                                | Description                                                                                                                                                                                                                                                                              | Defined in                                                                                                                               |
-| -------------------------------------- | ---------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-data"></a> `data?`     | `readonly` | [`RouteData`](../../../play-router/index/type-aliases/RouteData.md) | The extra data that the SENDER of this event supplies: a router bridge, or the code of an application. It is not what the target state declares — that is [RouteObject.data](../../../play-router/index/interfaces/RouteObject.md#property-data), and a resolver there reads this field. | [packages/play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L346) |
-| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                                                           | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:347](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L347) |
-| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\>                                      | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:339](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L339) |
-| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\>                                      | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L340) |
-| <a id="property-to"></a> `to`          | `readonly` | `string`                                                            | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L338) |
-| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                                                      | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:337](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L337) |
+| Property                               | Modifier   | Type                                                                | Description                                                                                                                                                                                                                                                                              | Defined in                                                                                                                                           |
+| -------------------------------------- | ---------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-data"></a> `data?`     | `readonly` | [`RouteData`](../../../play-router/index/type-aliases/RouteData.md) | The extra data that the SENDER of this event supplies: a router bridge, or the code of an application. It is not what the target state declares — that is [RouteObject.data](../../../play-router/index/interfaces/RouteObject.md#property-data), and a resolver there reads this field. | [packages/play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L346) |
+| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                                                           | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:347](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L347) |
+| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\>                                      | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:339](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L339) |
+| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\>                                      | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L340) |
+| <a id="property-to"></a> `to`          | `readonly` | `string`                                                            | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L338) |
+| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                                                      | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:337](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L337) |

package/api/@xmachines/play-vue-router/index/interfaces/RoutableActor.md

@@ -2,7 +2,7 @@
 
 # Interface: RoutableActor
 
-Defined in: [packages/play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L392)
+Defined in: [packages/play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L392)
 
 The minimal actor interface that `RouterBridgeBase` and every framework router
 adapter require.
@@ -44,10 +44,10 @@ class MyBridge extends RouterBridgeBase {
 
 ## Properties
 
-| Property                                          | Modifier   | Type                                                                                  | Inherited from                                                                                                                                            | Defined in                                                                                                                               |
-| ------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`ReadonlyAtom`](../../../play-atom/interfaces/ReadonlyAtom.md)\<`string` \| `null`\> | [`Routable`](../../../play-router/index/interfaces/Routable.md).[`currentRoute`](../../../play-router/index/interfaces/Routable.md#property-currentroute) | [packages/play-router/src/types.ts:354](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L354) |
-| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                    | [`Routable`](../../../play-router/index/interfaces/Routable.md).[`initialRoute`](../../../play-router/index/interfaces/Routable.md#property-initialroute) | [packages/play-router/src/types.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L355) |
+| Property                                          | Modifier   | Type                                                                                  | Inherited from                                                                                                                                            | Defined in                                                                                                                                           |
+| ------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`ReadonlyAtom`](../../../play-atom/interfaces/ReadonlyAtom.md)\<`string` \| `null`\> | [`Routable`](../../../play-router/index/interfaces/Routable.md).[`currentRoute`](../../../play-router/index/interfaces/Routable.md#property-currentroute) | [packages/play-router/src/types.ts:354](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L354) |
+| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                    | [`Routable`](../../../play-router/index/interfaces/Routable.md).[`initialRoute`](../../../play-router/index/interfaces/Routable.md#property-initialroute) | [packages/play-router/src/types.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L355) |
 
 ## Methods
 
@@ -57,7 +57,7 @@ class MyBridge extends RouterBridgeBase {
 send(event): void;
 ```
 
-Defined in: [packages/play-router/src/types.ts:394](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L394)
+Defined in: [packages/play-router/src/types.ts:394](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L394)
 
 Sends a route navigation event to the actor.
 

package/api/@xmachines/play-vue-router/index/interfaces/RouteMapOptions.md

@@ -2,7 +2,7 @@
 
 # Interface: RouteMapOptions
 
-Defined in: [packages/play-router/src/types.ts:565](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L565)
+Defined in: [packages/play-router/src/types.ts:565](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L565)
 
 The options of `createRouteMap` and of `createRouteMapFromTree`.
 
@@ -12,8 +12,8 @@ The options of `createRouteMap` and of `createRouteMapFromTree`.
 
 ## Properties
 
-| Property                                             | Modifier   | Type                                                                                                                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Inherited from                                                                                                                                                                | Defined in                                                                                                                                                 |
-| ---------------------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-compiledcache"></a> `compiledCache?` | `readonly` | [`KeyValueCache`](../../../play-router/index/interfaces/KeyValueCache.md)\<[`URLPatternLike`](../../../play-router/index/type-aliases/URLPatternLike.md)\> | The cache of the COMPILED `URLPattern`, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass `{ get: () => undefined, set: () => {} }` to compile each time. A caller that passes `patternCache` for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern.                                                                                                                                                                                                                                                                                                                                                                       | [`CompileOptions`](../../../play-router/index/interfaces/CompileOptions.md).[`compiledCache`](../../../play-router/index/interfaces/CompileOptions.md#property-compiledcache) | [packages/play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-url/src/url-pattern-utils.ts#L119) |
-| <a id="property-pathcache"></a> `pathCache?`         | `public`   | [`KeyValueCache`](../../../play-router/index/interfaces/KeyValueCache.md)\<`string` \| `null`\>                                                            | The cache of the state that a VISITED PATH resolves to, or `null` for a path that resolves to none. The default is a cache of this map alone. It keeps two generations, and it holds 1001 entries at most. Pass one to raise that bound, to share the resolution across maps, or to give it an eviction policy of your own: `createLruCache(5000)` builds one, and so does any object with a `get` and a `set`. A cache that a caller passes is keyed by the ROUTE TABLE. Two maps built from the same mappings, in the same order, therefore read each other's answers — which is what a server that rebuilds its map for each request wants — and two maps built from different mappings never do, because a map with no route for a path writes `null` for it and a map that holds one must not read that. The keys are the paths that a visitor reaches, so the key space is unbounded: a cache with no bound of its own grows for the life of the process. | -                                                                                                                                                                             | [packages/play-router/src/types.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L584)                   |
-| <a id="property-patterncache"></a> `patternCache?`   | `readonly` | [`KeyValueCache`](../../../play-router/index/interfaces/KeyValueCache.md)\<[`ParsedPattern`](../../../play-router/index/interfaces/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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [`CompileOptions`](../../../play-router/index/interfaces/CompileOptions.md).[`patternCache`](../../../play-router/index/interfaces/CompileOptions.md#property-patterncache)   | [packages/play-pattern/src/cache.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-pattern/src/cache.ts#L41)                   |
+| Property                                             | Modifier   | Type                                                                                                                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Inherited from                                                                                                                                                                | Defined in                                                                                                                                                             |
+| ---------------------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-compiledcache"></a> `compiledCache?` | `readonly` | [`KeyValueCache`](../../../play-router/index/interfaces/KeyValueCache.md)\<[`URLPatternLike`](../../../play-router/index/type-aliases/URLPatternLike.md)\> | The cache of the COMPILED `URLPattern`, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass `{ get: () => undefined, set: () => {} }` to compile each time. A caller that passes `patternCache` for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern.                                                                                                                                                                                                                                                                                                                                                                       | [`CompileOptions`](../../../play-router/index/interfaces/CompileOptions.md).[`compiledCache`](../../../play-router/index/interfaces/CompileOptions.md#property-compiledcache) | [packages/play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-url/src/url-pattern-utils.ts#L119) |
+| <a id="property-pathcache"></a> `pathCache?`         | `public`   | [`KeyValueCache`](../../../play-router/index/interfaces/KeyValueCache.md)\<`string` \| `null`\>                                                            | The cache of the state that a VISITED PATH resolves to, or `null` for a path that resolves to none. The default is a cache of this map alone. It keeps two generations, and it holds 1001 entries at most. Pass one to raise that bound, to share the resolution across maps, or to give it an eviction policy of your own: `createLruCache(5000)` builds one, and so does any object with a `get` and a `set`. A cache that a caller passes is keyed by the ROUTE TABLE. Two maps built from the same mappings, in the same order, therefore read each other's answers — which is what a server that rebuilds its map for each request wants — and two maps built from different mappings never do, because a map with no route for a path writes `null` for it and a map that holds one must not read that. The keys are the paths that a visitor reaches, so the key space is unbounded: a cache with no bound of its own grows for the life of the process. | -                                                                                                                                                                             | [packages/play-router/src/types.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L584)                   |
+| <a id="property-patterncache"></a> `patternCache?`   | `readonly` | [`KeyValueCache`](../../../play-router/index/interfaces/KeyValueCache.md)\<[`ParsedPattern`](../../../play-router/index/interfaces/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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [`CompileOptions`](../../../play-router/index/interfaces/CompileOptions.md).[`patternCache`](../../../play-router/index/interfaces/CompileOptions.md#property-patterncache)   | [packages/play-pattern/src/cache.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-pattern/src/cache.ts#L41)                   |

package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md

@@ -2,7 +2,7 @@
 
 # Interface: RouteMapping
 
-Defined in: [packages/play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/base-route-map.ts#L58)
+Defined in: [packages/play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/base-route-map.ts#L58)
 
 One entry of the map between a state ID and a path.
 
@@ -22,7 +22,7 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
 
 ## Properties
 
-| Property                                | Modifier   | Type     | Description                                                                                      | Defined in                                                                                                                                               |
-| --------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-path"></a> `path`       | `readonly` | `string` | The pattern of the URL path, for example `"/"`, `"/profile/:userId"`, or `"/settings/:section?"` | [packages/play-router/src/base-route-map.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/base-route-map.ts#L62) |
-| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the state machine, for example `"home"` or `"#profile"`                          | [packages/play-router/src/base-route-map.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/base-route-map.ts#L60) |
+| Property                                | Modifier   | Type     | Description                                                                                      | Defined in                                                                                                                                                           |
+| --------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-path"></a> `path`       | `readonly` | `string` | The pattern of the URL path, for example `"/"`, `"/profile/:userId"`, or `"/settings/:section?"` | [packages/play-router/src/base-route-map.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/base-route-map.ts#L62) |
+| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the state machine, for example `"home"` or `"#profile"`                          | [packages/play-router/src/base-route-map.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/base-route-map.ts#L60) |

package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md

@@ -2,7 +2,7 @@
 
 # Interface: RouterBridge
 
-Defined in: [packages/play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L436)
+Defined in: [packages/play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L436)
 
 The RouterBridge interface of a runtime infrastructure adapter
 
@@ -54,7 +54,7 @@ class MyRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
 
-Defined in: [packages/play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L453)
+Defined in: [packages/play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L453)
 
 Connects the router bridge to the Actor
 
@@ -84,7 +84,7 @@ await bridge.connect();
 disconnect(): void | Promise<void>;
 ```
 
-Defined in: [packages/play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L469)
+Defined in: [packages/play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/types.ts#L469)
 
 Disconnects the router bridge from the Actor
 

package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md

@@ -109,7 +109,7 @@ const PlayRouterProvider: DefineComponent<
 >;
 ```
 
-Defined in: [packages/play-vue-router/src/play-router-provider.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-vue-router/src/play-router-provider.ts#L18)
+Defined in: [packages/play-vue-router/src/play-router-provider.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-vue-router/src/play-router-provider.ts#L18)
 
 PlayRouterProvider — the Vue wrapper of VueRouterBridge.
 

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

@@ -2,9 +2,9 @@
 
 # @xmachines/play-xstate
 
-> XState v5 adapter for the XMachines Play Architecture. It binds a state machine to the actor base, with atom-driven reactivity and a router integration.
+> XState v6 adapter for the XMachines Play Architecture. It binds a state machine to the actor base, with atom-driven reactivity and a router integration.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-7.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-xstate)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-8.0.0--next.1-blue)](https://www.npmjs.com/package/@xmachines/play-xstate)
 
 ---
 
@@ -16,7 +16,7 @@
 ## Installation
 
 ```bash
-pnpm add @xmachines/play-xstate @xmachines/core @xmachines/play @xmachines/play-atom xstate
+pnpm add @xmachines/play-xstate @xmachines/core @xmachines/play @xmachines/play-atom xstate@6.0.0-alpha.71
 ```
 
 **Peer dependencies.** Install them with the package:
@@ -24,7 +24,7 @@ pnpm add @xmachines/play-xstate @xmachines/core @xmachines/play @xmachines/play-
 - [`@xmachines/core`](../core/README.md) — the base package. This package reads the helpers of its `utils` subpath.
 - [`@xmachines/play`](../play/README.md) — the core protocol. This package reads the error classes from its `errors` subpath.
 - [`@xmachines/play-atom`](../play-atom/README.md) — the atom primitives. `PlayerActor` holds `currentView` and `currentRoute` as atoms.
-- `xstate` ^5.33.0 — the XState v5 runtime.
+- `xstate` 6.0.0-alpha.71 — the XState v6 runtime. The peer range names this one prerelease, because each alpha of XState 6 can change its API.
 
 **Optional peers.** Each capability subpath carries one. Install it when you read that subpath, and not before:
 
@@ -41,15 +41,17 @@ pnpm add @xmachines/play-view     # @xmachines/play-xstate/view
 ## Quick Start
 
 ```typescript
-import { setup } from "xstate";
+import { setup, types } from "xstate";
 import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
 import { withRouting } from "@xmachines/play-xstate/routing";
 
-// 1. Define your XState v5 machine
-const machine = setup({}).createMachine({
+// 1. Define your XState v6 machine. `schemas.meta` types the `meta` of each state.
+const machine = setup({
+	schemas: { meta: types<{ route?: string }>() },
+}).createMachine({
 	initial: "idle",
 	states: {
-		idle: { meta: { route: "/" }, on: { activate: "active" } },
+		idle: { meta: { route: "/" }, on: { activate: { target: "active" } } },
 		active: { meta: { route: "/active" } },
 	},
 });
@@ -77,16 +79,16 @@ actor.stop();
 
 ### `definePlayer(config)`
 
-This function creates a `PlayerFactory` from an XState v5 machine. One configuration can therefore make more than one independent actor instance. This helps with a multi-user application, with SSR, and with a test.
+This function creates a `PlayerFactory` from an XState v6 machine. One configuration can therefore make more than one independent actor instance. This helps with a multi-user application, with SSR, and with a test.
 
 ```typescript
-import { setup } from "xstate";
+import { setup, types } from "xstate";
 import { definePlayer } from "@xmachines/play-xstate";
 
 const machine = setup({
-	types: {
-		context: {} as { userId: string },
-		input: {} as { userId: string },
+	schemas: {
+		context: types<{ userId: string }>(),
+		input: types<{ userId: string }>(),
 	},
 }).createMachine({
 	context: ({ input }) => ({ userId: input.userId }),
@@ -102,7 +104,7 @@ const createPlayer = definePlayer({
 		onTransition: (actor, prev, next) => console.log("transitioned"),
 		onStateChange: (actor, state) => console.log("state changed"),
 		onError: (actor, err) => console.error(err),
-		inspect: (event) => console.log(event.type), // handed to XState's actor constructor — enables @statelyai/inspect
+		inspect: (event) => console.log(event.type), // handed to XState's actor constructor: "@xstate.actor" or "@xstate.transition"
 	},
 });
 
@@ -165,7 +167,7 @@ console.log(restored.currentRoute.get()); // same route as when saved
 
 ### `PlayerActor<TMachine>`
 
-This concrete actor class is an XState v5 actor that exposes reactive atoms. It holds the protocol of `PlayActor` and nothing else: `state` and `send`.
+This concrete actor class is an XState v6 actor that exposes reactive atoms. It holds the protocol of `PlayActor` and nothing else: `state` and `send`.
 
 #### Atoms
 
@@ -272,13 +274,13 @@ the path yourself, when you run work that belongs to a change of the route alone
 
 #### Methods
 
-| Method          | Description                                                               |
-| --------------- | ------------------------------------------------------------------------- |
-| `start()`       | Starts the actor and calls the `onStart` hook                             |
-| `stop()`        | Stops the actor, cleans up the subscriptions, and calls the `onStop` hook |
-| `send(event)`   | Sends a typed event to the machine and calls the `onTransition` hook      |
-| `can(event)`    | Returns `true` when the current state accepts the given event             |
-| `getSnapshot()` | Returns the current XState snapshot                                       |
+| Method          | Description                                                                                                                                           |
+| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `start()`       | Starts the actor and calls the `onStart` hook                                                                                                         |
+| `stop()`        | Stops the actor, cleans up the subscriptions, and calls the `onStop` hook                                                                             |
+| `send(event)`   | Sends a typed event to the machine and calls the `onTransition` hook. `send` is an accessor, as in XState 6, so `actor.send` passes on without a bind |
+| `can(event)`    | Returns `true` when the current state accepts the given event                                                                                         |
+| `getSnapshot()` | Returns the current XState snapshot                                                                                                                   |
 
 #### Atom usage example
 
@@ -304,32 +306,30 @@ stop();
 
 ### Guards
 
-This package gives no guard utility. Compose a guard with the `and()`, `or()` and `not()` combinators of XState:
+This package gives no guard utility. XState 6 has no guard combinators: a transition function is the guard. It calls each named guard of `setup()` through its `guards` argument, and it combines them with `&&`, `||` and `!`. A transition function that returns `undefined` leaves the event unhandled:
 
 ```typescript
-import { and, not, setup } from "xstate";
+import { setup, types } from "xstate";
 
 const machine = setup({
-	types: {
-		context: {} as { userId: string; role: string },
-		events: {} as { type: "accessAdmin" } | { type: "accessLogin" },
+	schemas: {
+		context: types<{ userId: string; role: string }>(),
+		events: { accessAdmin: types<void>(), accessLogin: types<void>() },
 	},
 	guards: {
-		isLoggedIn: ({ context }) => context.userId !== "",
-		hasAdminRole: ({ context }) => context.role === "admin",
+		isLoggedIn: (userId: string) => userId !== "",
+		hasAdminRole: (role: string) => role === "admin",
 	},
 }).createMachine({
 	context: { userId: "", role: "guest" },
 	initial: "home",
 	on: {
-		accessAdmin: {
-			guard: and(["isLoggedIn", "hasAdminRole"]),
-			target: ".adminPanel",
-		},
-		accessLogin: {
-			guard: not("isLoggedIn"),
-			target: ".login",
-		},
+		accessAdmin: ({ context, guards }) =>
+			guards.isLoggedIn(context.userId) && guards.hasAdminRole(context.role)
+				? { target: ".adminPanel" }
+				: undefined,
+		accessLogin: ({ context, guards }) =>
+			guards.isLoggedIn(context.userId) ? undefined : { target: ".login" },
 	},
 	states: {
 		home: {},
@@ -339,9 +339,9 @@ const machine = setup({
 });
 ```
 
-A combinator resolves each name against the `guards` of `setup()`. A name that the map does not hold therefore fails to compile, and it names the fault: `Type '"typoGuardName"' is not assignable to type '"isLoggedIn"'`.
+A name that the `guards` map does not hold fails to compile.
 
-`composeGuards`, `composeGuardsOr`, `negateGuard`, `hasContext`, `eventMatches` and `contextFieldMatches` stood here before. They closed two gaps of the types of XState 5.28. The peer floor of this package is `^5.33.0`, and 5.33 holds neither gap. The helpers also fitted a guard slot that `setup()` types never: the example of this package reached them through an `as never` cast. Write the combinator instead, and write a plain predicate in place of each helper.
+`composeGuards`, `composeGuardsOr`, `negateGuard`, `hasContext`, `eventMatches` and `contextFieldMatches` stood here before. They closed two gaps of the types of XState 5.28. XState 6 removed the combinators that they wrapped. Write a plain predicate in place of each helper.
 
 ---
 
@@ -353,9 +353,11 @@ These helper functions configure the routes of an XState machine declaratively.
 
 This function reads each machine state that has a `meta.route` field. It then generates the `play.route` event handlers at the root level. You therefore write no repetitive routing transition.
 
+Each generated transition is a config object, and not a function. Its `matches: { to: "#<id>" }` field selects the `play.route` event for the state, and its `context` field writes the `params`, the `query` and the `data` of the route into the context, as a patch. A graph of the machine therefore still sees the target of each route. The `play.route` entry of the result is a list: the generated transitions first, then the `play.route` transition of the machine, which is the fallback. The config types of XState 6 declare one transition for each event, and its runtime reads a list in its order.
+
 ```typescript
-import { setup } from "xstate";
-import { formatPlayRouteTransitions } from "@xmachines/play-xstate/routing";
+import { setup, types } from "xstate";
+import { formatPlayRouteTransitions, type RouteMetadata } from "@xmachines/play-xstate/routing";
 
 const config = formatPlayRouteTransitions({
 	id: "app",
@@ -373,8 +375,10 @@ const config = formatPlayRouteTransitions({
 });
 
 // config now includes auto-generated play.route handlers:
-// on: { "play.route": [ { target: ".home", guard: e => e.to === "#home" }, ... ] }
-const machine = setup({}).createMachine(config);
+// on: { "play.route": [ { target: ".home", matches: { to: "#home" }, context: ... }, ... ] }
+const machine = setup({
+	schemas: { meta: types<{ route?: RouteMetadata }>() },
+}).createMachine(config);
 ```
 
 > **Note:** every state with a `meta.route` field must also have an explicit `id` field. A state without an `id` field throws `MissingStateIdError` when you define the machine.
@@ -413,20 +417,28 @@ declare const machine: AnyStateMachine; // your machine
 ## Inspection
 
 The factory gives `options.inspect` to `createActor` of XState without a change.
-Therefore every XState inspection tool works with a `PlayerActor`, and this
-includes [`@statelyai/inspect`](https://stately.ai/docs/inspector):
+Therefore every tool that reads the inspection events of XState 6 works with a
+`PlayerActor`. XState 6 emits two events: `@xstate.actor` for each new actor, and
+`@xstate.transition` for each transition, with its event and its snapshot:
 
 ```typescript
-import { createBrowserInspector } from "@statelyai/inspect";
 import { definePlayer } from "@xmachines/play-xstate";
-import type { AnyStateMachine } from "xstate";
+import type { AnyStateMachine, InspectionEvent } from "xstate";
 
 declare const machine: AnyStateMachine; // your machine
 
-const { inspect } = createBrowserInspector();
+const inspect = (event: InspectionEvent): void => {
+	if (event.type === "@xstate.transition") {
+		console.log(event.event.type, event.snapshot.status);
+	}
+};
 const createPlayer = definePlayer({ machine, options: { inspect } });
 ```
 
+`@statelyai/inspect` 0.7 does not load beside XState 6: it imports `toObserver`, which
+XState 6 no longer exports. The [inspector guide](../../../guides/inspector.md) shows how a
+demo of this repository converts the events for the Stately inspector itself.
+
 Three points are important:
 
 - **`inspect` is an option of the factory, not of one instance.** Every actor of a
@@ -446,7 +458,7 @@ For an inspector that you create after the factory, such as a dev-tools switch,
 factory a function that forwards each event: `inspect: (event) => currentInspector?.(event)`.
 
 The [inspector guide](../../../guides/inspector.md) gives the complete procedure: a late
-attachment with a replay, a WebSocket inspection without a browser, and the points to
+attachment with a replay, an inspection without a browser, and the points to
 consider in production.
 
 ---
@@ -502,7 +514,7 @@ meta: {
 		// and the target still runs its exit and its entry actions. `handler` is the
 		// field that spares those intermediate ancestors.
 		reenter: false,
-		// The extra data of the route. The generated transition assigns it to
+		// The extra data of the route. The generated transition writes it to
 		// `context.data`. A literal value, or a function of { context, event }.
 		data: { titleKey: "doc.view" },
 	},
@@ -518,8 +530,7 @@ An unknown `handler` value throws `InvalidRouteHandlerError` at the format time.
 > active. A route to the ROOT of the machine is the one exception: the root is then the
 > target and the domain, so the root runs those actions only under `reenter: true`.
 
-The `data` field follows the `WithDynamicParams` shape of XState, so the function form
-reads the context and the event:
+The function form of the `data` field reads the context and the event:
 
 ```typescript fragment
 data: ({ context, event }) => ({ title: `Document ${event.params?.docId}` });

package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md

@@ -2,7 +2,7 @@
 
 # Class: ActorThrewNonErrorError
 
-Defined in: [packages/play-xstate/src/errors.ts:309](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/errors.ts#L309)
+Defined in: [packages/play-xstate/src/errors.ts:309](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/errors.ts#L309)
 
 The actor gives this error to `PlayerOptions.onError` when it failed with a value
 that is not an `Error`, for example after a machine action ran
@@ -46,7 +46,7 @@ definePlayer({
 new ActorThrewNonErrorError(value): ActorThrewNonErrorError;
 ```
 
-Defined in: [packages/play-xstate/src/errors.ts:310](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/errors.ts#L310)
+Defined in: [packages/play-xstate/src/errors.ts:310](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/errors.ts#L310)
 
 #### Parameters
 
@@ -64,15 +64,15 @@ Defined in: [packages/play-xstate/src/errors.ts:310](https://gitlab.com/xmachin-
 
 ## Properties
 
-| 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 `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code 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/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/core/src/errors.ts#L56) |
-| <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-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/core/src/errors.ts#L46) |
-| <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) | -                                                                                                                          |
+| 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 `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code 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/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/core/src/errors.ts#L56) |
+| <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-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/core/src/errors.ts#L46) |
+| <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) | -                                                                                                                                      |
 
 ## Methods