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

package/api/@xmachines/play-react/interfaces/PlayRendererProps.md

@@ -1,24 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-react](../README.md) / PlayRendererProps
-
-# Interface: PlayRendererProps\<TLogic\>
-
-Defined in: [packages/play-react/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/types.ts#L27)
-
-Props for PlayRenderer component
-
-## Type Parameters
-
-| Type Parameter                                                                           | Default type                                                          | Description                                                                     |
-| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
-| `TLogic` _extends_ [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | The XState actor logic type. Defaults to `AnyActorLogic` for non-generic usage. |
-
-## Properties
-
-| Property                                              | Type                                                                                                                                                                                                | Description                                                                                                                                                                                                                                                                                                                                                                                                                           | Defined in                                                                                                                                   |
-| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                   | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability)                                                                                                                                                                                                                                                                                                                                                                 | [packages/play-react/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/types.ts#L29) |
-| <a id="property-fallback"></a> `fallback?`            | `ReactNode`                                                                                                                                                                                         | Optional component shown when currentView is null                                                                                                                                                                                                                                                                                                                                                                                     | [packages/play-react/src/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/types.ts#L60) |
-| <a id="property-onerror"></a> `onError?`              | (`error`, `info`) => `void`                                                                                                                                                                         | Optional callback invoked when a catalog component throws during render.                                                                                                                                                                                                                                                                                                                                                              | [packages/play-react/src/types.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/types.ts#L72) |
-| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                       | Called when an individual catalog component throws during render. Caught by the inner error boundary inside each rendered element — the failed component is silently removed while the rest of the spec continues rendering. Unlike `onError`, this does not receive a reset callback. Takes precedence over any `onRenderError` set via `defineRegistry`. When not provided, `@json-render/react` logs the error to `console.error`. | [packages/play-react/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/types.ts#L84) |
-| <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult`                                                                                                                                                                              | Full result from defineRegistry() in @json-render/react. Contains both the component registry and the action handlers factory. Action handlers are real async functions dispatching to the actor (not string-mapped event types).                                                                                                                                                                                                     | [packages/play-react/src/types.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/types.ts#L48) |
-| <a id="property-store"></a> `store?`                  | `StateStore`                                                                                                                                                                                        | Optional external StateStore (controlled mode).                                                                                                                                                                                                                                                                                                                                                                                       | [packages/play-react/src/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/types.ts#L57) |

package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md

@@ -1,24 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-solid](../README.md) / PlayRendererProps
-
-# Interface: PlayRendererProps\<TLogic\>
-
-Defined in: [packages/play-solid/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-solid/src/types.ts#L26)
-
-Props for PlayRenderer component
-
-## Type Parameters
-
-| Type Parameter                                                                           | Default type                                                          | Description                                                                     |
-| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
-| `TLogic` _extends_ [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | The XState actor logic type. Defaults to `AnyActorLogic` for non-generic usage. |
-
-## Properties
-
-| Property                                              | Type                                                                                                                                                                                                | Description                                                                                                                                                                                                                                                                                                                                                                                                                           | Defined in                                                                                                                                   |
-| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                   | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability)                                                                                                                                                                                                                                                                                                                                                                 | [packages/play-solid/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-solid/src/types.ts#L28) |
-| <a id="property-fallback"></a> `fallback?`            | `any`                                                                                                                                                                                               | Optional element shown when currentView is null or a component throws                                                                                                                                                                                                                                                                                                                                                                 | [packages/play-solid/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-solid/src/types.ts#L38) |
-| <a id="property-onerror"></a> `onError?`              | (`error`) => `void`                                                                                                                                                                                 | Optional callback invoked when a catalog component throws during render.                                                                                                                                                                                                                                                                                                                                                              | [packages/play-solid/src/types.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-solid/src/types.ts#L45) |
-| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                       | Called when an individual catalog component throws during render. Caught by the inner error boundary inside each rendered element — the failed component is silently removed while the rest of the spec continues rendering. Unlike `onError`, this does not receive a reset callback. Takes precedence over any `onRenderError` set via `defineRegistry`. When not provided, `@json-render/solid` logs the error to `console.error`. | [packages/play-solid/src/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-solid/src/types.ts#L57) |
-| <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult`                                                                                                                                                                              | Full result from defineRegistry() in @json-render/solid. Contains both the component registry and the action handlers factory. Action handlers are real async functions dispatching to the actor (not string-mapped event types).                                                                                                                                                                                                     | [packages/play-solid/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-solid/src/types.ts#L35) |
-| <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.                                                                   | [packages/play-solid/src/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-solid/src/types.ts#L66) |

package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md

@@ -1,22 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / PlayRendererProps
-
-# Interface: PlayRendererProps\<TLogic\>
-
-Defined in: [packages/play-svelte/src/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/types.ts#L13)
-
-## Type Parameters
-
-| Type Parameter                                                                           | Default type                                                          |
-| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
-| `TLogic` _extends_ [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) |
-
-## Properties
-
-| Property                                              | Type                                                                                                                                                                                                | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Defined in                                                                                                                                     |
-| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                   | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [packages/play-svelte/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/types.ts#L14) |
-| <a id="property-fallback"></a> `fallback?`            | `Snippet`\<\[\]\>                                                                                                                                                                                   | Svelte snippet rendered when currentView is null (no active view). Also shown when a catalog component throws during render.                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | [packages/play-svelte/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/types.ts#L29) |
-| <a id="property-onerror"></a> `onError?`              | (`error`, `reset`) => `void`                                                                                                                                                                        | Called when a catalog component throws during render. Receives the thrown error and a `reset` function that clears the boundary and attempts to re-render. Matches Svelte 5's `<svelte:boundary onerror>` signature.                                                                                                                                                                                                                                                                                                                                                                                     | [packages/play-svelte/src/types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/types.ts#L36) |
-| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                       | Called when an individual catalog component throws during render. Caught by the inner `<svelte:boundary>` inside each rendered element — the failed component is silently removed from the DOM while the rest of the spec continues rendering. Unlike `onError`, this does not take a `reset` callback because the inner boundary never re-renders the failed element. When not provided, `@json-render/svelte` logs the error to `console.error`. **Example** `<PlayRenderer {actor} {registryResult} onRenderError={(error, elementType) => { console.warn(`<${elementType}> crashed:`, error); }} />` | [packages/play-svelte/src/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/types.ts#L60) |
-| <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult`                                                                                                                                                                              | Full result from defineRegistry() — contains component registry and action handlers. Action handlers are async functions that dispatch to the actor (not string-mapped event type stubs). Replaces the old `registry` + `actions` prop pair.                                                                                                                                                                                                                                                                                                                                                             | [packages/play-svelte/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/types.ts#L21) |
-| <a id="property-store"></a> `store?`                  | `StateStore`                                                                                                                                                                                        | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [packages/play-svelte/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/types.ts#L23) |

package/api/@xmachines/play-svelte/variables/getBoundProp.md

@@ -1,7 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / getBoundProp
-
-# Variable: getBoundProp
-
-```ts
-getBoundProp: any;
-```

package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md

@@ -1,22 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / PlayRendererProps
-
-# Interface: PlayRendererProps\<TLogic\>
-
-Defined in: [packages/play-vue/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-vue/src/types.ts#L23)
-
-Props for PlayRenderer component
-
-## Type Parameters
-
-| Type Parameter                                                                           | Default type                                                          | Description                                                                     |
-| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
-| `TLogic` _extends_ [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | The XState actor logic type. Defaults to `AnyActorLogic` for non-generic usage. |
-
-## Properties
-
-| Property                                              | Type                                                                                                                                                                                                | Description                                                                                                                                                                                                                                                                                                                                                               | Defined in                                                                                                                               |
-| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                   | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability)                                                                                                                                                                                                                                                                                                     | [packages/play-vue/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-vue/src/types.ts#L25) |
-| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                       | Called when an individual catalog component throws during render. Caught by the inner error boundary inside each rendered element — the failed component is silently removed while the rest of the spec continues rendering. Takes precedence over any `onRenderError` set via `defineRegistry`. When not provided, `@json-render/vue` logs the error to `console.error`. | [packages/play-vue/src/types.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-vue/src/types.ts#L52) |
-| <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult`                                                                                                                                                                              | Full result from defineRegistry() in @json-render/vue. Contains both the component registry and the action handlers factory. Action handlers are real async functions dispatching to the actor (not string-mapped event types).                                                                                                                                           | [packages/play-vue/src/types.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-vue/src/types.ts#L32) |
-| <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.       | [packages/play-vue/src/types.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-vue/src/types.ts#L41) |