@xmachines/docs 1.0.0-beta.9 → 1.0.0

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

@@ -0,0 +1,32 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / defineRegistry
+
+# Function: defineRegistry()
+
+```ts
+function defineRegistry<C>(catalog, options): DefineRegistryResult;
+```
+
+Defined in: [packages/play-vue/src/define-registry.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/define-registry.ts#L131)
+
+Create a component registry, automatically wrapping `.vue` SFCs so they work
+correctly with `@xmachines/json-render-vue`'s rendering pipeline.
+
+Drop-in replacement for `defineRegistry` from `@xmachines/json-render-vue`. Import from
+`@xmachines/play-vue` to get SFC support for free.
+
+## Type Parameters
+
+| Type Parameter                                                                                                                       |
+| ------------------------------------------------------------------------------------------------------------------------------------ |
+| `C` _extends_ `Catalog`\<`SchemaDefinition`\<`SchemaType`\<`string`, `unknown`\>, `SchemaType`\<`string`, `unknown`\>\>, `unknown`\> |
+
+## Parameters
+
+| Parameter | Type                                                                       | Description                                                                                                                            |
+| --------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
+| `catalog` | `C`                                                                        | The json-render catalog defining component prop shapes.                                                                                |
+| `options` | [`DefineRegistryOptions`](../type-aliases/DefineRegistryOptions.md)\<`C`\> | Registry options. `components` entries may be `.vue` SFCs (objects) or plain `ComponentFn` functions — both are handled automatically. |
+
+## Returns
+
+[`DefineRegistryResult`](../interfaces/DefineRegistryResult.md)

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

@@ -0,0 +1,28 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / getPlayViewContext
+
+# Function: getPlayViewContext()
+
+```ts
+function getPlayViewContext(): ViewContextValue;
+```
+
+Defined in: [packages/play-vue/src/actor-provider-context.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/actor-provider-context.ts#L44)
+
+Access the current ViewContextValue from inside an ActorProvider tree.
+
+## Returns
+
+[`ViewContextValue`](../interfaces/ViewContextValue.md)
+
+## Throws
+
+If called outside an <ActorProvider> (or <PlayUIProvider>) tree
+
+## Example
+
+```typescript
+import { getPlayViewContext } from "@xmachines/play-vue";
+
+const view = getPlayViewContext();
+// view.spec, view.handlers, view.registry
+```

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

@@ -0,0 +1,13 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / useActor
+
+# Function: useActor()
+
+```ts
+function useActor(): AnyPlayActor;
+```
+
+Defined in: [packages/play-vue/src/useActor.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/useActor.ts#L58)
+
+## Returns
+
+[`AnyPlayActor`](../type-aliases/AnyPlayActor.md)

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

@@ -0,0 +1,45 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / useBoundProp
+
+# Function: useBoundProp()
+
+```ts
+function useBoundProp<T>(propValue, bindingPath): [T | undefined, (value) => void];
+```
+
+Defined in: `@xmachines/json-render-vue`
+
+Composable for two-way bound props. Returns `[value, setValue]` where:
+
+- `value` is the already-resolved prop value (passed through from render props)
+- `setValue` writes back to the bound state path (no-op if not bound)
+
+Designed to work with the `bindings` map that the renderer provides when
+a prop uses `{ $bindState: "/path" }` or `{ $bindItem: "field" }`.
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+## Parameters
+
+| Parameter     | Type                    |
+| ------------- | ----------------------- |
+| `propValue`   | `T` \| `undefined`      |
+| `bindingPath` | `string` \| `undefined` |
+
+## Returns
+
+\[`T` \| `undefined`, (`value`) => `void`\]
+
+## Example
+
+```ts
+import { useBoundProp } from "@xmachines/json-render-vue";
+
+const Input: ComponentFn<AppCatalog, "Input"> = ({ props, bindings }) => {
+	const [value, setValue] = useBoundProp<string>(props.value as string, bindings?.value);
+	return h("input", { value: value ?? "", onInput: (e) => setValue(e.target.value) });
+};
+```

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

@@ -0,0 +1,12 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / ActionProviderProps
+
+# Interface: ActionProviderProps
+
+Defined in: `@xmachines/json-render-vue`
+
+## Properties
+
+| Property                                   | Type                                  | Defined in |
+| ------------------------------------------ | ------------------------------------- | ---------- |
+| <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | -          |
+| <a id="property-navigate"></a> `navigate?` | (`path`) => `void`                    | -          |

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

@@ -0,0 +1,25 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / ActorProviderProps
+
+# Interface: ActorProviderProps
+
+Defined in: [packages/play-vue/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/types.ts#L14)
+
+Props for the ActorProvider component.
+Extracted to types.ts so TypeScript can re-export without the vue-shim limitation.
+
+## Extends
+
+- [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md)\<[`DefineRegistryResult`](DefineRegistryResult.md)\>
+
+## Extended by
+
+- [`PlayUIProviderProps`](PlayUIProviderProps.md)
+
+## Properties
+
+| Property                                              | Type                                                                                                                                                                                                                                                             | Description                                                                                                                                                                                                                 | Inherited from                                                                                                                                                                      | 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) | Actor instance with currentView signal (requires Viewable capability).                                                                                                                                                      | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor)                   | [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L159) |
+| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                                                                                    | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry.                                                                                           | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror)   | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L172) |
+| <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md)                                                                                                                                                                                                                | Full result from defineRegistry() — contains the component registry and action handlers factory.                                                                                                                            | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L161) |
+| <a id="property-store"></a> `store?`                  | `StateStore`                                                                                                                                                                                                                                                     | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store)                   | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L167) |

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

@@ -0,0 +1,37 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / ComponentContext
+
+# Interface: ComponentContext\<C, K\>
+
+Defined in: `@xmachines/json-render-vue`
+
+Context passed to component render functions
+
+## Example
+
+```ts
+const Button: ComponentFn<typeof catalog, "Button"> = (ctx) => {
+	return h("button", { onClick: () => ctx.emit("press") }, ctx.props.label);
+};
+```
+
+## Extends
+
+- `BaseComponentProps`\<`InferComponentProps`\<`C`, `K`\>\>
+
+## Type Parameters
+
+| Type Parameter                                      |
+| --------------------------------------------------- |
+| `C` _extends_ `Catalog`                             |
+| `K` _extends_ keyof `InferCatalogComponents`\<`C`\> |
+
+## Properties
+
+| Property                                   | Type                                                                                                                                                                    | Description                                                                                                                      | Inherited from                | Defined in |
+| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | ---------- |
+| <a id="property-bindings"></a> `bindings?` | `Record`\<`string`, `string`\>                                                                                                                                          | Two-way binding paths resolved from `$bindState` / `$bindItem` expressions. Maps prop name → absolute state path for write-back. | `BaseComponentProps.bindings` | -          |
+| <a id="property-children"></a> `children?` | \| `VNode`\<`RendererNode`, `RendererElement`, \{ \[`key`: `string`\]: `any`; \}\> \| `VNode`\<`RendererNode`, `RendererElement`, \{ \[`key`: `string`\]: `any`; \}\>[] | Rendered children (from the default slot)                                                                                        | `BaseComponentProps.children` | -          |
+| <a id="property-emit"></a> `emit`          | (`event`) => `void`                                                                                                                                                     | Simple event emitter (shorthand). Fires the event and returns void.                                                              | `BaseComponentProps.emit`     | -          |
+| <a id="property-loading"></a> `loading?`   | `boolean`                                                                                                                                                               | -                                                                                                                                | `BaseComponentProps.loading`  | -          |
+| <a id="property-on"></a> `on`              | (`event`) => `EventHandle`                                                                                                                                              | Get an event handle with metadata. Use when you need shouldPreventDefault or bound checks.                                       | `BaseComponentProps.on`       | -          |
+| <a id="property-props"></a> `props`        | `InferComponentProps`                                                                                                                                                   | -                                                                                                                                | `BaseComponentProps.props`    | -          |

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

@@ -0,0 +1,15 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / DefineRegistryResult
+
+# Interface: DefineRegistryResult
+
+Defined in: `@xmachines/json-render-vue`
+
+Result returned by defineRegistry
+
+## Properties
+
+| Property                                            | Type                                                                                   | Defined in |
+| --------------------------------------------------- | -------------------------------------------------------------------------------------- | ---------- |
+| <a id="property-executeaction"></a> `executeAction` | (`actionName`, `params`, `setState`, `state?`) => `Promise`\<`void`\>                  | -          |
+| <a id="property-handlers"></a> `handlers`           | (`getSetState`, `getState`) => `Record`\<`string`, (`params`) => `Promise`\<`void`\>\> | -          |
+| <a id="property-registry"></a> `registry`           | `ComponentRegistry`                                                                    | -          |

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

@@ -0,0 +1,21 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / JSONUIProviderProps
+
+# Interface: JSONUIProviderProps
+
+Defined in: `@xmachines/json-render-vue`
+
+Props for JSONUIProvider
+
+## Properties
+
+| Property                                                         | Type                                                                                                      | Description                                                    | Defined in |
+| ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ---------- |
+| <a id="property-directives"></a> `directives?`                   | `DirectiveDefinition`\<`ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>\>[] | Custom directives for user-defined `$`-prefixed dynamic values | -          |
+| <a id="property-functions"></a> `functions?`                     | `Record`\<`string`, `ComputedFunction`\>                                                                  | Named functions for `$computed` expressions in props           | -          |
+| <a id="property-handlers"></a> `handlers?`                       | `Record`\<`string`, (`params`) => `unknown`\>                                                             | -                                                              | -          |
+| <a id="property-initialstate"></a> `initialState?`               | `Record`\<`string`, `unknown`\>                                                                           | -                                                              | -          |
+| <a id="property-navigate"></a> `navigate?`                       | (`path`) => `void`                                                                                        | -                                                              | -          |
+| <a id="property-onstatechange"></a> `onStateChange?`             | (`changes`) => `void`                                                                                     | -                                                              | -          |
+| <a id="property-registry"></a> `registry`                        | `ComponentRegistry`                                                                                       | -                                                              | -          |
+| <a id="property-store"></a> `store?`                             | `StateStore`                                                                                              | -                                                              | -          |
+| <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\>                                                     | -                                                              | -          |

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

@@ -0,0 +1,24 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / PlayUIProviderProps
+
+# Interface: PlayUIProviderProps
+
+Defined in: [packages/play-vue/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/types.ts#L25)
+
+Props for the ActorProvider component.
+Extracted to types.ts so TypeScript can re-export without the vue-shim limitation.
+
+## Extends
+
+- [`ActorProviderProps`](ActorProviderProps.md)
+
+## Properties
+
+| Property                                                         | Type                                                                                                                                                                                                                                                             | Description                                                                                                                                                                                                                 | Inherited from                                                                                                  | 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) | Actor instance with currentView signal (requires Viewable capability).                                                                                                                                                      | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor)                   | [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L159) |
+| <a id="property-functions"></a> `functions?`                     | `Record`\<`string`, (`args?`, `state?`) => `unknown`\>                                                                                                                                                                                                           | Named functions for $computed expressions in props                                                                                                                                                                          | -                                                                                                               | [packages/play-vue/src/types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/types.ts#L34)                         |
+| <a id="property-navigate"></a> `navigate?`                       | (`path`) => `void`                                                                                                                                                                                                                                               | Navigate function forwarded to JSONUIProvider for link resolution                                                                                                                                                           | -                                                                                                               | [packages/play-vue/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/types.ts#L27)                         |
+| <a id="property-onrendererror"></a> `onRenderError?`             | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                                                                                    | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry.                                                                                           | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror)   | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L172) |
+| <a id="property-registryresult"></a> `registryResult`            | [`DefineRegistryResult`](DefineRegistryResult.md)                                                                                                                                                                                                                | Full result from defineRegistry() — contains the component registry and action handlers factory.                                                                                                                            | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L161) |
+| <a id="property-store"></a> `store?`                             | `StateStore`                                                                                                                                                                                                                                                     | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store)                   | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L167) |
+| <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\>                                                                                                                                                                                                            | Validation functions forwarded to JSONUIProvider                                                                                                                                                                            | -                                                                                                               | [packages/play-vue/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/types.ts#L29)                         |

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

@@ -0,0 +1,17 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / RendererProps
+
+# Interface: RendererProps
+
+Defined in: `@xmachines/json-render-vue`
+
+Props for the Renderer component
+
+## Properties
+
+| Property                                             | Type                                                          | Description                                                     | Defined in |
+| ---------------------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------- | ---------- |
+| <a id="property-fallback"></a> `fallback?`           | `Component`                                                   | -                                                               | -          |
+| <a id="property-loading"></a> `loading?`             | `boolean`                                                     | -                                                               | -          |
+| <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Callback for element render errors caught by the inner boundary | -          |
+| <a id="property-registry"></a> `registry`            | `ComponentRegistry`                                           | -                                                               | -          |
+| <a id="property-spec"></a> `spec`                    | `Spec` \| `null`                                              | -                                                               | -          |

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

@@ -0,0 +1,15 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / StateProviderProps
+
+# Interface: StateProviderProps
+
+Defined in: `@xmachines/json-render-vue`
+
+Props for StateProvider
+
+## Properties
+
+| Property                                             | Type                  | Description                                                                                                                                                                                   | Defined in |
+| ---------------------------------------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
+| <a id="property-initialstate"></a> `initialState?`   | `StateModel`          | Initial state model (used only in uncontrolled mode)                                                                                                                                          | -          |
+| <a id="property-onstatechange"></a> `onStateChange?` | (`changes`) => `void` | Callback when state changes (used only in uncontrolled mode). Called once per `set` or `update` with all changed entries.                                                                     | -          |
+| <a id="property-store"></a> `store?`                 | `StateStore`          | External store that owns the state. When provided, the provider operates in **controlled mode** — `initialState` and `onStateChange` are ignored and the store is the single source of truth. | -          |

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

@@ -0,0 +1,11 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / ValidationProviderProps
+
+# Interface: ValidationProviderProps
+
+Defined in: `@xmachines/json-render-vue`
+
+## Properties
+
+| Property                                                 | Type                                       | Defined in |
+| -------------------------------------------------------- | ------------------------------------------ | ---------- |
+| <a id="property-customfunctions"></a> `customFunctions?` | `Record`\<`string`, `ValidationFunction`\> | -          |

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

@@ -0,0 +1,21 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / ViewContextValue
+
+# Interface: ViewContextValue
+
+Defined in: [packages/play-vue/src/actor-provider-context.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/actor-provider-context.ts#L21)
+
+Context value provided by ActorProvider and consumed by PlayRenderer (zero-prop leaf).
+Accessible via getPlayViewContext() inside any ActorProvider/PlayUIProvider tree.
+
+## Extends
+
+- [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md)\<`ComponentRegistry`\>
+
+## Properties
+
+| Property                                  | Type                                                  | Description                                                                                               | Inherited from                                                                                                                                                    | Defined in                                                                                                                                               |
+| ----------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\>                 | Action handlers resolved against the live StateStore.                                                     | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L127) |
+| <a id="property-registry"></a> `registry` | `TRegistry`                                           | Component registry from registryResult.registry.                                                          | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L129) |
+| <a id="property-spec"></a> `spec`         | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render.                                                                           | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec)         | [packages/play-actor/src/abstract-actor.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L125) |
+| <a id="property-store"></a> `store`       | `StateStore`                                          | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store)       | [packages/play-actor/src/abstract-actor.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L131) |

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

@@ -0,0 +1,5 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / VisibilityProviderProps
+
+# Interface: VisibilityProviderProps
+
+Defined in: [packages/play-vue/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/types.ts#L23)

package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md

@@ -0,0 +1,11 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / AnyPlayActor
+
+# Type Alias: AnyPlayActor
+
+```ts
+type AnyPlayActor = AbstractActor<AnyActorLogic>;
+```
+
+Defined in: [packages/play-vue/src/useActor.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/useActor.ts#L41)
+
+Bare actor type accepted by Vue context providers. For the full routing + view shape, use `PlayActor` from `@xmachines/play-router`.

package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md

@@ -0,0 +1,16 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / ComponentEntry
+
+# Type Alias: ComponentEntry\<C, K\>
+
+```ts
+type ComponentEntry<C, K> = ComponentFn<C, K> | Component;
+```
+
+Defined in: [packages/play-vue/src/define-registry.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/define-registry.ts#L105)
+
+## Type Parameters
+
+| Type Parameter                                      |
+| --------------------------------------------------- |
+| `C` _extends_ `Catalog`                             |
+| `K` _extends_ keyof `InferCatalogComponents`\<`C`\> |

package/api/@xmachines/play-vue/type-aliases/ComponentFn.md

@@ -0,0 +1,35 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / ComponentFn
+
+# Type Alias: ComponentFn\<C, K\>
+
+```ts
+type ComponentFn<C, K> = (ctx) => VNode | VNode[] | null | string;
+```
+
+Defined in: `@xmachines/json-render-vue`
+
+Component render function type for Vue
+
+## Type Parameters
+
+| Type Parameter                                      |
+| --------------------------------------------------- |
+| `C` _extends_ `Catalog`                             |
+| `K` _extends_ keyof `InferCatalogComponents`\<`C`\> |
+
+## Parameters
+
+| Parameter | Type                                                                |
+| --------- | ------------------------------------------------------------------- |
+| `ctx`     | [`ComponentContext`](../interfaces/ComponentContext.md)\<`C`, `K`\> |
+
+## Returns
+
+`VNode` \| `VNode`[] \| `null` \| `string`
+
+## Example
+
+```ts
+const Button: ComponentFn<typeof catalog, "Button"> = ({ props, emit }) =>
+	h("button", { onClick: () => emit("press") }, props.label);
+```

package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md

@@ -0,0 +1,15 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / ComponentsMap
+
+# Type Alias: ComponentsMap\<C\>
+
+```ts
+type ComponentsMap<C> = { [K in keyof InferCatalogComponents<C>]?: ComponentEntry<C, K> };
+```
+
+Defined in: [packages/play-vue/src/define-registry.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/define-registry.ts#L109)
+
+## Type Parameters
+
+| Type Parameter          |
+| ----------------------- |
+| `C` _extends_ `Catalog` |

package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md

@@ -0,0 +1,22 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / DefineRegistryOptions
+
+# Type Alias: DefineRegistryOptions\<C\>
+
+```ts
+type DefineRegistryOptions<C> = Omit<Parameters<typeof defineRegistryBase>[1], "components"> &
+	object;
+```
+
+Defined in: [packages/play-vue/src/define-registry.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/define-registry.ts#L113)
+
+## Type Declaration
+
+| Name          | Type                                       | Defined in                                                                                                                                             |
+| ------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue/src/define-registry.ts#L117) |
+
+## Type Parameters
+
+| Type Parameter          |
+| ----------------------- |
+| `C` _extends_ `Catalog` |

package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md

@@ -0,0 +1,23 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / RenderErrorHandler
+
+# Type Alias: RenderErrorHandler
+
+```ts
+type RenderErrorHandler = (error, elementType) => void;
+```
+
+Defined in: `@xmachines/json-render-core`
+
+Callback invoked when an individual catalog component throws during render.
+Implemented by each framework renderer's error boundary / error capture mechanism.
+
+## Parameters
+
+| Parameter     | Type      |
+| ------------- | --------- |
+| `error`       | `unknown` |
+| `elementType` | `string`  |
+
+## Returns
+
+`void`

package/api/@xmachines/play-vue/variables/ActionProvider.md

@@ -0,0 +1,64 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / ActionProvider
+
+# Variable: ActionProvider
+
+```ts
+const ActionProvider: vue.DefineComponent<
+	vue.ExtractPropTypes<{
+		handlers: {
+			default: () => object;
+			type: PropType<Record<string, ActionHandler>>;
+		};
+		navigate: {
+			default: undefined;
+			type: PropType<(path) => void>;
+		};
+	}>,
+	() =>
+		| vue.VNode<
+				vue.RendererNode,
+				vue.RendererElement,
+				{
+					[key: string]: any;
+				}
+		  >[]
+		| undefined,
+	{},
+	{},
+	{},
+	vue.ComponentOptionsMixin,
+	vue.ComponentOptionsMixin,
+	{},
+	string,
+	vue.PublicProps,
+	Readonly<
+		vue.ExtractPropTypes<{
+			handlers: {
+				default: () => object;
+				type: PropType<Record<string, ActionHandler>>;
+			};
+			navigate: {
+				default: undefined;
+				type: PropType<(path) => void>;
+			};
+		}>
+	> &
+		Readonly<{}>,
+	{
+		handlers: Record<string, ActionHandler>;
+		navigate: (path) => void;
+	},
+	{},
+	{},
+	{},
+	string,
+	vue.ComponentProvideOptions,
+	true,
+	{},
+	any
+>;
+```
+
+Defined in: `@xmachines/json-render-vue`
+
+Provider for action execution