@xmachines/docs 1.0.0-beta.15 → 1.0.0-beta.17

package/api/@xmachines/play-dom/functions/renderSpec.md

@@ -0,0 +1,28 @@
+[Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / renderSpec
+
+# Function: renderSpec()
+
+```ts
+function renderSpec(spec, store, registry, send, actor, actorActions): Node | null;
+```
+
+Defined in: [dom-renderer.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/dom-renderer.ts#L26)
+
+Render a Spec tree into DOM nodes using the provided DomRegistry.
+
+## Parameters
+
+| Parameter      | Type                                                                                                                                                                                                                                                             | Description                                                               |
+| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `spec`         | `Spec`                                                                                                                                                                                                                                                           | The json-render Spec describing the UI tree                               |
+| `store`        | `StateStore`                                                                                                                                                                                                                                                     | StateStore holding the current state values                               |
+| `registry`     | [`DomRegistry`](../type-aliases/DomRegistry.md)                                                                                                                                                                                                                  | Map of element type names to DomComponentRenderer functions               |
+| `send`         | (`event`) => `void`                                                                                                                                                                                                                                              | Function to dispatch XState events from UI interactions                   |
+| `actor`        | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Raw actor — available to DOM components for state reading, complex events |
+| `actorActions` | `Record`\<`string`, `string`\>                                                                                                                                                                                                                                   | Map of json-render action names → XState event types                      |
+
+## Returns
+
+`Node` \| `null`
+
+The root DOM node, or null if root element is invisible or unknown

package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md

@@ -0,0 +1,18 @@
+[Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / ConnectRendererOptions
+
+# Interface: ConnectRendererOptions
+
+Defined in: [types.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L63)
+
+Options for connectRenderer() — backward compat API.
+
+## Properties
+
+| Property                                    | Type                                                                                                                                                                                                                                                             | Description                                                                                                                                                                                                                                                   | Defined in                                                                                                         |
+| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-actions"></a> `actions?`    | `Record`\<`string`, `string`\>                                                                                                                                                                                                                                   | Map of json-render actionName → XState event type                                                                                                                                                                                                             | [types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L77) |
+| <a id="property-actor"></a> `actor`         | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability)                                                                                                                                                                                         | [types.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L65) |
+| <a id="property-container"></a> `container` | `HTMLElement`                                                                                                                                                                                                                                                    | Container element to render into                                                                                                                                                                                                                              | [types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L71) |
+| <a id="property-fallback"></a> `fallback?`  | `HTMLElement` \| `null`                                                                                                                                                                                                                                          | Optional element shown when currentView is null (defaults to nothing — clears container)                                                                                                                                                                      | [types.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L74) |
+| <a id="property-registry"></a> `registry`   | [`DomRegistry`](../type-aliases/DomRegistry.md)                                                                                                                                                                                                                  | Registry of component renderers — replaces old `components` map                                                                                                                                                                                               | [types.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L68) |
+| <a id="property-store"></a> `store?`        | `StateStore`                                                                                                                                                                                                                                                     | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored. When omitted, a fresh @xstate/store atom is created internally per view transition. | [types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L84) |

package/api/@xmachines/play-dom/interfaces/DomRenderContext.md

@@ -0,0 +1,18 @@
+[Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / DomRenderContext
+
+# Interface: DomRenderContext
+
+Defined in: [types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L14)
+
+Context passed to each DomComponentRenderer when rendering an element.
+
+## Properties
+
+| Property                                              | Type                                                                                                                                                                                                                                                             | Description                                                                            | Defined in                                                                                                         |
+| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-actor"></a> `actor`                   | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Raw actor — access from any DOM component for state reading, complex events, lifecycle | [types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L22) |
+| <a id="property-actoractions"></a> `actorActions`     | `Record`\<`string`, `string`\>                                                                                                                                                                                                                                   | Map of json-render action names → XState event types                                   | [types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L24) |
+| <a id="property-renderchildren"></a> `renderChildren` | (`keys`) => `Node`[]                                                                                                                                                                                                                                             | Recursively render child elements by key                                               | [types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L26) |
+| <a id="property-send"></a> `send`                     | (`event`) => `void`                                                                                                                                                                                                                                              | Send an event to the actor                                                             | [types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L20) |
+| <a id="property-spec"></a> `spec`                     | `Spec`                                                                                                                                                                                                                                                           | Full spec tree                                                                         | [types.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L16) |
+| <a id="property-store"></a> `store`                   | `StateStore`                                                                                                                                                                                                                                                     | State store bound to spec.state                                                        | [types.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L18) |

package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md

@@ -0,0 +1,14 @@
+[Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / PlayDomOptions
+
+# Interface: PlayDomOptions
+
+Defined in: [types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L46)
+
+Options for PlayRenderer.
+
+## Properties
+
+| Property                                 | Type                           | Description                                                                                                                                                                                                                                                                                                                                                         | Defined in                                                                                                         |
+| ---------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-actions"></a> `actions?` | `Record`\<`string`, `string`\> | Map of json-render actionName → XState event type                                                                                                                                                                                                                                                                                                                   | [types.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L48) |
+| <a id="property-store"></a> `store?`     | `StateStore`                   | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L57) |

package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md

@@ -0,0 +1,23 @@
+[Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / DomComponentRenderer
+
+# Type Alias: DomComponentRenderer
+
+```ts
+type DomComponentRenderer = (element, ctx) => HTMLElement | Text | null;
+```
+
+Defined in: [types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L33)
+
+Pure DOM component renderer — receives a UIElement + context and returns a DOM node.
+No framework required. Return null for unknown/unsupported elements.
+
+## Parameters
+
+| Parameter | Type                                                    |
+| --------- | ------------------------------------------------------- |
+| `element` | `UIElement`                                             |
+| `ctx`     | [`DomRenderContext`](../interfaces/DomRenderContext.md) |
+
+## Returns
+
+`HTMLElement` \| `Text` \| `null`

package/api/@xmachines/play-dom/type-aliases/DomRegistry.md

@@ -0,0 +1,11 @@
+[Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / DomRegistry
+
+# Type Alias: DomRegistry
+
+```ts
+type DomRegistry = Record<string, DomComponentRenderer>;
+```
+
+Defined in: [types.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.17/packages/play-dom/src/types.ts#L41)
+
+Registry of component renderers keyed by element type.