@xmachines/docs 1.0.0-beta.9 → 1.0.0

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

@@ -0,0 +1,11 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / ComponentRegistry
+
+# Type Alias: ComponentRegistry
+
+```ts
+type ComponentRegistry = Record<string, ComponentRenderer<any>>;
+```
+
+Defined in: `@xmachines/json-render-solid`
+
+Registry of component renderers

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

@@ -0,0 +1,23 @@
+[API](../../../README.md) / [@xmachines/play-solid](../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-solid/type-aliases/SetState.md

@@ -0,0 +1,21 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / SetState
+
+# Type Alias: SetState
+
+```ts
+type SetState = (updater) => void;
+```
+
+Defined in: `@xmachines/json-render-solid`
+
+State setter function for updating application state
+
+## Parameters
+
+| Parameter | Type                                        |
+| --------- | ------------------------------------------- |
+| `updater` | (`prev`) => `Record`\<`string`, `unknown`\> |
+
+## Returns
+
+`void`

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

@@ -0,0 +1,9 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / VisibilityProviderProps
+
+# Type Alias: VisibilityProviderProps
+
+```ts
+type VisibilityProviderProps = ParentProps;
+```
+
+Defined in: `@xmachines/json-render-solid`

package/api/@xmachines/play-solid/variables/ActorContext.md

@@ -0,0 +1,13 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / ActorContext
+
+# Variable: ActorContext
+
+```ts
+const ActorContext: Context<AnyPlayActor | null>;
+```
+
+Defined in: [packages/play-solid/src/useActor.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid/src/useActor.ts#L35)
+
+SolidJS context for the actor — exported so consumers can use ActorContext.Provider
+directly as an escape hatch (per D-11). The smart ActorProvider component takes
+the name "ActorProvider" and is the recommended entry point.

package/api/@xmachines/play-solid/variables/ActorProvider.md

@@ -0,0 +1,27 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / ActorProvider
+
+# Variable: ActorProvider
+
+```ts
+const ActorProvider: Component<ActorProviderProps>;
+```
+
+Defined in: [packages/play-solid/src/ActorProvider.tsx:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid/src/ActorProvider.tsx#L159)
+
+Smart ActorProvider component — owns actor bridging, signal subscription,
+StateStore lifecycle, handler resolution, and error boundary.
+
+Per D-11: Replaces the old raw alias `ActorProvider = ActorContext.Provider`.
+Consumers who previously used `<ActorProvider value={actor}>` should now use
+`<ActorContext.Provider value={actor}>` for raw provider access, or migrate to
+this smart component / PlayUIProvider.
+
+## Example
+
+```tsx
+import { ActorProvider, PlayRenderer } from "@xmachines/play-solid";
+
+<ActorProvider actor={myActor} registryResult={registryResult}>
+	<PlayRenderer />
+</ActorProvider>;
+```

package/api/@xmachines/play-solid/variables/PlayRenderer.md

@@ -1,70 +1,14 @@
-[Documentation](../../../README.md) / [@xmachines/play-solid](../README.md) / PlayRenderer
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / PlayRenderer
 
 # Variable: PlayRenderer
 
 ```ts
-const PlayRenderer: Component<PlayRendererProps>;
+const PlayRenderer: Component;
 ```
 
-Defined in: [PlayRenderer.tsx:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid/src/PlayRenderer.tsx#L66)
+Defined in: [packages/play-solid/src/PlayRenderer.tsx:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid/src/PlayRenderer.tsx#L27)
 
-Main renderer component that subscribes to actor signals and renders UI
+Zero-prop leaf renderer. Must be placed inside an ActorProvider or PlayUIProvider tree.
 
-Architecture (per XMachines Play patterns):
-
-- Subscribes to actor.currentView signal via TC39 Signal.subtle.Watcher
-- Dynamically renders catalog components based on view.component string
-- Forwards user events to actor via actor.send()
-- SolidJS signal only for triggering renders, NOT business logic
-
-Invariant: Actor Authority - Actor decides all state transitions via guards.
-Invariant: Passive Infrastructure - Component observes signals and sends events.
-Invariant: Signal-Only Reactivity - Business logic state lives in actor signals.
-
-## Example
-
-```typescript
-import { PlayRenderer } from "@xmachines/play-solidjs";
-import { definePlayer } from "@xmachines/play-xstate";
-
-const actor = definePlayer({ machine, catalog })();
-actor.start();
-
-const components = {
-  Dashboard: (props) => <div>User: {props.userId}</div>,
-  LoginForm: (props) => (
-    <form onSubmit={(e) => {
-      e.preventDefault();
-      props.send({ type: "auth.login", payload: {...} });
-    }}>...</form>
-  )
-};
-
-<PlayRenderer actor={actor} components={components} />
-```
-
-## Param
-
-Component props
-
-## Returns
-
-SolidJS element rendering current view from actor
-
-## Remarks
-
-**Component lookup:** Dynamically looks up component from `components` map
-using `view.component` string from actor.currentView signal.
-
-**Event forwarding:** Injects `send` function as prop to components. Components
-call `send(event)` to forward intents to actor. Actor guards decide validity.
-
-**Error handling:** If component not found in catalog, logs error and shows
-fallback. This indicates missing component registration, not runtime error.
-
-**Signal bridge:** Uses one-shot re-watch pattern. TC39 Signal watchers stop
-watching after notification, so watcher.watch() must be called in microtask
-after getPending() to re-arm for next notification.
-
-**CRITICAL:** Never call actor.send() during render - only in event handlers.
-Calling send during render causes infinite render loops.
+Reads ViewContextValue (spec, handlers, registry) from the enclosing provider
+via usePlayView() and renders the spec via @xmachines/json-render-solid's Renderer.

package/api/@xmachines/play-solid/variables/PlayUIProvider.md

@@ -0,0 +1,26 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / PlayUIProvider
+
+# Variable: PlayUIProvider
+
+```ts
+const PlayUIProvider: Component<PlayUIProviderProps>;
+```
+
+Defined in: [packages/play-solid/src/PlayUIProvider.tsx:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid/src/PlayUIProvider.tsx#L82)
+
+Batteries-included composite provider: ActorProvider + JSONUIProvider.
+
+Provides the full JSON render context stack:
+
+- ActorContext (actor instance via ActorProvider)
+- ViewContext (spec, handlers, registry via ActorProvider)
+- StateProvider + ActionProvider + VisibilityProvider + ValidationProvider (via JSONUIProvider)
+- ConfirmDialogManager (via JSONUIProvider)
+
+## Example
+
+```tsx
+<PlayUIProvider actor={myActor} registryResult={registryResult} navigate={navigate}>
+	<PlayRenderer />
+</PlayUIProvider>
+```