@xmachines/docs 3.0.0 → 5.0.0

package/api/@xmachines/{play-actor → play-view/index}/interfaces/PlaySpec.md

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

package/api/@xmachines/{play-actor → play-view/index}/interfaces/ReportGuard.md

@@ -1,8 +1,8 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / ReportGuard
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / ReportGuard
 
 # Interface: ReportGuard
 
-Defined in: [packages/play-actor/src/failure-latch.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L59)
+Defined in: [packages/play-view/src/failure-latch.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/failure-latch.ts#L59)
 
 A report guard of one provider.
 
@@ -21,7 +21,7 @@ the route that opened it).
 blocked(): boolean;
 ```
 
-Defined in: [packages/play-actor/src/failure-latch.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L61)
+Defined in: [packages/play-view/src/failure-latch.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/failure-latch.ts#L61)
 
 True when a reset that the host starts must do nothing.
 
@@ -37,7 +37,7 @@ True when a reset that the host starts must do nothing.
 dispose(): void;
 ```
 
-Defined in: [packages/play-actor/src/failure-latch.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L74)
+Defined in: [packages/play-view/src/failure-latch.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/failure-latch.ts#L74)
 
 The provider is gone.
 
@@ -53,7 +53,7 @@ The provider is gone.
 disposed(): boolean;
 ```
 
-Defined in: [packages/play-actor/src/failure-latch.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L72)
+Defined in: [packages/play-view/src/failure-latch.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/failure-latch.ts#L72)
 
 True once [ReportGuard.dispose](#dispose) ran, and never for a report that runs.
 
@@ -76,7 +76,7 @@ clear the re-entry flag of a guard that nobody holds.
 report(error, deliver): void;
 ```
 
-Defined in: [packages/play-actor/src/failure-latch.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L86)
+Defined in: [packages/play-view/src/failure-latch.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/failure-latch.ts#L86)
 
 Delivers one report, with the re-entry flag held for the call.
 

package/api/@xmachines/{play-actor → play-view/index}/interfaces/ReportGuardMessages.md

@@ -1,8 +1,8 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / ReportGuardMessages
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / ReportGuardMessages
 
 # Interface: ReportGuardMessages
 
-Defined in: [packages/play-actor/src/failure-latch.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L96)
+Defined in: [packages/play-view/src/failure-latch.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/failure-latch.ts#L96)
 
 What a [ReportGuard](ReportGuard.md) writes to `console.error`, and what it therefore contains.
 
@@ -12,7 +12,7 @@ a handler of the host never defeats the containment.
 
 ## Properties
 
-| Property                                           | Type     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Defined in                                                                                                                                             |
-| -------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-handlerthrew"></a> `handlerThrew?` | `string` | What `console.error` says when the handler of the host THROWS. A guard that carries this message CONTAINS such a throw. All five renderers carry it, so a host learns one rule: a handler of the host never defeats the containment, and a host that must escalate raises the failure from a task of its own — `queueMicrotask(() => { throw error; })`. Omit it only where a throw must reach the caller, which no renderer of this workspace asks for today. A renderer needs the containment when a throw that leaves the report also stops the screen of the fallback: the flag of play-vue schedules a render, the fallback of play-solid is the RETURN of the callback that reports, `componentDidCatch` of play-react can take the complete React root down, and a throw that leaves the `onerror` of Svelte leaves its own `calling_on_error` flag raised, which makes every later reset of the host raise `svelte_boundary_reset_onerror`. | [packages/play-actor/src/failure-latch.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L120) |
-| <a id="property-nohandler"></a> `noHandler?`       | `string` | What `console.error` says when the host gave no handler. Omit it where the framework writes such a failure itself: React logs an error that a boundary caught, so play-react would report the same failure two times.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | [packages/play-actor/src/failure-latch.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L103) |
+| Property                                           | Type     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Defined in                                                                                                                                           |
+| -------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-handlerthrew"></a> `handlerThrew?` | `string` | What `console.error` says when the handler of the host THROWS. A guard that carries this message CONTAINS such a throw. All five renderers carry it, so a host learns one rule: a handler of the host never defeats the containment, and a host that must escalate raises the failure from a task of its own — `queueMicrotask(() => { throw error; })`. Omit it only where a throw must reach the caller, which no renderer of this workspace asks for today. A renderer needs the containment when a throw that leaves the report also stops the screen of the fallback: the flag of play-vue schedules a render, the fallback of play-solid is the RETURN of the callback that reports, `componentDidCatch` of play-react can take the complete React root down, and a throw that leaves the `onerror` of Svelte leaves its own `calling_on_error` flag raised, which makes every later reset of the host raise `svelte_boundary_reset_onerror`. | [packages/play-view/src/failure-latch.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/failure-latch.ts#L120) |
+| <a id="property-nohandler"></a> `noHandler?`       | `string` | What `console.error` says when the host gave no handler. Omit it where the framework writes such a failure itself: React logs an error that a boundary caught, so play-react would report the same failure two times.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | [packages/play-view/src/failure-latch.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/failure-latch.ts#L103) |

package/api/@xmachines/{play-actor → play-view/index}/interfaces/ResolveViewStoreOptions.md

@@ -1,11 +1,11 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / ResolveViewStoreOptions
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / ResolveViewStoreOptions
 
 # Interface: ResolveViewStoreOptions
 
-Defined in: [packages/play-actor/src/view-store-lifecycle.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L57)
+Defined in: [packages/play-view/src/view-store-lifecycle.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-store-lifecycle.ts#L57)
 
 ## Properties
 
-| Property                                                           | Type      | Description                                                                                                                                                                                                                                                                    | Defined in                                                                                                                                                         |
-| ------------------------------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-refreshexternalstore"></a> `refreshExternalStore?` | `boolean` | The controlled mode only: refresh the /context subtree of the external store during this resolve. The default is true. Give false where the call site permits no notification of the store subscribers, which is the render path of React, and refresh from an effect instead. | [packages/play-actor/src/view-store-lifecycle.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L64) |
+| Property                                                           | Type      | Description                                                                                                                                                                                                                                                                    | Defined in                                                                                                                                                       |
+| ------------------------------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-refreshexternalstore"></a> `refreshExternalStore?` | `boolean` | The controlled mode only: refresh the /context subtree of the external store during this resolve. The default is true. Give false where the call site permits no notification of the store subscribers, which is the render path of React, and refresh from an effect instead. | [packages/play-view/src/view-store-lifecycle.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-store-lifecycle.ts#L64) |

package/api/@xmachines/{play-actor → play-view/index}/interfaces/ViewInputs.md

@@ -1,8 +1,8 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / ViewInputs
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / ViewInputs
 
 # Interface: ViewInputs
 
-Defined in: [packages/play-actor/src/failure-latch.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L33)
+Defined in: [packages/play-view/src/failure-latch.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/failure-latch.ts#L33)
 
 The three inputs that a provider resolves a store from.
 
@@ -12,8 +12,8 @@ time instead of once for each renderer that needs it.
 
 ## Properties
 
-| Property                            | Type      | Defined in                                                                                                                                           |
-| ----------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor` | `unknown` | [packages/play-actor/src/failure-latch.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L34) |
-| <a id="property-store"></a> `store` | `unknown` | [packages/play-actor/src/failure-latch.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L36) |
-| <a id="property-view"></a> `view`   | `unknown` | [packages/play-actor/src/failure-latch.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L35) |
+| Property                            | Type      | Defined in                                                                                                                                         |
+| ----------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor` | `unknown` | [packages/play-view/src/failure-latch.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/failure-latch.ts#L34) |
+| <a id="property-store"></a> `store` | `unknown` | [packages/play-view/src/failure-latch.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/failure-latch.ts#L36) |
+| <a id="property-view"></a> `view`   | `unknown` | [packages/play-view/src/failure-latch.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/failure-latch.ts#L35) |

package/api/@xmachines/{play-actor → play-view/index}/interfaces/ViewStoreLifecycle.md

@@ -1,8 +1,8 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / ViewStoreLifecycle
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / ViewStoreLifecycle
 
 # Interface: ViewStoreLifecycle
 
-Defined in: [packages/play-actor/src/view-store-lifecycle.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L67)
+Defined in: [packages/play-view/src/view-store-lifecycle.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-store-lifecycle.ts#L67)
 
 ## Methods
 
@@ -12,7 +12,7 @@ Defined in: [packages/play-actor/src/view-store-lifecycle.ts:67](https://gitlab.
 reset(): void;
 ```
 
-Defined in: [packages/play-actor/src/view-store-lifecycle.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L84)
+Defined in: [packages/play-view/src/view-store-lifecycle.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-store-lifecycle.ts#L84)
 
 Drops everything, on an unmount or a disconnect. The next resolve makes a new seed.
 
@@ -29,10 +29,11 @@ resolve(
    actor,
    view,
    externalStore?,
-   options?): ViewStoreResolution;
+   options?
+): ViewStoreResolution;
 ```
 
-Defined in: [packages/play-actor/src/view-store-lifecycle.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L77)
+Defined in: [packages/play-view/src/view-store-lifecycle.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-store-lifecycle.ts#L77)
 
 Brings the store in line with an emission, and returns it with its guard.
 

package/api/@xmachines/{play-actor → play-view/index}/interfaces/ViewStoreResolution.md

@@ -1,15 +1,15 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / ViewStoreResolution
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / ViewStoreResolution
 
 # Interface: ViewStoreResolution
 
-Defined in: [packages/play-actor/src/view-store-lifecycle.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L38)
+Defined in: [packages/play-view/src/view-store-lifecycle.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-store-lifecycle.ts#L38)
 
 The result of a resolve — see [ViewStoreLifecycle.resolve](ViewStoreLifecycle.md#resolve).
 
 ## Properties
 
-| Property                                          | Type         | Description                                                                                                                                                                                                                                                                       | Defined in                                                                                                                                                         |
-| ------------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-guardedstore"></a> `guardedStore` | `StateStore` | The store to give to the children ($bindState, setState, and a chained set): a write under /context throws. There is one wrapper for each store below it, and the code caches the identity. Therefore a consumer in the style of `useSyncExternalStore` stays stable.             | [packages/play-actor/src/view-store-lifecycle.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L47) |
-| <a id="property-reseeded"></a> `reseeded`         | `boolean`    | It is true when this resolve made a new store: at the first resolve, on a change of the viewKey, in the fallback for each emission, and on a change of the actor. A provider that mounts a subtree again for each store, such as the storeKey of Vue, uses this field as its key. | [packages/play-actor/src/view-store-lifecycle.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L54) |
-| <a id="property-store"></a> `store`               | `StateStore` | The store WITHOUT the guard — the reference of the machinery for its own refresh.                                                                                                                                                                                                 | [packages/play-actor/src/view-store-lifecycle.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L40) |
+| Property                                          | Type         | Description                                                                                                                                                                                                                                                                       | Defined in                                                                                                                                                       |
+| ------------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-guardedstore"></a> `guardedStore` | `StateStore` | The store to give to the children ($bindState, setState, and a chained set): a write under /context throws. There is one wrapper for each store below it, and the code caches the identity. Therefore a consumer in the style of `useSyncExternalStore` stays stable.             | [packages/play-view/src/view-store-lifecycle.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-store-lifecycle.ts#L47) |
+| <a id="property-reseeded"></a> `reseeded`         | `boolean`    | It is true when this resolve made a new store: at the first resolve, on a change of the viewKey, in the fallback for each emission, and on a change of the actor. A provider that mounts a subtree again for each store, such as the storeKey of Vue, uses this field as its key. | [packages/play-view/src/view-store-lifecycle.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-store-lifecycle.ts#L54) |
+| <a id="property-store"></a> `store`               | `StateStore` | The store WITHOUT the guard — the reference of the machinery for its own refresh.                                                                                                                                                                                                 | [packages/play-view/src/view-store-lifecycle.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-store-lifecycle.ts#L40) |

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

@@ -0,0 +1,18 @@
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / Viewable
+
+# Interface: Viewable
+
+Defined in: [packages/play-view/src/view-types.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-types.ts#L88)
+
+The actor capability that exposes a renderable view state.
+
+`Viewable` marks an actor that publishes a `currentView` atom.
+A renderer, such as `PlayRenderer`, reads this contract. It converts the
+description of the current view into a concrete UI, and the framework adapter
+therefore holds no view logic.
+
+## Properties
+
+| Property                                        | Modifier   | Type                                                                                                   | Description                                                                                                                                                                                               | Defined in                                                                                                                                   |
+| ----------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-currentview"></a> `currentView` | `readonly` | [`ReadonlyAtom`](../../../play-atom/interfaces/ReadonlyAtom.md)\<[`PlaySpec`](PlaySpec.md) \| `null`\> | The atom of the current view. It holds the json-render PlaySpec of the current machine state, or null when no view is active. The infrastructure renders the view. This is the Logic-Driven UI invariant. | [packages/play-view/src/view-types.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-types.ts#L95) |

package/api/@xmachines/play-view/index/type-aliases/ViewActor.md

@@ -0,0 +1,26 @@
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / ViewActor
+
+# Type Alias: ViewActor\<TSnapshot, TEvent\>
+
+```ts
+type ViewActor<TSnapshot, TEvent> = PlayActor<TSnapshot, TEvent> & Viewable;
+```
+
+Defined in: [packages/play-view/src/view-types.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-types.ts#L135)
+
+The actor that a view provider reads: the contract, and the view capability.
+
+It names NO engine. A provider reads `currentView` and `send`, and nothing else — the
+measurement is 20 reads of `currentView` and 16 of `send` across the five renderers, and
+no read of any other member. The type said `ViewActor`
+before, which named XState in every renderer AND erased the snapshot and the event union
+of the machine at the same time.
+
+It does NOT name `Routable`. The view implies no routing.
+
+## Type Parameters
+
+| Type Parameter                                                                  | Default type                                                 | Description                           |
+| ------------------------------------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------- |
+| `TSnapshot`                                                                     | `unknown`                                                    | The snapshot type that `state` holds. |
+| `TEvent` _extends_ [`ActorEvent`](../../../play-actor/interfaces/ActorEvent.md) | [`ActorEvent`](../../../play-actor/interfaces/ActorEvent.md) | The event union that `send` accepts.  |

package/api/@xmachines/{play-actor → play-view/index}/variables/CONTEXT_STATE_KEY.md

@@ -1,4 +1,4 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / CONTEXT\_STATE\_KEY
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / CONTEXT\_STATE\_KEY
 
 # Variable: CONTEXT\_STATE\_KEY
 
@@ -6,7 +6,7 @@
 const CONTEXT_STATE_KEY: "context" = "context";
 ```
 
-Defined in: [packages/play-actor/src/context-projection.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/context-projection.ts#L32)
+Defined in: [packages/play-view/src/context-projection.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/context-projection.ts#L34)
 
 The reserved top-level state key of the projection.
 

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

@@ -2,20 +2,20 @@
 
 # `@xmachines/play-vue`
 
-> Vue 3 renderer for the XMachines Play Architecture. It observes the actor signals and renders the UI through `@xmachines/json-render-vue`.
+> Vue 3 renderer for the XMachines Play Architecture. It observes the actor atoms and renders the UI through `@xmachines/json-render-vue`.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-3.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-vue)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-5.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-vue)
 
 ---
 
 ## Overview
 
-`@xmachines/play-vue` is the Vue 3 rendering layer of XMachines Play. It connects the TC39 Signals (the actor state) to the Vue reactivity, and it renders the components through `@xmachines/json-render-vue`.
+`@xmachines/play-vue` is the Vue 3 rendering layer of XMachines Play. It connects the atoms (the actor state) to the Vue reactivity, and it renders the components through `@xmachines/json-render-vue`.
 
 **The architecture invariants that this package keeps:**
 
-- **Passive Infrastructure** — the components observe the actor signals. They never decide a state transition.
-- **Signal-Only Reactivity** — the TC39 Signals are the source of truth. Vue reactivity only triggers the re-render.
+- **Passive Infrastructure** — the components observe the actor atoms. They never decide a state transition.
+- **Atom-Only Reactivity** — the atoms are the source of truth. Vue reactivity only triggers the re-render.
 - **Actor Authority** — the actor controls the view selection. The renderer reflects it.
 
 ---
@@ -29,9 +29,13 @@ pnpm add @xmachines/play-vue
 **Peer dependencies.** Install them with the package:
 
 ```bash
-pnpm add vue@^3.5.0 xstate@^5.31.0 @xstate/store@^3.17.0 @xmachines/json-render-vue@^0.20.0-xm.4 @xmachines/json-render-core@^0.20.0-xm.4 @xmachines/json-render-xstate@^0.20.0-xm.4
+pnpm add vue@^3.5.0 @xmachines/play @xmachines/play-atom @xstate/store@^4.2.3 @xmachines/json-render-vue@^0.20.0-xm.4 @xmachines/json-render-core@^0.20.0-xm.4 @xmachines/json-render-xstate@^0.20.0-xm.4
 ```
 
+`@xstate/store` is the peer of [`@xmachines/play-atom`](../play-atom/README.md), and not of this
+package: this package reads the atom through [`@xmachines/play-atom`](../play-atom/README.md) and
+imports the engine in no source file. Install ONE copy of it.
+
 ---
 
 ## Quick Start
@@ -46,13 +50,15 @@ pnpm add vue@^3.5.0 xstate@^5.31.0 @xstate/store@^3.17.0 @xmachines/json-render-
 
 <script setup lang="ts">
 import { defineRegistry, PlayUIProvider, PlayRenderer } from "@xmachines/play-vue";
-import { definePlayer } from "@xmachines/play-xstate";
+import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
+import { withView } from "@xmachines/play-xstate/view";
 import { myMachine } from "./machine.js";
 import { myCatalog } from "./catalog.js";
 import HomeSFC from "./views/Home.vue";
 import LoginSFC from "./views/Login.vue";
 
-const createPlayer = definePlayer({ machine: myMachine });
+// A renderer needs the view capability
+const createPlayer = definePlayer({ machine: myMachine, actor: compose(PlayerActor, withView) });
 const actor = createPlayer();
 actor.start();
 
@@ -81,7 +87,7 @@ The composite provider. It wraps `<ActorProvider>` and `JSONUIProvider` in one c
 
 | Prop                  | Type                                          | Required | Description                                                            |
 | --------------------- | --------------------------------------------- | -------- | ---------------------------------------------------------------------- |
-| `actor`               | `AbstractActor & Viewable`                    | ✅       | The XMachines actor instance                                           |
+| `actor`               | `PlayActor & Viewable`                        | ✅       | The XMachines actor instance                                           |
 | `registryResult`      | `DefineRegistryResult`                        | ✅       | Result of `defineRegistry()`                                           |
 | `store`               | `StateStore`                                  | —        | External controlled state store (optional)                             |
 | `onRenderError`       | `RenderErrorHandler`                          | —        | Error handler for render failures                                      |
@@ -118,14 +124,14 @@ The leaf component without props. It reads the current `spec` and `registry` fro
 
 #### `<ActorProvider>`
 
-The low-level provider for a custom provider composition. It owns the complete actor lifecycle: the signal subscription, the state store of each view, the handler resolution, and the Vue context. Use `<PlayUIProvider>` when you do not need this control.
+The low-level provider for a custom provider composition. It owns the complete actor lifecycle: the atom subscription, the state store of each view, the handler resolution, and the Vue context. Use `<PlayUIProvider>` when you do not need this control.
 
-| Prop             | Type                       | Required | Description                     |
-| ---------------- | -------------------------- | -------- | ------------------------------- |
-| `actor`          | `AbstractActor & Viewable` | ✅       | The XMachines actor instance    |
-| `registryResult` | `DefineRegistryResult`     | ✅       | Result of `defineRegistry()`    |
-| `store`          | `StateStore`               | —        | External controlled state store |
-| `onRenderError`  | `RenderErrorHandler`       | —        | Override render error handler   |
+| Prop             | Type                   | Required | Description                     |
+| ---------------- | ---------------------- | -------- | ------------------------------- |
+| `actor`          | `PlayActor & Viewable` | ✅       | The XMachines actor instance    |
+| `registryResult` | `DefineRegistryResult` | ✅       | Result of `defineRegistry()`    |
+| `store`          | `StateStore`           | —        | External controlled state store |
+| `onRenderError`  | `RenderErrorHandler`   | —        | Override render error handler   |
 
 ---
 
@@ -191,7 +197,7 @@ const view = usePlayView();
 
 `usePlayView()` returns a **Proxy**: every property read goes to the live context of the provider.
 
-> **Note:** `usePlayView` was previously named `getPlayViewContext`. The old name is still exported as a deprecated alias and will be removed in the next major.
+> **Note:** `usePlayView` was named `getPlayViewContext` before. That alias is gone.
 
 ---
 
@@ -207,34 +213,15 @@ This package re-exports the following, so that a consumer imports everything fro
 
 ---
 
-## Testing
-
-Run tests for this package in isolation:
-
-```bash
-# From the monorepo root
-pnpm --filter @xmachines/play-vue test
-
-# Watch mode
-pnpm --filter @xmachines/play-vue run test:watch
-
-# With coverage (80% threshold enforced on lines, functions, branches, statements)
-pnpm exec vitest run --coverage --config packages/play-vue/vitest.config.ts
-```
-
-The tests use [Vitest](https://vitest.dev/) in a `jsdom` environment. They mount the components with `@vue/test-utils`.
-
----
-
 ## License
 
 MIT — see [LICENSE](LICENSE).
 
 @xmachines/play-vue - Vue 3 renderer for the XMachines Play architecture
 
-This package is a thin Vue rendering layer. It observes the actor signals and
+This package is a thin Vue rendering layer. It observes the actor atoms and
 renders the UI components with @xmachines/json-render-vue. Vue reactivity only
-triggers the re-render. The signals are the source of truth.
+triggers the re-render. The atoms are the source of truth.
 
 The package re-exports `defineRegistry`, which knows an SFC and wraps each `.vue`
 SFC with `h()`. It also re-exports `useBoundProp`, `ComponentFn`,
@@ -253,7 +240,6 @@ everything from `@xmachines/play-vue`, and not from `@xmachines/json-render-vue`
 - [StateProviderProps](interfaces/StateProviderProps.md)
 - [ValidationProviderProps](interfaces/ValidationProviderProps.md)
 - [ViewContextValue](interfaces/ViewContextValue.md)
-- [~~VisibilityProviderProps~~](interfaces/VisibilityProviderProps.md)
 
 ## Type Aliases
 
@@ -267,10 +253,10 @@ everything from `@xmachines/play-vue`, and not from `@xmachines/json-render-vue`
 ## Variables
 
 - [ActionProvider](variables/ActionProvider.md)
-- [~~getPlayViewContext~~](variables/getPlayViewContext.md)
 - [JSONUIProvider](variables/JSONUIProvider.md)
 - [PlayRenderer](variables/PlayRenderer.md)
 - [Renderer](variables/Renderer.md)
+- [schema](variables/schema.md)
 - [StateProvider](variables/StateProvider.md)
 - [ValidationProvider](variables/ValidationProvider.md)
 - [VisibilityProvider](variables/VisibilityProvider.md)

package/api/@xmachines/play-vue/functions/defineRegistry.md

@@ -6,7 +6,7 @@
 function defineRegistry<C>(catalog, options): DefineRegistryResult;
 ```
 
-Defined in: [packages/play-vue/src/define-registry.ts:138](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-vue/src/define-registry.ts#L138)
+Defined in: [packages/play-vue/src/define-registry.ts:138](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-vue/src/define-registry.ts#L138)
 
 Creates a component registry. It wraps each `.vue` SFC, so that the SFC works
 correctly with the render pipeline of `@xmachines/json-render-vue`.

package/api/@xmachines/play-vue/functions/useActor.md

@@ -6,7 +6,7 @@
 function useActor(): AnyPlayActor;
 ```
 
-Defined in: [packages/play-vue/src/useActor.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-vue/src/useActor.ts#L64)
+Defined in: [packages/play-vue/src/useActor.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-vue/src/useActor.ts#L71)
 
 ## Returns
 

package/api/@xmachines/play-vue/functions/usePlayView.md

@@ -6,7 +6,7 @@
 function usePlayView(): ViewContextValue;
 ```
 
-Defined in: [packages/play-vue/src/actor-provider-context.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-vue/src/actor-provider-context.ts#L51)
+Defined in: [packages/play-vue/src/actor-provider-context.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-vue/src/actor-provider-context.ts#L51)
 
 Returns the current ViewContextValue inside an ActorProvider tree.