@xmachines/docs 1.0.0-beta.32 → 1.0.0-beta.33

package/api/@xmachines/play/classes/NonNullableError.md

@@ -2,7 +2,7 @@
 
 # Class: NonNullableError
 
-Defined in: [packages/play/src/errors.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play/src/errors.ts#L111)
+Defined in: [packages/play/src/errors.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play/src/errors.ts#L111)
 
 Thrown by [assertNonNullable](../functions/assertNonNullable.md) when a value is `null` or `undefined`.
 
@@ -35,7 +35,7 @@ try {
 new NonNullableError(message, options?): NonNullableError;
 ```
 
-Defined in: [packages/play/src/errors.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play/src/errors.ts#L112)
+Defined in: [packages/play/src/errors.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play/src/errors.ts#L112)
 
 #### Parameters
 
@@ -57,10 +57,10 @@ Defined in: [packages/play/src/errors.ts:112](https://gitlab.com/xmachin-es/xmac
 | Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                         | Defined in                                                                                                                         |
 | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
 | <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](PlayError.md).[`cause`](PlayError.md#property-cause)                     | -                                                                                                                                  |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable error identifier. Error codes follow the `PLAY_<PACKAGE>_<DESCRIPTION>` naming convention and are guaranteed stable across patch and minor releases within a major version. Never match on `.message` — always match on `.code` or the subclass.                                                                                                                                                                       | [`PlayError`](PlayError.md).[`code`](PlayError.md#property-code)                       | [packages/play/src/errors.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play/src/errors.ts#L75) |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable error identifier. Error codes follow the `PLAY_<PACKAGE>_<DESCRIPTION>` naming convention and are guaranteed stable across patch and minor releases within a major version. Never match on `.message` — always match on `.code` or the subclass.                                                                                                                                                                       | [`PlayError`](PlayError.md).[`code`](PlayError.md#property-code)                       | [packages/play/src/errors.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play/src/errors.ts#L75) |
 | <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](PlayError.md).[`message`](PlayError.md#property-message)                 | -                                                                                                                                  |
 | <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](PlayError.md).[`name`](PlayError.md#property-name)                       | -                                                                                                                                  |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or module that threw this error (e.g. `"RouterBridgeBase"`).                                                                                                                                                                                                                                                                                                                                                                            | [`PlayError`](PlayError.md).[`scope`](PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play/src/errors.ts#L66) |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or module that threw this error (e.g. `"RouterBridgeBase"`).                                                                                                                                                                                                                                                                                                                                                                            | [`PlayError`](PlayError.md).[`scope`](PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play/src/errors.ts#L66) |
 | <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](PlayError.md).[`stack`](PlayError.md#property-stack)                     | -                                                                                                                                  |
 | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](PlayError.md).[`stackTraceLimit`](PlayError.md#property-stacktracelimit) | -                                                                                                                                  |
 

package/api/@xmachines/play/classes/PlayError.md

@@ -2,7 +2,7 @@
 
 # Class: PlayError
 
-Defined in: [packages/play/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play/src/errors.ts#L64)
+Defined in: [packages/play/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play/src/errors.ts#L64)
 
 Base class for all typed runtime errors thrown by `@xmachines/*` packages.
 
@@ -87,7 +87,7 @@ new PlayError(
    options?): PlayError;
 ```
 
-Defined in: [packages/play/src/errors.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play/src/errors.ts#L83)
+Defined in: [packages/play/src/errors.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play/src/errors.ts#L83)
 
 #### Parameters
 
@@ -113,10 +113,10 @@ Error.constructor;
 | Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from          | Defined in                                                                                                                         |
 | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
 | <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `Error.cause`           | -                                                                                                                                  |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable error identifier. Error codes follow the `PLAY_<PACKAGE>_<DESCRIPTION>` naming convention and are guaranteed stable across patch and minor releases within a major version. Never match on `.message` — always match on `.code` or the subclass.                                                                                                                                                                       | -                       | [packages/play/src/errors.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play/src/errors.ts#L75) |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable error identifier. Error codes follow the `PLAY_<PACKAGE>_<DESCRIPTION>` naming convention and are guaranteed stable across patch and minor releases within a major version. Never match on `.message` — always match on `.code` or the subclass.                                                                                                                                                                       | -                       | [packages/play/src/errors.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play/src/errors.ts#L75) |
 | <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `Error.message`         | -                                                                                                                                  |
 | <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `Error.name`            | -                                                                                                                                  |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or module that threw this error (e.g. `"RouterBridgeBase"`).                                                                                                                                                                                                                                                                                                                                                                            | -                       | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play/src/errors.ts#L66) |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or module that threw this error (e.g. `"RouterBridgeBase"`).                                                                                                                                                                                                                                                                                                                                                                            | -                       | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play/src/errors.ts#L66) |
 | <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `Error.stack`           | -                                                                                                                                  |
 | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | -                                                                                                                                  |
 

package/api/@xmachines/play/functions/assertNonNullable.md

@@ -6,7 +6,7 @@
 function assertNonNullable<V>(value, name?): NonNullable<V>;
 ```
 
-Defined in: [packages/play/src/utils.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play/src/utils.ts#L39)
+Defined in: [packages/play/src/utils.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play/src/utils.ts#L39)
 
 Assert that `value` is neither `null` nor `undefined`, and return it typed
 as `NonNullable<V>` — combining the guard and the narrowed value in a single

package/api/@xmachines/play/type-aliases/PlayEvent.md

@@ -6,7 +6,7 @@
 type PlayEvent<TPayload> = object & TPayload;
 ```
 
-Defined in: [packages/play/src/types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play/src/types.ts#L69)
+Defined in: [packages/play/src/types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play/src/types.ts#L69)
 
 Generic event type for Play Architecture
 
@@ -34,7 +34,7 @@ Robot, and other state machine libraries.
 
 | Name   | Type     | Defined in                                                                                                                       |
 | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
-| `type` | `string` | [packages/play/src/types.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play/src/types.ts#L70) |
+| `type` | `string` | [packages/play/src/types.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play/src/types.ts#L70) |
 
 ## Type Parameters
 

package/api/@xmachines/play-actor/classes/AbstractActor.md

@@ -2,7 +2,7 @@
 
 # Abstract Class: AbstractActor\<TLogic, TEvent\>
 
-Defined in: [packages/play-actor/src/abstract-actor.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L141)
+Defined in: [packages/play-actor/src/abstract-actor.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-actor/src/abstract-actor.ts#L141)
 
 Abstract base class for Play Architecture actors.
 
@@ -67,7 +67,7 @@ Actor<TLogic>.constructor
 | <a id="property-ref"></a> `ref`             | `public`   | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TLogic`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TLogic`\>\> | -                                                                                                                                                                                       | `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`         | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\>                                                                                                                                                                                                                                      | Reactive snapshot of current actor state. Infrastructure observes this signal to react to state changes without directly coupling to the actor's internal state machine implementation. | -                 | [packages/play-actor/src/abstract-actor.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L151) |
+| <a id="property-state"></a> `state`         | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\>                                                                                                                                                                                                                                      | Reactive snapshot of current actor state. Infrastructure observes this signal to react to state changes without directly coupling to the actor's internal state machine implementation. | -                 | [packages/play-actor/src/abstract-actor.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-actor/src/abstract-actor.ts#L151) |
 | <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`  | -                                                                                                                                                                |
 
@@ -238,7 +238,7 @@ Actor.select;
 abstract send(event): void;
 ```
 
-Defined in: [packages/play-actor/src/abstract-actor.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L158)
+Defined in: [packages/play-actor/src/abstract-actor.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-actor/src/abstract-actor.ts#L158)
 
 Send event to Actor.
 

package/api/@xmachines/play-actor/functions/typedSpec.md

@@ -6,7 +6,7 @@
 function typedSpec<TContext>(spec): PlaySpec;
 ```
 
-Defined in: [packages/play-actor/src/abstract-actor.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L86)
+Defined in: [packages/play-actor/src/abstract-actor.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-actor/src/abstract-actor.ts#L86)
 
 Identity helper that constrains a `PlaySpec` object's `contextProps` to keys
 of a specific machine context type, giving compile-time validation and IDE

package/api/@xmachines/play-actor/interfaces/PlaySpec.md

@@ -2,7 +2,7 @@
 
 # Interface: PlaySpec
 
-Defined in: [packages/play-actor/src/abstract-actor.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L43)
+Defined in: [packages/play-actor/src/abstract-actor.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-actor/src/abstract-actor.ts#L43)
 
 XMachines extension of `@json-render/core` `Spec`.
 
@@ -22,7 +22,7 @@ entries against your machine's context type at compile time.
 
 | Property                                           | Modifier   | Type                              | Description                                                                                                                                                                                                                                                                                             | Inherited from  | Defined in                                                                                                                                                     |
 | -------------------------------------------------- | ---------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-contextprops"></a> `contextProps?` | `readonly` | readonly `string`[]               | Explicit allowlist of machine context field names to expose as prop slots. Each named field is merged into every spec element's `props` at view derivation time, filling any slot whose current value is `undefined`. Use `typedSpec<TContext>(...)` to constrain entries to `keyof TContext & string`. | -               | [packages/play-actor/src/abstract-actor.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L51) |
+| <a id="property-contextprops"></a> `contextProps?` | `readonly` | readonly `string`[]               | Explicit allowlist of machine context field names to expose as prop slots. Each named field is merged into every spec element's `props` at view derivation time, filling any slot whose current value is `undefined`. Use `typedSpec<TContext>(...)` to constrain entries to `keyof TContext & string`. | -               | [packages/play-actor/src/abstract-actor.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-actor/src/abstract-actor.ts#L51) |
 | <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`    | -                                                                                                                                                              |

package/api/@xmachines/play-actor/interfaces/Routable.md

@@ -2,7 +2,7 @@
 
 # Interface: Routable
 
-Defined in: [packages/play-actor/src/abstract-actor.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L27)
+Defined in: [packages/play-actor/src/abstract-actor.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-actor/src/abstract-actor.ts#L27)
 
 Optional capability: Routing support
 
@@ -10,5 +10,5 @@ Optional capability: Routing support
 
 | Property                                          | Modifier   | Type                                                                                         | Defined in                                                                                                                                                     |
 | ------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | [packages/play-actor/src/abstract-actor.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L28) |
-| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                           | [packages/play-actor/src/abstract-actor.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L29) |
+| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | [packages/play-actor/src/abstract-actor.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-actor/src/abstract-actor.ts#L28) |
+| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                           | [packages/play-actor/src/abstract-actor.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-actor/src/abstract-actor.ts#L29) |

package/api/@xmachines/play-actor/interfaces/ViewMetadata.md

@@ -2,7 +2,7 @@
 
 # Interface: ViewMetadata
 
-Defined in: [packages/play-actor/src/abstract-actor.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L100)
+Defined in: [packages/play-actor/src/abstract-actor.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-actor/src/abstract-actor.ts#L100)
 
 View metadata for rendering.
 
@@ -13,5 +13,5 @@ Used by PlayRenderer to dynamically render UI based on actor state.
 
 | Property                                    | Type                      | Description                                                                                                                                                                                                                                | Defined in                                                                                                                                                       |
 | ------------------------------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-component"></a> `component` | `string`                  | Root element type name (for diagnostics and component resolution)                                                                                                                                                                          | [packages/play-actor/src/abstract-actor.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L102) |
-| <a id="property-spec"></a> `spec`           | [`PlaySpec`](PlaySpec.md) | XMachines view spec — extends `@json-render/core` Spec with `contextProps` for explicit context field exposure. Use `typedSpec<TContext>(...)` at the definition site to validate `contextProps` entries against the machine context type. | [packages/play-actor/src/abstract-actor.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L110) |
+| <a id="property-component"></a> `component` | `string`                  | Root element type name (for diagnostics and component resolution)                                                                                                                                                                          | [packages/play-actor/src/abstract-actor.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-actor/src/abstract-actor.ts#L102) |
+| <a id="property-spec"></a> `spec`           | [`PlaySpec`](PlaySpec.md) | XMachines view spec — extends `@json-render/core` Spec with `contextProps` for explicit context field exposure. Use `typedSpec<TContext>(...)` at the definition site to validate `contextProps` entries against the machine context type. | [packages/play-actor/src/abstract-actor.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-actor/src/abstract-actor.ts#L110) |

package/api/@xmachines/play-actor/interfaces/Viewable.md

@@ -2,7 +2,7 @@
 
 # Interface: Viewable
 
-Defined in: [packages/play-actor/src/abstract-actor.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L121)
+Defined in: [packages/play-actor/src/abstract-actor.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-actor/src/abstract-actor.ts#L121)
 
 Actor capability for exposing renderable view state.
 
@@ -15,4 +15,4 @@ framework adapter.
 
 | Property                                        | Modifier   | Type                                                                                                            | Description                                                                                                                                        | Defined in                                                                                                                                                       |
 | ----------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`ViewMetadata`](ViewMetadata.md) \| `null`\> | Current view signal. State signal containing view.component and view.spec from meta.view. Infrastructure renders view — Logic-Driven UI invariant. | [packages/play-actor/src/abstract-actor.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L128) |
+| <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`ViewMetadata`](ViewMetadata.md) \| `null`\> | Current view signal. State signal containing view.component and view.spec from meta.view. Infrastructure renders view — Logic-Driven UI invariant. | [packages/play-actor/src/abstract-actor.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-actor/src/abstract-actor.ts#L128) |

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

@@ -4,76 +4,257 @@
 
 **Vanilla DOM renderer for XMachines**
 
-`connectRenderer` — a framework-free `PlayRenderer` equivalent that wires an XState v5 actor's `currentView` TC39 Signal to pure DOM rendering via a catalog-typed `DomRegistry`.
+Framework-free view rendering driven by an XState v5 actor's `currentView` TC39 Signal. Implements the same catalog-typed `defineRegistry` / `ComponentFn` / `ActionFn` API surface as `@json-render/react`, `/solid`, `/vue`, and `/svelte`.
 
 ## Installation
 
 ```bash
-npm install @xmachines/play-dom
+npm install @xmachines/play-dom @json-render/core zod
 ```
 
 ## Key Exports
 
-- `connectRenderer({ actor, registry, container, handlers })` — connect actor view signal to DOM
-- `defineRegistry(catalog, { components, actions })` — build a catalog-typed `DomRegistry` with real async action handlers
-- `schema` — DOM schema for use with `defineCatalog` (mirrors `@json-render/react/schema` shape)
-- `PlayRenderer` — class-based renderer (connect/disconnect lifecycle)
-- `ComponentFn<C, K>` — catalog-typed DOM component function type
-- `ComponentContext<C, K>` — context passed to each `ComponentFn` (props, emit, on, children, bindings)
-- `renderSpec(spec, store, registry, send, handlers)` — pure Spec → DOM renderer
-
-## Usage
-
-```ts
-import { definePlayer } from "@xmachines/play-xstate";
-import { connectRenderer, defineRegistry, schema } from "@xmachines/play-dom";
+| Export                                              | Description                                                                                 |
+| --------------------------------------------------- | ------------------------------------------------------------------------------------------- |
+| `createRenderer(catalog, componentMap)`             | One-call factory: returns `mount(actor, container, options?) → disconnect`                  |
+| `connectRenderer(options)`                          | Functional API: connect actor → DOM with full options                                       |
+| `defineRegistry(catalog, { components, actions })`  | Build a catalog-typed `DomRegistry` with typed action handlers                              |
+| `PlayRenderer`                                      | Class-based renderer — `connect()` / `disconnect()` lifecycle                               |
+| `schema`                                            | DOM schema for `defineCatalog` (mirrors `@json-render/react/schema`)                        |
+| `ComponentFn<C, K>`                                 | Catalog-typed DOM component function type                                                   |
+| `ComponentContext<C, K>`                            | Context passed to each `ComponentFn` — `props`, `on`, `emit`, `children`, `bindings`, `ctx` |
+| `ActionFn<C, K>`                                    | `(params, setState, state) => Promise<void>` — catalog-typed action handler                 |
+| `SetState`                                          | `(updater: prev => next) => void` — write to the local state store                          |
+| `BaseComponentProps<P>`                             | Base type for catalog component prop definitions                                            |
+| `CatalogHasActions<C>`                              | Conditional type: `true` when catalog declares actions                                      |
+| `renderSpec(spec, store, registry, send, handlers)` | Pure Spec → DOM renderer (advanced use)                                                     |
+
+## Quick Start — `createRenderer`
+
+The preferred one-call pattern — mirrors all framework renderers:
+
+```typescript
+import { createRenderer, schema } from "@xmachines/play-dom";
 import { defineCatalog } from "@json-render/core";
-import { authCatalogDef, type AuthActor } from "@xmachines/play-actor-shared";
+import { z } from "zod";
 import type { ComponentFn } from "@xmachines/play-dom";
 
-// 1. Build catalog with DOM schema
-const authCatalog = defineCatalog(schema, authCatalogDef);
-type AuthCatalog = typeof authCatalog;
+// 1. Define catalog
+const catalog = defineCatalog(schema, {
+	components: {
+		Home: { props: z.object({ title: z.string() }) },
+		Login: { props: z.object({ title: z.string(), username: z.string().optional() }) },
+	},
+	actions: {
+		login: { params: z.object({ username: z.string() }) },
+		logout: {},
+	},
+});
+type AppCatalog = typeof catalog;
 
-// 2. Implement catalog components
-const Home: ComponentFn<AuthCatalog, "Home"> = ({ props }) => {
+// 2. Implement components
+const Home: ComponentFn<AppCatalog, "Home"> = ({ props }) => {
 	const el = document.createElement("section");
 	el.textContent = props.title;
 	return el;
 };
 
-// 3. Build registry with real async action handlers
-const registryResult = defineRegistry(authCatalog, {
-	components: { Home /* ... */ },
+const Login: ComponentFn<AppCatalog, "Login"> = ({ props, on }) => {
+	const section = document.createElement("section");
+	const input = document.createElement("input");
+	input.value = props.username ?? "";
+	input.addEventListener("input", () => ctx.store.update((s) => ({ ...s, username: input.value })));
+
+	const button = document.createElement("button");
+	button.textContent = "Log In";
+	const submit = on("submit");
+	button.addEventListener("click", () => submit.emit());
+
+	section.append(input, button);
+	return section;
+};
+
+// 3. Create the renderer factory (once, at module level)
+const mount = createRenderer(catalog, { Home, Login });
+
+// 4. Mount when actor and container are ready
+const actor = createPlayer()();
+actor.start();
+
+const disconnect = mount(actor, document.getElementById("app")!);
+
+// Cleanup:
+disconnect();
+```
+
+## `defineRegistry` — Full Control
+
+When you need `registryResult.executeAction()` or want to share the registry with `connectRenderer`:
+
+```typescript
+import { defineRegistry, connectRenderer, schema } from "@xmachines/play-dom";
+import { defineCatalog } from "@json-render/core";
+import { z } from "zod";
+
+const catalog = defineCatalog(schema, {
+	components: {
+		Home: { props: z.object({ title: z.string() }) },
+	},
 	actions: {
-		login: async (params) => {
+		login: { params: z.object({ username: z.string() }) },
+		logout: {},
+	},
+});
+
+// Action handlers receive (params, setState, state)
+// - params: resolved from the spec's on.submit.params (e.g. { $state: "/username" })
+// - setState: write to the local state store (e.g. to clear a form)
+// - state: current local state store snapshot
+const registryResult = defineRegistry(catalog, {
+	components: {
+		Home: ({ props }) => {
+			const el = document.createElement("section");
+			el.textContent = props.title;
+			return el;
+		},
+	},
+	actions: {
+		login: async (params, setState) => {
 			if (!params) return;
 			actor.send({ type: "auth.login", username: params.username });
+			setState((prev) => ({ ...prev, username: "" })); // clear the form
 		},
 		logout: async () => actor.send({ type: "auth.logout" }),
 	},
 });
 
-// 4. Resolve handlers and connect
-const actor = definePlayer({ machine: authMachine })();
-actor.start();
-
-const handlers = registryResult.handlers(
-	() => undefined,
-	() => ({}),
-);
-const container = document.getElementById("app")!;
 const disconnect = connectRenderer({
 	actor,
 	registry: registryResult.registry,
-	container,
-	handlers,
+	registryResult, // wires setState/state from xstate store automatically
+	container: document.getElementById("app")!,
 });
 ```
 
+## Component API
+
+### `ComponentFn<C, K>` — component function signature
+
+```typescript
+const MyCard: ComponentFn<AppCatalog, "Card"> = ({
+	props, // catalog-typed props for this component
+	children, // Node[] — rendered child nodes
+	on, // (eventName) => EventHandle — get emit() for catalog-declared events
+	emit, // (eventName) => void — fire an event directly
+	bindings, // Record<string, string> — $bindState paths for two-way bindings
+	ctx, // DomRenderContext — store, send, handlers, loading, functions
+}) => {
+	const el = document.createElement("div");
+	el.append(...children);
+	return el;
+};
+```
+
+### Two-way binding with `$bindState`
+
+In the view spec:
+
+```json
+{ "username": { "$bindState": "/username" } }
+```
+
+In the component:
+
+```typescript
+const Login: ComponentFn<AppCatalog, "Login"> = ({ props, ctx }) => {
+	const input = document.createElement("input");
+	input.value = props.username ?? "";
+	// Write back to the store on user input
+	input.addEventListener("input", () => {
+		ctx.store.update((s) => ({ ...s, username: input.value }));
+	});
+	return input;
+};
+```
+
+### `on()` — event handle
+
+```typescript
+const submit = on("submit"); // EventHandle
+if (submit.bound) {
+	button.addEventListener("click", (e) => {
+		if (submit.shouldPreventDefault) e.preventDefault();
+		submit.emit(); // resolves params from store, calls action handler
+	});
+}
+```
+
+### `ActionFn` — action handler signature
+
+```typescript
+// Full signature — all three params are available
+login: async (params, setState, state) => {
+  actor.send({ type: "auth.login", username: params!.username });
+  setState(prev => ({ ...prev, username: "" }));
+  console.log("previous state was:", state);
+},
+
+// Params-only — setState/state can be omitted if unused
+logout: async () => actor.send({ type: "auth.logout" }),
+route: async (params) => actor.send({ type: "play.route", to: params!.to }),
+```
+
+## Spec Features
+
+`renderSpec` / `renderElement` supports these spec directives:
+
+| Directive                                              | Description                                                                           |
+| ------------------------------------------------------ | ------------------------------------------------------------------------------------- |
+| `visible`                                              | Boolean or `{ $state: "/path" }` — hide element when false                            |
+| `on.submit` / `on.click`                               | Action binding — `{ action: "login", params: { username: { $state: "/username" } } }` |
+| `repeat: { statePath, key? }`                          | Render children once per item in the state array at `statePath`                       |
+| `watch: { "/path": actionBinding }`                    | Fire action when store path changes after mount                                       |
+| `props.username: { $bindState: "/username" }`          | Two-way binding — read from store, write back via `ctx.store.update()`                |
+| `props.value: { $state: "/value" }`                    | Read-only store reference                                                             |
+| `props.label: { $computed: "computeFn", args: [...] }` | Computed prop via `functions` map                                                     |
+
+## `PlayRenderer` — class API
+
+```typescript
+import { PlayRenderer, defineRegistry } from "@xmachines/play-dom";
+
+const { registry, registryResult } = defineRegistry(catalog, { components, actions });
+
+const renderer = new PlayRenderer(document.getElementById("app")!, actor, registry, {
+	registryResult,
+});
+
+renderer.connect(); // starts watching actor.currentView
+renderer.disconnect(); // stops watching, clears container
+
+// double-connect is safe — connect() calls disconnect() internally if already connected
+```
+
+## Options Reference
+
+### `ConnectRendererOptions` / `PlayDomOptions`
+
+| Option           | Type                            | Description                                                                   |
+| ---------------- | ------------------------------- | ----------------------------------------------------------------------------- |
+| `actor`          | `AbstractActor & Viewable`      | Actor providing `currentView` signal                                          |
+| `registry`       | `DomRegistry`                   | Component renderer map from `defineRegistry`                                  |
+| `registryResult` | `DefineRegistryResult`          | Preferred — auto-wires `setState`/`state` from xstate store                   |
+| `handlers`       | `Record<string, ActionHandler>` | Pre-resolved handlers (legacy / advanced)                                     |
+| `container`      | `HTMLElement`                   | DOM element to render into                                                    |
+| `fallback`       | `HTMLElement \| null`           | Shown on initial mount when view is `null` (initial mount only)               |
+| `store`          | `StateStore`                    | External store — controlled mode, overrides `spec.state`                      |
+| `loading`        | `boolean`                       | Streaming mode — suppresses missing-child warnings, exposes `ctx.ctx.loading` |
+
 ## Learn More
 
 - [DOM Router adapter `@xmachines/play-dom-router`](../play-dom-router/README.md)
+- [API reference](../../_media/README.md)
+- [Play RFC](../../packages/docs/rfc/play.md)
 
 @xmachines/play-dom — Vanilla DOM renderer for XMachines Play architecture.
 
@@ -81,8 +262,9 @@ Public API split into two layers:
 
 **XMachines layer** (this package):
 
-- `PlayRenderer` — connects actor.currentView signal → DOM renderer
-- `connectRenderer()` — backward-compat functional API
+- `createRenderer()` — one-call factory: returns `mount(actor, container, options?) → disconnect`
+- `PlayRenderer` — class-based renderer with `connect()` / `disconnect()` lifecycle
+- `connectRenderer()` — functional API (backward-compat alternative to `PlayRenderer`)
 - `ConnectRendererOptions`, `PlayDomOptions`
 
 **json-render layer** (upstreamable to @json-render/dom):
@@ -96,6 +278,9 @@ Public API split into two layers:
 - `DomRegistry` — raw registry type
 - `DomRenderContext` — raw render context
 - `EventHandle` — event handle returned by on()
+- `SetState` — state updater function passed to ActionFn
+- `CatalogHasActions` — conditional type: true when catalog declares actions
+- `BaseComponentProps` — base props type for catalog component definitions
 
 ## Classes
 
@@ -105,7 +290,6 @@ Public API split into two layers:
 
 - [ComponentContext](interfaces/ComponentContext.md)
 - [ConnectRendererOptions](interfaces/ConnectRendererOptions.md)
-- [DefineRegistryOptions](interfaces/DefineRegistryOptions.md)
 - [DefineRegistryResult](interfaces/DefineRegistryResult.md)
 - [DomRenderContext](interfaces/DomRenderContext.md)
 - [EventHandle](interfaces/EventHandle.md)
@@ -115,11 +299,15 @@ Public API split into two layers:
 
 - [ActionFn](type-aliases/ActionFn.md)
 - [Actions](type-aliases/Actions.md)
+- [BaseComponentProps](type-aliases/BaseComponentProps.md)
+- [CatalogHasActions](type-aliases/CatalogHasActions.md)
 - [ComponentFn](type-aliases/ComponentFn.md)
 - [ComponentRegistry](type-aliases/ComponentRegistry.md)
+- [DefineRegistryOptions](type-aliases/DefineRegistryOptions.md)
 - [DomComponentRenderer](type-aliases/DomComponentRenderer.md)
 - [DomRegistry](type-aliases/DomRegistry.md)
 - [DomSchema](type-aliases/DomSchema.md)
+- [SetState](type-aliases/SetState.md)
 
 ## Variables
 
@@ -128,5 +316,6 @@ Public API split into two layers:
 ## Functions
 
 - [connectRenderer](functions/connectRenderer.md)
+- [createRenderer](functions/createRenderer.md)
 - [defineRegistry](functions/defineRegistry.md)
 - [renderSpec](functions/renderSpec.md)