npm - @xmachines/docs - Versions diffs - 1.0.0-beta.30 → 1.0.0-beta.31 - Mend

@xmachines/docs 1.0.0-beta.30 → 1.0.0-beta.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (272) hide show

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

@@ -2,7 +2,7 @@
 # Interface: ConnectRendererOptions
-Defined in: [xm-types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L35)
+Defined in: [xm-types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L38)
 Options for connectRenderer() — backward compat API.
@@ -10,9 +10,9 @@ Options for connectRenderer() — backward compat API.
 | Property                                    | Type                                                                                                                                                                                                                                                             | Description                                                                                                                                                                                                                                                   | Defined in                                                                                                               |
 | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-actions"></a> `actions?`    | `Record`\<`string`, `string`\>                                                                                                                                                                                                                                   | Map of json-render actionName → XState event type                                                                                                                                                                                                             | [xm-types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L49) |
-| <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)                                                                                                                                                                                         | [xm-types.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L37) |
-| <a id="property-container"></a> `container` | `HTMLElement`                                                                                                                                                                                                                                                    | Container element to render into                                                                                                                                                                                                                              | [xm-types.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L43) |
-| <a id="property-fallback"></a> `fallback?`  | `HTMLElement` \| `null`                                                                                                                                                                                                                                          | Optional element shown when currentView is null (defaults to nothing — clears container)                                                                                                                                                                      | [xm-types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L46) |
-| <a id="property-registry"></a> `registry`   | [`DomRegistry`](../type-aliases/DomRegistry.md)                                                                                                                                                                                                                  | Registry of component renderers — replaces old `components` map                                                                                                                                                                                               | [xm-types.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L40) |
-| <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. | [xm-types.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L56) |
+| <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)                                                                                                                                                                                         | [xm-types.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L40) |
+| <a id="property-container"></a> `container` | `HTMLElement`                                                                                                                                                                                                                                                    | Container element to render into                                                                                                                                                                                                                              | [xm-types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L46) |
+| <a id="property-fallback"></a> `fallback?`  | `HTMLElement` \| `null`                                                                                                                                                                                                                                          | Optional element shown when currentView is null (defaults to nothing — clears container)                                                                                                                                                                      | [xm-types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L49) |
+| <a id="property-handlers"></a> `handlers?`  | `Record`\<`string`, `ActionHandler`\>                                                                                                                                                                                                                            | Map of catalog action name → async ActionHandler function. Replaces the old `actions: Record<string, string>` string-map approach.                                                                                                                            | [xm-types.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L55) |
+| <a id="property-registry"></a> `registry`   | [`DomRegistry`](../type-aliases/DomRegistry.md)                                                                                                                                                                                                                  | Registry of component renderers — replaces old `components` map                                                                                                                                                                                               | [xm-types.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L43) |
+| <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. | [xm-types.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L62) |

package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md CHANGED Viewed

@@ -2,14 +2,12 @@
 # Interface: DefineRegistryOptions\<C\>
-Defined in: [json-render/types.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L275)
+Defined in: [json-render/types.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L144)
 Options for `defineRegistry`.
-Mirrors `DefineRegistryOptions<C>` from @json-render/react, /solid, /svelte, /vue
-with one intentional difference: `actions` is a `Record<string, string>` event-type
-map rather than async handler functions, because the DOM renderer dispatches events
-directly via `send()` to an XState actor instead of calling framework action handlers.
+Mirrors `DefineRegistryOptions<C>` from @json-render/react, /solid, /svelte, /vue.
+`actions` accepts catalog-typed async handler functions — params are fully typed.
 ## Type Parameters
@@ -19,7 +17,7 @@ directly via `send()` to an XState actor instead of calling framework action han
 ## Properties
-| Property                                       | Type                                                                                                                                                             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Defined in                                                                                                                                   |
-| ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actions"></a> `actions?`       | `InferCatalogActions`\<`C`\> _extends_ `Record`\<`string`, `never`\> ? `Record`\<`string`, `string`\> : `Record`\<keyof `InferCatalogActions`\<`C`\>, `string`\> | Map of catalog action name → XState event type string. When a spec element fires `emit("login")`, the DOM renderer looks up `actions.login` (e.g. `"auth.login"`) and calls `send({ type: "auth.login", ...params })`. In the framework renderers this field holds async handler functions. In the DOM renderer it is a simpler string map because routing to the actor is handled by the XMachines play-dom layer rather than inside the json-render action system. | [json-render/types.ts:291](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L291) |
-| <a id="property-components"></a> `components?` | [`ComponentRegistry`](../type-aliases/ComponentRegistry.md)\<`C`\>                                                                                               | Catalog-typed component implementations. Each key must match a component declared in the catalog.                                                                                                                                                                                                                                                                                                                                                                    | [json-render/types.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L280) |
+| Property                                       | Type                                                               | Description                                                                                                                                                                                                                                                                                                                                  | Defined in                                                                                                                                   |
+| ---------------------------------------------- | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actions"></a> `actions?`       | [`Actions`](../type-aliases/Actions.md)\<`C`\>                     | Map of catalog action name → catalog-typed async handler function. Each handler receives params typed to the action's schema (or `undefined`). Guard against undefined before accessing params: **Example** `actions: { login: async (params) => { if (!params) return; actor.send({ type: 'auth.login', username: params.username }); }, }` | [json-render/types.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L165) |
+| <a id="property-components"></a> `components?` | [`ComponentRegistry`](../type-aliases/ComponentRegistry.md)\<`C`\> | Catalog-typed component implementations.                                                                                                                                                                                                                                                                                                     | [json-render/types.ts:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L148) |

package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md CHANGED Viewed

@@ -2,17 +2,16 @@
 # Interface: DefineRegistryResult
-Defined in: [json-render/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L303)
+Defined in: [json-render/types.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L174)
 Result returned by `defineRegistry`.
-Mirrors the `{ registry }` field from @json-render/react, /solid, /svelte, /vue.
-The DOM result also exposes `actorActions` — the resolved event-type map — so
-callers can pass it directly to `connectRenderer` or `PlayRenderer`.
+Matches `DefineRegistryResult` from @json-render/react, /solid, /svelte, /vue —
+returns `{ registry, handlers }` instead of the old `{ registry, actorActions }`.
 ## Properties
-| Property                                          | Type                                            | Description                                                                                                                                                                                             | Defined in                                                                                                                                   |
-| ------------------------------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actoractions"></a> `actorActions` | `Record`\<`string`, `string`\>                  | Resolved map of catalog action name → XState event type string. Pass to `connectRenderer({ ..., actions: actorActions })` or `new PlayRenderer(container, actor, registry, { actions: actorActions })`. | [json-render/types.ts:314](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L314) |
-| <a id="property-registry"></a> `registry`         | [`DomRegistry`](../type-aliases/DomRegistry.md) | The built `DomRegistry`, ready to pass to `connectRenderer` or `PlayRenderer`.                                                                                                                          | [json-render/types.ts:307](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L307) |
+| Property                                  | Type                                                                 | Description                                                                                                                                                                                                                                | Defined in                                                                                                                                   |
+| ----------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-handlers"></a> `handlers` | (`getSetState`, `getState`) => `Record`\<`string`, `ActionHandler`\> | Create ActionProvider-compatible handlers. Accepts getter functions so handlers always read the latest state. For DOM rendering, pass `() => undefined, () => ({})` since DOM actions dispatch directly to actor without needing setState. | [json-render/types.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L185) |
+| <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md)                      | The built `DomRegistry`, ready to pass to `connectRenderer` or `PlayRenderer`.                                                                                                                                                             | [json-render/types.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L178) |

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

@@ -2,20 +2,17 @@
 # Interface: DomRenderContext
-Defined in: [json-render/types.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L68)
+Defined in: [json-render/types.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L52)
 Low-level render context passed to each `DomComponentRenderer`.
-This is the raw renderer-level interface. Most component authors should use
-the higher-level `ComponentContext<C, K>` provided by `defineRegistry`.
 ## Properties
-| Property                                                 | Type                           | Description                                                                                                                                                                                                                                             | Defined in                                                                                                                                 |
-| -------------------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-actoractions"></a> `actorActions`        | `Record`\<`string`, `string`\> | Map of json-render catalog action names → dispatch event type strings.                                                                                                                                                                                  | [json-render/types.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L76) |
-| <a id="property-elementbindings"></a> `elementBindings?` | `Record`\<`string`, `string`\> | Pre-computed two-way binding paths for this element's props. Resolved from raw props before `resolveElementProps` runs — the resolved props no longer contain `$bindState`/`$bindItem` expressions. `undefined` when no binding expressions were found. | [json-render/types.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L85) |
-| <a id="property-renderchildren"></a> `renderChildren`    | (`keys`) => `Node`[]           | Render a list of child element keys into DOM nodes.                                                                                                                                                                                                     | [json-render/types.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L78) |
-| <a id="property-send"></a> `send`                        | (`event`) => `void`            | Dispatch an event (e.g. to an XState actor).                                                                                                                                                                                                            | [json-render/types.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L74) |
-| <a id="property-spec"></a> `spec`                        | `Spec`                         | Full spec tree for this render pass.                                                                                                                                                                                                                    | [json-render/types.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L70) |
-| <a id="property-store"></a> `store`                      | `StateStore`                   | Live state store bound to `spec.state`.                                                                                                                                                                                                                 | [json-render/types.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L72) |
+| Property                                                 | Type                                  | Description                                                              | Defined in                                                                                                                                 |
+| -------------------------------------------------------- | ------------------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-elementbindings"></a> `elementBindings?` | `Record`\<`string`, `string`\>        | Pre-computed two-way binding paths for this element's props.             | [json-render/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L66) |
+| <a id="property-handlers"></a> `handlers`                | `Record`\<`string`, `ActionHandler`\> | Map of json-render catalog action names → async ActionHandler functions. | [json-render/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L60) |
+| <a id="property-renderchildren"></a> `renderChildren`    | (`keys`) => `Node`[]                  | Render a list of child element keys into DOM nodes.                      | [json-render/types.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L62) |
+| <a id="property-send"></a> `send`                        | (`event`) => `void`                   | Dispatch an event (e.g. to an XState actor).                             | [json-render/types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L58) |
+| <a id="property-spec"></a> `spec`                        | `Spec`                                | Full spec tree for this render pass.                                     | [json-render/types.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L54) |
+| <a id="property-store"></a> `store`                      | `StateStore`                          | Live state store bound to `spec.state`.                                  | [json-render/types.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L56) |

package/api/@xmachines/play-dom/interfaces/EventHandle.md CHANGED Viewed

@@ -2,28 +2,14 @@
 # Interface: EventHandle
-Defined in: [json-render/types.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L48)
+Defined in: [json-render/types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L36)
 Handle returned by `ComponentContext.on(eventName)`.
-Matches the `EventHandle` interface from @json-render/react, /solid, /svelte, /vue.
-## Example
-```ts
-const handle = on("submit");
-if (handle.bound) {
-	btn.addEventListener("click", (e) => {
-		if (handle.shouldPreventDefault) e.preventDefault();
-		handle.emit();
-	});
-}
-```
 ## Properties
-| Property                                                          | Type         | Description                                                                                                                  | Defined in                                                                                                                                 |
-| ----------------------------------------------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-bound"></a> `bound`                               | `boolean`    | `true` if an `on` binding exists for this event name; `false` otherwise.                                                     | [json-render/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L57) |
-| <a id="property-emit"></a> `emit`                                 | () => `void` | Fire the bound action, resolving params from the current state store.                                                        | [json-render/types.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L50) |
-| <a id="property-shouldpreventdefault"></a> `shouldPreventDefault` | `boolean`    | Whether any binding for this event has `preventDefault: true`. Use to call `e.preventDefault()` on the triggering DOM event. | [json-render/types.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L55) |
+| Property                                                          | Type         | Description                                                              | Defined in                                                                                                                                 |
+| ----------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-bound"></a> `bound`                               | `boolean`    | `true` if an `on` binding exists for this event name; `false` otherwise. | [json-render/types.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L44) |
+| <a id="property-emit"></a> `emit`                                 | () => `void` | Fire the bound action, resolving params from the current state store.    | [json-render/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L38) |
+| <a id="property-shouldpreventdefault"></a> `shouldPreventDefault` | `boolean`    | Whether any binding for this event has `preventDefault: true`.           | [json-render/types.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L42) |

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

@@ -2,13 +2,13 @@
 # Interface: PlayDomOptions
-Defined in: [xm-types.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L18)
+Defined in: [xm-types.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L18)
 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                                                                                                                                                                                                                                                                                                                   | [xm-types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L20) |
-| <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. | [xm-types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L29) |
+| Property                                   | Type                                  | Description                                                                                                                                                                                                                                                                                                                                                         | Defined in                                                                                                               |
+| ------------------------------------------ | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Map of catalog action name → async ActionHandler function. Replaces the old `actions: Record<string, string>` string-map approach.                                                                                                                                                                                                                                  | [xm-types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L23) |
+| <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. | [xm-types.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L32) |

package/api/@xmachines/play-dom/type-aliases/ActionFn.md ADDED Viewed

@@ -0,0 +1,30 @@
+[Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / ActionFn
+# Type Alias: ActionFn\<C, K\>
+```ts
+type ActionFn<C, K> = (params) => Promise<void>;
+```
+Defined in: [json-render/types.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L126)
+Catalog-typed action function — mirrors `ActionFn<C, K>` from @json-render/react, /solid, /vue.
+`params` is typed to the exact param schema defined in the catalog, or `undefined` if no spec
+provided params. The handler must guard against undefined before accessing params.
+## Type Parameters
+| Type Parameter                                   |
+| ------------------------------------------------ |
+| `C` _extends_ `Catalog`                          |
+| `K` _extends_ keyof `InferCatalogActions`\<`C`\> |
+## Parameters
+| Parameter | Type                                           |
+| --------- | ---------------------------------------------- |
+| `params`  | `InferActionParams`\<`C`, `K`\> \| `undefined` |
+## Returns
+`Promise`\<`void`\>

package/api/@xmachines/play-dom/type-aliases/Actions.md ADDED Viewed

@@ -0,0 +1,18 @@
+[Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / Actions
+# Type Alias: Actions\<C\>
+```ts
+type Actions<C> = { [K in keyof InferCatalogActions<C>]: ActionFn<C, K> };
+```
+Defined in: [json-render/types.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L134)
+Map of catalog-typed action handler functions.
+Each key is a catalog action name; each value is an `ActionFn<C, K>` for that action.
+## Type Parameters
+| Type Parameter          |
+| ----------------------- |
+| `C` _extends_ `Catalog` |

package/api/@xmachines/play-dom/type-aliases/ComponentFn.md CHANGED Viewed

@@ -6,15 +6,7 @@
 type ComponentFn<C, K> = (ctx) => HTMLElement | Text | null;
 ```
-Defined in: [json-render/types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L238)
-Catalog-typed DOM component function.
-The DOM equivalent of `ComponentFn<C, K>` from @json-render/react, /solid,
-/svelte, /vue. The only structural difference is the return type:
-`HTMLElement | Text | null` instead of a framework node.
-Pass implementations to `defineRegistry` — do not call directly.
+Defined in: [json-render/types.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L105)
 ## Type Parameters
@@ -32,22 +24,3 @@ Pass implementations to `defineRegistry` — do not call directly.
 ## Returns
 `HTMLElement` \| `Text` \| `null`
-## Example
-```ts
-import type { ComponentFn } from "@xmachines/play-dom";
-import type { AuthCatalog } from "@xmachines/play-actor-shared";
-export const Home: ComponentFn<AuthCatalog, "Home"> = ({ props, children }) => {
-	const section = document.createElement("section");
-	section.setAttribute("data-page", "home");
-	const h2 = document.createElement("h2");
-	h2.textContent = props.title;
-	section.appendChild(h2);
-	children.forEach((child) => section.appendChild(child));
-	return section;
-};
-```

package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md CHANGED Viewed

@@ -6,13 +6,7 @@
 type ComponentRegistry<C> = { [K in keyof InferCatalogComponents<C>]: ComponentFn<C, K> };
 ```
-Defined in: [json-render/types.ts:251](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L251)
-Catalog-keyed map of `ComponentFn` implementations.
-Used as the `components` field in `DefineRegistryOptions`.
-TypeScript enforces that every component key declared in the catalog has
-a matching implementation.
+Defined in: [json-render/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L111)
 ## Type Parameters

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

@@ -6,13 +6,7 @@
 type DomComponentRenderer = (element, ctx) => HTMLElement | Text | null;
 ```
-Defined in: [json-render/types.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L106)
-Raw DOM component renderer function.
-Receives a resolved `UIElement` and a `DomRenderContext`, and returns a DOM
-node or `null`. Prefer using `ComponentFn<C, K>` via `defineRegistry` for
-catalog-typed, framework-consistent components.
+Defined in: [json-render/types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L71)
 ## Parameters
@@ -24,13 +18,3 @@ catalog-typed, framework-consistent components.
 ## Returns
 `HTMLElement` \| `Text` \| `null`
-## Example
-```ts
-const myRenderer: DomComponentRenderer = (element, ctx) => {
-	const el = document.createElement("div");
-	el.textContent = String(element.props.title ?? "");
-	return el;
-};
-```

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

@@ -6,9 +6,4 @@
 type DomRegistry = Record<string, DomComponentRenderer>;
 ```
-Defined in: [json-render/types.ts:263](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L263)
-Raw registry of `DomComponentRenderer` functions keyed by element type.
-Passed to `connectRenderer` or `PlayRenderer`. Build with `defineRegistry`
-to get catalog-typed component functions automatically wrapped.
+Defined in: [json-render/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L117)

package/api/@xmachines/play-dom/type-aliases/DomSchema.md ADDED Viewed

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / DomSchema
+# Type Alias: DomSchema
+```ts
+type DomSchema = typeof schema;
+```
+Defined in: [json-render/schema.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/schema.ts#L60)

package/api/@xmachines/play-dom/variables/schema.md ADDED Viewed

@@ -0,0 +1,56 @@
+[Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / schema
+# Variable: schema
+```ts
+const schema: Schema<{
+	catalog: SchemaType<
+		"object",
+		{
+			actions: SchemaType<
+				"map",
+				{
+					description: SchemaType<"string", unknown>;
+					params: SchemaType<"zod", unknown>;
+				}
+			>;
+			components: SchemaType<
+				"map",
+				{
+					description: SchemaType<"string", unknown>;
+					example: SchemaType<"any", unknown>;
+					props: SchemaType<"zod", unknown>;
+					slots: SchemaType<"array", SchemaType<"string", unknown>>;
+				}
+			>;
+		}
+	>;
+	spec: SchemaType<
+		"object",
+		{
+			elements: SchemaType<
+				"record",
+				SchemaType<
+					"object",
+					{
+						children: SchemaType<"array", SchemaType<"string", unknown>>;
+						props: SchemaType<"propsOf", string>;
+						type: SchemaType<"ref", string>;
+						visible: SchemaType<"any", unknown>;
+					}
+				>
+			>;
+			root: SchemaType<"string", unknown>;
+		}
+	>;
+}>;
+```
+Defined in: [json-render/schema.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/schema.ts#L20)
+The schema for @xmachines/play-dom
+Defines:
+- Spec: A flat tree of elements with keys, types, props, children, and on-bindings
+- Catalog: Components with props schemas, and optional actions with param schemas

package/api/@xmachines/play-dom-router/functions/connectRouter.md CHANGED Viewed

@@ -6,7 +6,7 @@
 function connectRouter(options): () => void;
 ```
-Defined in: [play-dom-router/src/connect-router.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/connect-router.ts#L48)
+Defined in: [play-dom-router/src/connect-router.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/connect-router.ts#L48)
 Connect vanilla router to actor (pure browser integration).

package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md CHANGED Viewed

@@ -6,7 +6,7 @@
 function createBrowserHistory(options): BrowserHistory;
 ```
-Defined in: [play-dom-router/src/create-browser-history.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L120)
+Defined in: [play-dom-router/src/create-browser-history.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L120)
 Create browser history that wraps window.history

package/api/@xmachines/play-dom-router/functions/createRouteMap.md CHANGED Viewed

@@ -6,7 +6,7 @@
 function createRouteMap(machine): RouteMap;
 ```
-Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/create-route-map-from-machine.ts#L26)
+Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/create-route-map-from-machine.ts#L26)
 Create a `BaseRouteMap` from an XState state machine.

package/api/@xmachines/play-dom-router/functions/createRouter.md CHANGED Viewed

@@ -6,7 +6,7 @@
 function createRouter(options): VanillaRouter;
 ```
-Defined in: [play-dom-router/src/create-router.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-router.ts#L52)
+Defined in: [play-dom-router/src/create-router.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-router.ts#L52)
 Create vanilla router for framework-agnostic routing.

package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md CHANGED Viewed

@@ -2,17 +2,17 @@
 # Interface: BrowserHistory
-Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L1)
+Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L1)
 ## Properties
 | Property                                  | Modifier   | Type      | Description                | Defined in                                                                                                                                                                    |
 | ----------------------------------------- | ---------- | --------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-location"></a> `location` | `readonly` | `object`  | Get current location state | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L5) |
-| `location.hash`                           | `public`   | `string`  | -                          | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L8) |
-| `location.pathname`                       | `public`   | `string`  | -                          | [play-dom-router/src/create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L6) |
-| `location.search`                         | `public`   | `string`  | -                          | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L7) |
-| `location.state`                          | `public`   | `unknown` | -                          | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L9) |
+| <a id="property-location"></a> `location` | `readonly` | `object`  | Get current location state | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L5) |
+| `location.hash`                           | `public`   | `string`  | -                          | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L8) |
+| `location.pathname`                       | `public`   | `string`  | -                          | [play-dom-router/src/create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L6) |
+| `location.search`                         | `public`   | `string`  | -                          | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L7) |
+| `location.state`                          | `public`   | `unknown` | -                          | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L9) |
 ## Methods
@@ -22,7 +22,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com
 back(): void;
 ```
-Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L26)
+Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L26)
 #### Returns
@@ -36,7 +36,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.co
 createHref(path): string;
 ```
-Defined in: [play-dom-router/src/create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L38)
+Defined in: [play-dom-router/src/create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L38)
 Create href from path
@@ -58,7 +58,7 @@ Create href from path
 destroy(): void;
 ```
-Defined in: [play-dom-router/src/create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L47)
+Defined in: [play-dom-router/src/create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L47)
 Cleanup.
@@ -78,7 +78,7 @@ wrapper is destroyed.
 forward(): void;
 ```
-Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L27)
+Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L27)
 #### Returns
@@ -92,7 +92,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.co
 go(delta): void;
 ```
-Defined in: [play-dom-router/src/create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L25)
+Defined in: [play-dom-router/src/create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L25)
 Go back/forward
@@ -114,7 +114,7 @@ Go back/forward
 push(path, state?): void;
 ```
-Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L15)
+Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L15)
 Push new URL to history
@@ -137,7 +137,7 @@ Push new URL to history
 replace(path, state?): void;
 ```
-Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L20)
+Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L20)
 Replace current URL in history
@@ -160,7 +160,7 @@ Replace current URL in history
 subscribe(listener): () => void;
 ```
-Defined in: [play-dom-router/src/create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom-router/src/create-browser-history.ts#L33)
+Defined in: [play-dom-router/src/create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L33)
 Subscribe to history changes
 Returns unsubscribe function