@xmachines/docs 6.1.0 → 8.0.0-next.1

package/api/@xmachines/play-xstate/index/classes/PlayerActor.md

@@ -2,12 +2,12 @@
 
 # Class: PlayerActor\<TMachine\>
 
-Defined in: [packages/play-xstate/src/player-actor.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L144)
+Defined in: [packages/play-xstate/src/player-actor.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/player-actor.ts#L151)
 
 The concrete XState actor. It implements the atom protocol of the Play Architecture
 
 The class extends the `Actor` class of XState directly, and it implements
-[@xmachines/play-actor!PlayActor](../../../play-actor/interfaces/PlayActor.md). It gives you the XState v5 integration, and it keeps the
+[@xmachines/play-actor!PlayActor](../../../play-actor/interfaces/PlayActor.md). It gives you the XState v6 integration, and it keeps the
 compatibility with the ecosystem, such as the XState inspection and the devtools.
 The constructor of the base class receives the machine. Therefore a `PlayerActor`
 **is** the XState actor, and it is no wrapper around one: every member of the
@@ -30,10 +30,15 @@ change goes through the event handlers of the state machine.
 The creation of an actor, and its lifecycle
 
 ```typescript
-import { setup } from "xstate";
+import { setup, types } from "xstate";
+import type { ViewMeta } from "@xmachines/play-view";
 import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
+import { withRouting } from "@xmachines/play-xstate/routing";
+import { withView } from "@xmachines/play-xstate/view";
 
-const machine = setup({}).createMachine({
+const machine = setup({
+	schemas: { meta: types<{ route?: string; view?: ViewMeta }>() },
+}).createMachine({
 	initial: "idle",
 	states: {
 		idle: {
@@ -49,7 +54,10 @@ const machine = setup({}).createMachine({
 	},
 });
 
-const createPlayer = definePlayer({ machine });
+const createPlayer = definePlayer({
+	machine,
+	actor: compose(PlayerActor, withRouting, withView),
+});
 const actor = createPlayer();
 actor.start();
 
@@ -102,11 +110,11 @@ memoizes the result, so a repeated read computes no view again.
 
 | Type Parameter                                                                                 | Description                             |
 | ---------------------------------------------------------------------------------------------- | --------------------------------------- |
-| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The type of the XState v5 state machine |
+| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The type of the XState v6 state machine |
 
 ## Implements
 
-- [`PlayActor`](../../../play-actor/interfaces/PlayActor.md)\<`ReturnType`\<`TMachine`\[`"transition"`\]\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TMachine`\>\>
+- [`PlayActor`](../../../play-actor/interfaces/PlayActor.md)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\>, `SendableEventFromLogic`\<`TMachine`\>\>
 
 ## Constructors
 
@@ -121,16 +129,16 @@ new PlayerActor<TMachine>(
 ): PlayerActor<TMachine>;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:242](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L242)
+Defined in: [packages/play-xstate/src/player-actor.ts:247](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/player-actor.ts#L247)
 
 #### Parameters
 
-| Parameter           | Type                                                                        |
-| ------------------- | --------------------------------------------------------------------------- |
-| `machine`           | `TMachine`                                                                  |
-| `options`           | [`PlayerOptions`](../interfaces/PlayerOptions.md)\<`TMachine`\>             |
-| `input?`            | [`InputFrom`](https://www.jsdocs.io/package/xstate#InputFrom)\<`TMachine`\> |
-| `restoredSnapshot?` | [`Snapshot`](https://www.jsdocs.io/package/xstate#Snapshot)\<`unknown`\>    |
+| Parameter           | Type                                                                                               |
+| ------------------- | -------------------------------------------------------------------------------------------------- |
+| `machine`           | `TMachine`                                                                                         |
+| `options`           | [`PlayerOptions`](../interfaces/PlayerOptions.md)\<`TMachine`\>                                    |
+| `input?`            | [`InputFrom`](https://www.jsdocs.io/package/xstate#InputFrom)\<`TMachine`\>                        |
+| `restoredSnapshot?` | Snapshot\<unknown, unknown\> & Partial\<RestorablePersistedSnapshotFor\<DoNotInfer\<TMachine\>\>\> |
 
 #### Returns
 
@@ -144,19 +152,122 @@ Actor<TMachine>.constructor
 
 ## Properties
 
-| Property                                    | Modifier | Type                                                                                                                                                                                                                                                                                                                     | Description                                                                                                                                                                                             | Inherited from    | Defined in                                                                                                                                             |
-| ------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-_parent"></a> `_parent?`    | `public` | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef)                                                                                                                                                                                                                                                        | -                                                                                                                                                                                                       | `Actor._parent`   | -                                                                                                                                                      |
-| <a id="property-clock"></a> `clock`         | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock)                                                                                                                                                                                                                                                                    | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions.                                                                                                | `Actor.clock`     | -                                                                                                                                                      |
-| <a id="property-id"></a> `id`               | `public` | `string`                                                                                                                                                                                                                                                                                                                 | The unique identifier for this actor relative to its parent.                                                                                                                                            | `Actor.id`        | -                                                                                                                                                      |
-| <a id="property-logic"></a> `logic`         | `public` | `TMachine`                                                                                                                                                                                                                                                                                                               | -                                                                                                                                                                                                       | `Actor.logic`     | -                                                                                                                                                      |
-| <a id="property-options"></a> `options`     | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\>                                                                                                                                                                                                                            | -                                                                                                                                                                                                       | `Actor.options`   | -                                                                                                                                                      |
-| <a id="property-ref"></a> `ref`             | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TMachine`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TMachine`\>\> | -                                                                                                                                                                                                       | `Actor.ref`       | -                                                                                                                                                      |
-| <a id="property-sessionid"></a> `sessionId` | `public` | `string`                                                                                                                                                                                                                                                                                                                 | The globally unique process ID for this invocation.                                                                                                                                                     | `Actor.sessionId` | -                                                                                                                                                      |
-| <a id="property-src"></a> `src`             | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)                                                                                                                                                                                                                                     | -                                                                                                                                                                                                       | `Actor.src`       | -                                                                                                                                                      |
-| <a id="property-state"></a> `state`         | `public` | [`Atom`](../../../play-atom/interfaces/Atom.md)\<`ReturnType`\<`TMachine`\[`"transition"`\]\>\>                                                                                                                                                                                                                          | The reactive snapshot of the current actor state. The infrastructure observes this atom, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | -                 | [packages/play-xstate/src/player-actor.ts:208](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L208) |
-| <a id="property-system"></a> `system`       | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem)                                                                                                                                                                                                                                                  | The system to which this actor belongs.                                                                                                                                                                 | `Actor.system`    | -                                                                                                                                                      |
-| <a id="property-systemid"></a> `systemId`   | `public` | `string` \| `undefined`                                                                                                                                                                                                                                                                                                  | -                                                                                                                                                                                                       | `Actor.systemId`  | -                                                                                                                                                      |
+| Property                                        | Modifier | Type                                                                                                                                                                                                                                                                                                                                                             | Description                                                                                                                                                                                             | Inherited from      | Defined in                                                                                                                                                         |
+| ----------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-_parent"></a> `_parent?`        | `public` | `AnyActor`                                                                                                                                                                                                                                                                                                                                                       | -                                                                                                                                                                                                       | `Actor._parent`     | -                                                                                                                                                                  |
+| <a id="property-clock"></a> `clock`             | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock)                                                                                                                                                                                                                                                                                                            | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions.                                                                                                | `Actor.clock`       | -                                                                                                                                                                  |
+| <a id="property-id"></a> `id`                   | `public` | `string`                                                                                                                                                                                                                                                                                                                                                         | The unique identifier for this actor relative to its parent.                                                                                                                                            | `Actor.id`          | -                                                                                                                                                                  |
+| <a id="property-logic"></a> `logic`             | `public` | `TMachine`                                                                                                                                                                                                                                                                                                                                                       | -                                                                                                                                                                                                       | `Actor.logic`       | -                                                                                                                                                                  |
+| <a id="property-options"></a> `options`         | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\>                                                                                                                                                                                                                                                                    | -                                                                                                                                                                                                       | `Actor.options`     | -                                                                                                                                                                  |
+| <a id="property-ref"></a> `ref`                 | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TMachine`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TMachine`\>, `SendableEventFromLogic`\<`TMachine`\>\> | -                                                                                                                                                                                                       | `Actor.ref`         | -                                                                                                                                                                  |
+| <a id="property-registrykey"></a> `registryKey` | `public` | `string` \| `undefined`                                                                                                                                                                                                                                                                                                                                          | Registry key used by the actor system receptionist.                                                                                                                                                     | `Actor.registryKey` | -                                                                                                                                                                  |
+| <a id="property-sessionid"></a> `sessionId`     | `public` | `string`                                                                                                                                                                                                                                                                                                                                                         | The globally unique process ID for this invocation.                                                                                                                                                     | `Actor.sessionId`   | -                                                                                                                                                                  |
+| <a id="property-src"></a> `src`                 | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)                                                                                                                                                                                                                                                                             | -                                                                                                                                                                                                       | `Actor.src`         | -                                                                                                                                                                  |
+| <a id="property-state"></a> `state`             | `public` | [`Atom`](../../../play-atom/interfaces/Atom.md)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\>\>                                                                                                                                                                                                                             | The reactive snapshot of the current actor state. The infrastructure observes this atom, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | -                   | [packages/play-xstate/src/player-actor.ts:215](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/player-actor.ts#L215) |
+| <a id="property-system"></a> `system`           | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem)                                                                                                                                                                                                                                                                                          | The system to which this actor belongs.                                                                                                                                                                 | `Actor.system`      | -                                                                                                                                                                  |
+
+## Accessors
+
+### address
+
+#### Get Signature
+
+```ts
+get address(): string;
+```
+
+Defined in: `xstate`
+
+The deterministic logical address of this actor within its system: the
+`/`-joined path of actor ids from the root. Stable across persistence and
+restore, unlike `sessionId`, which identifies one incarnation.
+
+`/` separates segments, so an id containing one (a state name with a
+slash reaches its invoked child's id) is percent-encoded to keep the
+path unambiguous.
+
+##### Returns
+
+`string`
+
+#### Inherited from
+
+```ts
+Actor.address;
+```
+
+---
+
+### send
+
+#### Get Signature
+
+```ts
+get send(): (event) => void;
+```
+
+Defined in: [packages/play-xstate/src/player-actor.ts:441](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/player-actor.ts#L441)
+
+The function that sends an event to this actor.
+
+The guards of the state machine of the actor decide if the event causes a
+transition. Give any public event of the machine: a domain event, a routing event,
+and so on.
+
+XState 6 declares `send` as an ACCESSOR that returns a bound function, so that a
+caller can pass `actor.send` on without a bind. This class keeps that shape: the
+accessor returns one bound function for each actor, and that function runs the
+hooks around the delivery.
+
+The returned function throws an [InvalidEventError](../../errors/classes/InvalidEventError.md) when `event` is not a
+plain object, for example `null`, `undefined`, a string, or a number. Import the
+class from `@xmachines/play-xstate/errors`.
+
+##### Example
+
+```typescript
+// A domain event, with the type of the public event map of the machine
+actor.send({ type: "auth.login", userId: "123" });
+
+// A routing event
+actor.send({ type: "play.route", to: "#home" });
+```
+
+##### Returns
+
+(`event`) => `void`
+
+#### Implementation of
+
+[`PlayActor`](../../../play-actor/interfaces/PlayActor.md).[`send`](../../../play-actor/interfaces/PlayActor.md#send)
+
+#### Overrides
+
+```ts
+Actor.send;
+```
+
+---
+
+### trigger
+
+#### Get Signature
+
+```ts
+get trigger(): ActorTrigger<SendableEventFromLogic<TLogic>>;
+```
+
+Defined in: `xstate`
+
+##### Returns
+
+`ActorTrigger`\<`SendableEventFromLogic`\<`TLogic`\>\>
+
+#### Inherited from
+
+```ts
+Actor.trigger;
+```
 
 ## Methods
 
@@ -186,7 +297,7 @@ Actor.[observable]
 can(event): boolean;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L221)
+Defined in: [packages/play-xstate/src/player-actor.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/player-actor.ts#L228)
 
 Tells you if the current state of the actor accepts the given event.
 
@@ -195,9 +306,9 @@ compile error. The method evaluates the event against the snapshot atom.
 
 #### Parameters
 
-| Parameter | Type                                                                                  |
-| --------- | ------------------------------------------------------------------------------------- |
-| `event`   | [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TMachine`\> |
+| Parameter | Type                                   |
+| --------- | -------------------------------------- |
+| `event`   | `SendableEventFromLogic`\<`TMachine`\> |
 
 #### Returns
 
@@ -214,27 +325,39 @@ if (actor.can({ type: "auth.logout" })) { ... }
 ### getPersistedSnapshot()
 
 ```ts
-getPersistedSnapshot(options?): Snapshot<unknown>;
+getPersistedSnapshot(options?): PersistedSnapshotOf<TMachine>;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:555](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L555)
-
-Returns the persisted snapshot of this actor.
+Defined in: `xstate`
 
-Use it to serialize the state, and to restore it later with the
-`restore.snapshot` option of the factory.
+Obtain the internal state of the actor, which can be persisted.
 
 #### Parameters
 
-| Parameter  | Type      |
-| ---------- | --------- |
-| `options?` | `unknown` |
+| Parameter                | Type                               | Description                                                                                                                                                                                                                                   |
+| ------------------------ | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `options?`               | \{ `embedChildren?`: `boolean`; \} | -                                                                                                                                                                                                                                             |
+| `options.embedChildren?` | `boolean`                          | Whether persisted machine children embed their own persisted state (the co-locating runtime's whole-tree checkpoint) or are referenced by logical address only, leaving each child's state with the runtime that owns it. Defaults to `true`. |
 
 #### Returns
 
-[`Snapshot`](https://www.jsdocs.io/package/xstate#Snapshot)\<`unknown`\>
+`PersistedSnapshotOf`\<`TMachine`\>
 
-#### Overrides
+#### Remarks
+
+The internal state can be persisted from any actor, not only machines.
+
+Note that the persisted state is not the same as the snapshot from
+[Actor.getSnapshot](#getsnapshot). Persisted state represents the internal state of
+the actor, while snapshots represent the actor's last emitted value.
+
+Can be restored with [ActorOptions.snapshot](https://www.jsdocs.io/package/xstate#ActorOptions.snapshot)
+
+#### See
+
+https://stately.ai/docs/persistence
+
+#### Inherited from
 
 ```ts
 Actor.getPersistedSnapshot;
@@ -258,18 +381,24 @@ Read an actor’s snapshot synchronously.
 
 #### Remarks
 
-The snapshot represent an actor's last emitted value.
+The snapshot is the last value the actor published, not a query of its
+private state: the actor emits a snapshot when it transitions, and this
+returns that cached last emission. The read is coherent within one
+synchronous transition turn because event processing runs to completion;
+across asynchronous boundaries it may be stale, like any observed value.
 
-When an actor receives an event, its internal state may change. An actor
-may emit a snapshot when a state transition occurs.
+Only co-located actors publish full snapshots. A location-transparent
+remote handle exposes lifecycle only ({ status, output?, error? }): while
+the handle exists among its parent's children the child is presumed
+`active`, and its terminal result arrives as a completion event.
 
 Note that some actors, such as callback actors generated with
-`fromCallback`, will not emit snapshots.
+`createCallbackLogic`, will not emit snapshots.
 
 #### See
 
 - [Actor.subscribe](https://www.jsdocs.io/package/xstate#Actor.subscribe) to subscribe to an actor’s snapshot values.
-- [Actor.getPersistedSnapshot](https://www.jsdocs.io/package/xstate#Actor.getPersistedSnapshot) to persist the internal state of an actor (which is more than just a snapshot).
+- [Actor.getPersistedSnapshot](#getpersistedsnapshot) to persist the internal state of an actor (which is more than just a snapshot).
 
 #### Inherited from
 
@@ -289,9 +418,9 @@ Defined in: `xstate`
 
 #### Type Parameters
 
-| Type Parameter          |
-| ----------------------- |
-| `TType` _extends_ `any` |
+| Type Parameter             |
+| -------------------------- |
+| `TType` _extends_ `string` |
 
 #### Parameters
 
@@ -345,73 +474,22 @@ Actor.select;
 
 ---
 
-### send()
-
-```ts
-send(event): void;
-```
-
-Defined in: [packages/play-xstate/src/player-actor.ts:432](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L432)
-
-Sends an event to this actor.
-
-The guards of the state machine of the actor decide if the event causes a
-transition. Give any event of the event union of the machine: a domain event, a
-routing event, and so on.
-
-#### Parameters
-
-| Parameter | Type                                                                                  | Description                                                      |
-| --------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
-| `event`   | [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TMachine`\> | An event of the `EventFromLogic<TMachine>` union of the machine. |
-
-#### Returns
-
-`void`
-
-#### Throws
-
-When `event` is not a plain object, for example
-`null`, `undefined`, a string, or a number. Import the class from
-`@xmachines/play-xstate/errors`.
-
-#### Example
-
-```typescript
-// A domain event, with the type of the event union of the machine
-actor.send({ type: "auth.login", userId: "123" });
-
-// A routing event
-actor.send({ type: "play.route", to: "#home" });
-```
-
-#### Implementation of
-
-[`PlayActor`](../../../play-actor/interfaces/PlayActor.md).[`send`](../../../play-actor/interfaces/PlayActor.md#send)
-
-#### Overrides
-
-```ts
-Actor.send;
-```
-
----
-
 ### start()
 
 ```ts
 start(): this;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L358)
+Defined in: [packages/play-xstate/src/player-actor.ts:363](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/player-actor.ts#L363)
 
 Starts the actor.
 
-The method fires `onStart` on each real start, which is every transition from
-"not running" to "running". A start after a stop is such a transition, and XState
-permits it: its own `start()` stops only while the actor RUNS already. A second
-call while the actor runs fires no hook. Therefore a defensive double mount runs
-the side effects of `onStart` one time for one real start.
+The method fires `onStart` on the real start, which is the transition from "not
+started" to "running". A second call while the actor runs fires no hook. Therefore
+a defensive double mount runs the side effects of `onStart` one time.
+
+XState 6 starts an actor one time only. A `start()` after a `stop()` throws, and it
+fires no hook: create a new actor from the factory instead.
 
 #### Returns
 
@@ -431,16 +509,17 @@ Actor.start;
 stop(): this;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:388](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L388)
+Defined in: [packages/play-xstate/src/player-actor.ts:394](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/player-actor.ts#L394)
 
 Stops the actor and cleans up.
 
-The method fires `onStop` only when the actor ran. This matches XState, where a
-stop of an actor that never started, or of an actor that stopped already, does
-nothing and tears nothing down. Therefore the paired cleanup runs never two
-times, and it runs never against a resource that `onStart` did not take. A stop
-does not close the actor for ever: a later `start()` is a new lifecycle, and it
-fires `onStart` again.
+The method fires `onStop` only when the actor ran. A stop of an actor that never
+started, or of an actor that stopped already, fires no hook. Therefore the paired
+cleanup runs never two times, and it runs never against a resource that `onStart`
+did not take.
+
+A stop closes the actor for ever: XState 6 refuses a later `start()`, also after a
+stop that came before the first start.
 
 #### Returns
 
@@ -462,7 +541,7 @@ Actor.stop;
 subscribe(observer): Subscription;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:493](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L493)
+Defined in: [packages/play-xstate/src/player-actor.ts:515](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/player-actor.ts#L515)
 
 Subscribes to the snapshot updates of this actor.
 
@@ -496,7 +575,7 @@ subscribe(
 ): Subscription;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:504](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L504)
+Defined in: [packages/play-xstate/src/player-actor.ts:526](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/player-actor.ts#L526)
 
 Subscribes to the snapshot updates of this actor.
 
@@ -527,19 +606,17 @@ Actor.subscribe;
 ### toJSON()
 
 ```ts
-toJSON(): object;
+toJSON(): SerializedActorRef;
 ```
 
 Defined in: `xstate`
 
-#### Returns
+Returns the actor's serializable logical identity: `{ $actor: address }`.
+The result can be used as an `enq.sendTo(...)` target.
 
-`object`
+#### Returns
 
-| Name           | Type     | Defined in |
-| -------------- | -------- | ---------- |
-| `id`           | `string` | -          |
-| `xstate$$type` | `number` | -          |
+`SerializedActorRef`
 
 #### Inherited from
 

package/api/@xmachines/play-xstate/index/functions/compose.md

@@ -8,7 +8,7 @@
 function compose<TMachine>(Base): PlayerConstructor<TMachine>;
 ```
 
-Defined in: [packages/play-xstate/src/capabilities.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/capabilities.ts#L103)
+Defined in: [packages/play-xstate/src/capabilities.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/capabilities.ts#L103)
 
 Builds an actor class from a base and a list of capabilities.
 
@@ -59,7 +59,7 @@ applies them from left to right.
 function compose<TMachine, TC1>(Base, c1): PlayerConstructor<TMachine, TC1>;
 ```
 
-Defined in: [packages/play-xstate/src/capabilities.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/capabilities.ts#L106)
+Defined in: [packages/play-xstate/src/capabilities.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/capabilities.ts#L106)
 
 Builds an actor class from a base and a list of capabilities.
 
@@ -112,7 +112,7 @@ applies them from left to right.
 function compose<TMachine, TC1, TC2>(Base, c1, c2): PlayerConstructor<TMachine, TC1 & TC2>;
 ```
 
-Defined in: [packages/play-xstate/src/capabilities.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/capabilities.ts#L110)
+Defined in: [packages/play-xstate/src/capabilities.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/capabilities.ts#L110)
 
 Builds an actor class from a base and a list of capabilities.
 
@@ -172,7 +172,7 @@ function compose<TMachine, TC1, TC2, TC3>(
 ): PlayerConstructor<TMachine, TC1 & TC2 & TC3>;
 ```
 
-Defined in: [packages/play-xstate/src/capabilities.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/capabilities.ts#L115)
+Defined in: [packages/play-xstate/src/capabilities.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/capabilities.ts#L115)
 
 Builds an actor class from a base and a list of capabilities.
 

package/api/@xmachines/play-xstate/index/functions/definePlayer.md

@@ -8,11 +8,11 @@
 function definePlayer<TMachine>(config): PlayerFactory<TMachine>;
 ```
 
-Defined in: [packages/play-xstate/src/define-player.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/define-player.ts#L62)
+Defined in: [packages/play-xstate/src/define-player.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/define-player.ts#L64)
 
 Creates a player factory from an XState machine
 
-This factory function accepts an XState v5 machine. It returns a function that
+This factory function accepts an XState v6 machine. It returns a function that
 makes [PlayerActor](../classes/PlayerActor.md) instances. One configuration can therefore make more
 than one actor instance, and this helps with a test, with an application of
 several instances, and with a render on the server.
@@ -21,7 +21,7 @@ several instances, and with a render on the server.
 
 | Type Parameter                                                                                 | Description                             |
 | ---------------------------------------------------------------------------------------------- | --------------------------------------- |
-| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The type of the XState v5 state machine |
+| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The type of the XState v6 state machine |
 
 ### Parameters
 
@@ -40,10 +40,12 @@ The factory function. It makes an actor instance, with an optional input context
 A basic player factory
 
 ```typescript
-import { setup } from "xstate";
+import { setup, types } from "xstate";
 import { definePlayer } from "@xmachines/play-xstate";
 
-const machine = setup({}).createMachine({
+const machine = setup({
+	schemas: { meta: types<{ route?: string }>() },
+}).createMachine({
 	initial: "idle",
 	states: {
 		idle: { meta: { route: "/" } },
@@ -85,11 +87,11 @@ console.log(alice.state.get() !== bob.state.get());
 function definePlayer<TMachine, TCapabilities>(config): PlayerFactory<TMachine, TCapabilities>;
 ```
 
-Defined in: [packages/play-xstate/src/define-player.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/define-player.ts#L65)
+Defined in: [packages/play-xstate/src/define-player.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-xstate/src/define-player.ts#L67)
 
 Creates a player factory from an XState machine
 
-This factory function accepts an XState v5 machine. It returns a function that
+This factory function accepts an XState v6 machine. It returns a function that
 makes [PlayerActor](../classes/PlayerActor.md) instances. One configuration can therefore make more
 than one actor instance, and this helps with a test, with an application of
 several instances, and with a render on the server.
@@ -98,7 +100,7 @@ several instances, and with a render on the server.
 
 | Type Parameter                                                                                 | Description                             |
 | ---------------------------------------------------------------------------------------------- | --------------------------------------- |
-| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The type of the XState v5 state machine |
+| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The type of the XState v6 state machine |
 | `TCapabilities` _extends_ `object`                                                             | -                                       |
 
 ### Parameters
@@ -118,10 +120,12 @@ The factory function. It makes an actor instance, with an optional input context
 A basic player factory
 
 ```typescript
-import { setup } from "xstate";
+import { setup, types } from "xstate";
 import { definePlayer } from "@xmachines/play-xstate";
 
-const machine = setup({}).createMachine({
+const machine = setup({
+	schemas: { meta: types<{ route?: string }>() },
+}).createMachine({
 	initial: "idle",
 	states: {
 		idle: { meta: { route: "/" } },