@xmachines/docs 1.0.0-beta.51 → 1.0.0-beta.53

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

@@ -1,70 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-dom](../README.md) / connectRenderer
-
-# Function: connectRenderer()
-
-```ts
-function connectRenderer(options): () => void;
-```
-
-Defined in: [packages/play-dom/src/connect-renderer.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/connect-renderer.ts#L65)
-
-Connect a signal-driven DOM renderer to an actor's `currentView` signal.
-
-Subscribes to `actor.currentView` via TC39 Signals and renders catalog-typed
-components into `container` on every view transition. Clears the container
-when the view is `null` (optionally appends `fallback` on initial mount).
-
-- Initial render is **synchronous** — the container is populated before `connectRenderer` returns.
-- Signal-driven re-renders are **microtask-deferred** — `watchSignal` schedules them
-  on the next microtask queue tick, not synchronously within the signal update.
-
-For the one-call pattern, prefer [createRenderer](createRenderer.md) which wraps `defineRegistry`
-and `PlayRenderer` into a single factory function.
-
-## Parameters
-
-| Parameter | Type                                                                | Description                                                       |
-| --------- | ------------------------------------------------------------------- | ----------------------------------------------------------------- |
-| `options` | [`ConnectRendererOptions`](../interfaces/ConnectRendererOptions.md) | [ConnectRendererOptions](../interfaces/ConnectRendererOptions.md) |
-
-## Returns
-
-A cleanup function — call to stop all DOM mutations and remove subscriptions.
-
-() => `void`
-
-## Example
-
-```typescript
-import { connectRenderer, defineRegistry, schema } from "@xmachines/play-dom";
-import { defineCatalog } from "@json-render/core";
-import { z } from "zod";
-
-const catalog = defineCatalog(schema, {
-	components: { Home: { props: z.object({ title: z.string() }) } },
-	actions: { logout: {} },
-});
-
-const registryResult = defineRegistry(catalog, {
-	components: {
-		Home: ({ props }) => {
-			const el = document.createElement("section");
-			el.textContent = props.title;
-			return el;
-		},
-	},
-	actions: {
-		logout: async () => actor.send({ type: "auth.logout" }),
-	},
-});
-
-const disconnect = connectRenderer({
-	actor,
-	registry: registryResult.registry,
-	registryResult, // preferred — wires setState/state from xstate store automatically
-	container: document.getElementById("app")!,
-});
-
-// Later:
-disconnect();
-```

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

@@ -1,28 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-dom](../README.md) / ConnectRendererOptions
-
-# Interface: ConnectRendererOptions
-
-Defined in: [packages/play-dom/src/types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L61)
-
-Options for connectRenderer() — backward compat API.
-
-## Extends
-
-- [`UIProviderOptions`](UIProviderOptions.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)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | -                                                                                                                      | [packages/play-dom/src/types.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L63)                         |
-| <a id="property-container"></a> `container`                      | `HTMLElement`                                                                                                                                                                                                                                                    | Container element to render into                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | -                                                                                                                      | [packages/play-dom/src/types.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L87)                         |
-| <a id="property-fallback"></a> `fallback?`                       | `HTMLElement` \| `null`                                                                                                                                                                                                                                          | Optional element shown when `currentView` is `null` on **initial mount** only. The fallback is appended immediately after `renderer.connect()` if the container is empty at that moment (i.e. the actor's initial view is `null`). **Limitation:** If the actor's view transitions to `null` after mount, the container will be cleared but this fallback will NOT be re-appended. For dynamic fallback behavior (null view after non-null), use `PlayRenderer` directly and wrap the `actor.currentView` signal to inject fallback content.                                                                                     | -                                                                                                                      | [packages/play-dom/src/types.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L100)                       |
-| <a id="property-functions"></a> `functions?`                     | `Record`\<`string`, `ComputedFunction`\>                                                                                                                                                                                                                         | Custom computed functions available to `$computed` field expressions in specs. Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | [`UIProviderOptions`](UIProviderOptions.md).[`functions`](UIProviderOptions.md#property-functions)                     | [packages/play-dom/src/json-render/types.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L83) |
-| <a id="property-handlers"></a> `handlers?`                       | `Record`\<`string`, `ActionHandler`\>                                                                                                                                                                                                                            | Pre-resolved handler map — for backward compatibility. Ignored when `registryResult` is provided.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | -                                                                                                                      | [packages/play-dom/src/types.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L112)                       |
-| <a id="property-loading"></a> `loading?`                         | `boolean`                                                                                                                                                                                                                                                        | When true, indicates the spec is still streaming (e.g. from an AI provider). Forwarded to PlayRenderer which threads it into renderSpec so components can read ctx.ctx.loading to show skeleton states. Also suppresses missing-child warnings. Mirrors the `loading` prop from framework renderer providers.                                                                                                                                                                                                                                                                                                                    | -                                                                                                                      | [packages/play-dom/src/types.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L127)                       |
-| <a id="property-navigate"></a> `navigate?`                       | (`path`) => `void`                                                                                                                                                                                                                                               | Navigation function forwarded to json-render computed functions that need to trigger programmatic navigation (e.g. a `navigate` action in the catalog).                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | [`UIProviderOptions`](UIProviderOptions.md).[`navigate`](UIProviderOptions.md#property-navigate)                       | [packages/play-dom/src/json-render/types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L77) |
-| <a id="property-onrendererror"></a> `onRenderError?`             | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                                                                                    | Called when an individual catalog component throws during render. Forwarded as `onRenderError` to the underlying renderer.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | [`UIProviderOptions`](UIProviderOptions.md).[`onRenderError`](UIProviderOptions.md#property-onrendererror)             | [packages/play-dom/src/json-render/types.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L89) |
-| <a id="property-registry"></a> `registry`                        | [`DomRegistry`](../type-aliases/DomRegistry.md)                                                                                                                                                                                                                  | Registry of component renderers — replaces old `components` map. When also providing `registryResult`, this **must** be the `.registry` field from the **same** `defineRegistry()` call to keep component renderers and action handlers aligned. Mixing a `registry` from one catalog with a `registryResult` from another will cause component wrappers and action handlers to be mismatched, producing silent runtime failures. **Example** `const registryResult = defineRegistry(catalog, { components, actions }); connectRenderer({ registry: registryResult.registry, // ← from the same call registryResult, // ... });` | -                                                                                                                      | [packages/play-dom/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L84)                         |
-| <a id="property-registryresult"></a> `registryResult?`           | [`DefineRegistryResult`](DefineRegistryResult.md)                                                                                                                                                                                                                | The result from `defineRegistry` — wires setState/getState from the xstate store into action handlers automatically. Preferred over `handlers` for new code.                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | -                                                                                                                      | [packages/play-dom/src/types.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L106)                       |
-| <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.                                                                                                                                                                                                                                                                                                                                                                    | -                                                                                                                      | [packages/play-dom/src/types.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L119)                       |
-| <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\>                                                                                                                                                                                                            | Custom validation functions for the json-render ValidationProvider equivalent. Each function receives `(value, args?)` and returns a boolean.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | [`UIProviderOptions`](UIProviderOptions.md).[`validationFunctions`](UIProviderOptions.md#property-validationfunctions) | [packages/play-dom/src/json-render/types.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L68) |

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

@@ -1,9 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RoutableActor
-
-# Type Alias: RoutableActor
-
-```ts
-type RoutableActor = AbstractActor<AnyActorLogic> & Routable & Viewable;
-```
-
-Defined in: [play-dom-router/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom-router/src/types.ts#L9)

package/api/@xmachines/play-react/type-aliases/PlayActor.md

@@ -1,9 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-react](../README.md) / PlayActor
-
-# Type Alias: PlayActor
-
-```ts
-type PlayActor = AbstractActor<AnyActorLogic>;
-```
-
-Defined in: [packages/play-react/src/useActor.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-react/src/useActor.ts#L27)

package/api/@xmachines/play-solid/type-aliases/PlayActor.md

@@ -1,9 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-solid](../README.md) / PlayActor
-
-# Type Alias: PlayActor
-
-```ts
-type PlayActor = AbstractActor<AnyActorLogic>;
-```
-
-Defined in: [packages/play-solid/src/useActor.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/useActor.ts#L27)

package/api/@xmachines/play-svelte/type-aliases/PlayActor.md

@@ -1,9 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-svelte](../README.md) / PlayActor
-
-# Type Alias: PlayActor
-
-```ts
-type PlayActor = AbstractActor<AnyActorLogic> & Viewable;
-```
-
-Defined in: [packages/play-svelte/src/actor-context.svelte.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-svelte/src/actor-context.svelte.ts#L21)

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

@@ -1,9 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-vue](../README.md) / PlayActor
-
-# Type Alias: PlayActor
-
-```ts
-type PlayActor = AbstractActor<AnyActorLogic>;
-```
-
-Defined in: [packages/play-vue/src/useActor.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-vue/src/useActor.ts#L26)