@xmachines/docs 1.0.0-beta.26 → 1.0.0-beta.28

package/api/@xmachines/play-actor-shared/type-aliases/CatalogProps.md

@@ -0,0 +1,187 @@
+[Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / CatalogProps
+
+# Type Alias: CatalogProps
+
+```ts
+type CatalogProps = object;
+```
+
+Defined in: [packages/play-actor/examples/shared/src/catalog.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L48)
+
+## Properties
+
+### About
+
+```ts
+About: object;
+```
+
+Defined in: [packages/play-actor/examples/shared/src/catalog.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L50)
+
+#### title
+
+```ts
+title: string;
+```
+
+---
+
+### Contact
+
+```ts
+Contact: object;
+```
+
+Defined in: [packages/play-actor/examples/shared/src/catalog.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L51)
+
+#### title
+
+```ts
+title: string;
+```
+
+---
+
+### Dashboard
+
+```ts
+Dashboard: object;
+```
+
+Defined in: [packages/play-actor/examples/shared/src/catalog.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L53)
+
+#### username
+
+```ts
+username: string;
+```
+
+#### welcome
+
+```ts
+welcome: boolean;
+```
+
+---
+
+### Home
+
+```ts
+Home: object;
+```
+
+Defined in: [packages/play-actor/examples/shared/src/catalog.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L49)
+
+#### title
+
+```ts
+title: string;
+```
+
+---
+
+### Login
+
+```ts
+Login: object;
+```
+
+Defined in: [packages/play-actor/examples/shared/src/catalog.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L52)
+
+#### title
+
+```ts
+title: string;
+```
+
+---
+
+### Navigation
+
+```ts
+Navigation: object;
+```
+
+Defined in: [packages/play-actor/examples/shared/src/catalog.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L56)
+
+#### currentPath
+
+```ts
+currentPath: string;
+```
+
+#### isAuthenticated
+
+```ts
+isAuthenticated: boolean;
+```
+
+---
+
+### Overview
+
+```ts
+Overview: object;
+```
+
+Defined in: [packages/play-actor/examples/shared/src/catalog.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L57)
+
+#### title
+
+```ts
+title: string;
+```
+
+---
+
+### Profile
+
+```ts
+Profile: object;
+```
+
+Defined in: [packages/play-actor/examples/shared/src/catalog.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L54)
+
+#### username
+
+```ts
+username: string;
+```
+
+---
+
+### Settings
+
+```ts
+Settings: object;
+```
+
+Defined in: [packages/play-actor/examples/shared/src/catalog.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L55)
+
+#### section?
+
+```ts
+optional section?: string;
+```
+
+#### username
+
+```ts
+username: string;
+```
+
+---
+
+### Stats
+
+```ts
+Stats: object;
+```
+
+Defined in: [packages/play-actor/examples/shared/src/catalog.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L58)
+
+#### title
+
+```ts
+title: string;
+```

package/api/@xmachines/play-actor-shared/type-aliases/InferProps.md

@@ -0,0 +1,17 @@
+[Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / InferProps
+
+# Type Alias: InferProps\<K\>
+
+```ts
+type InferProps<K> = CatalogProps[K];
+```
+
+Defined in: [packages/play-actor/examples/shared/src/catalog.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L74)
+
+Infer props for a named component from the catalog type
+
+## Type Parameters
+
+| Type Parameter                                        |
+| ----------------------------------------------------- |
+| `K` _extends_ keyof [`CatalogProps`](CatalogProps.md) |

package/api/@xmachines/play-actor-shared/variables/authCatalog.md

@@ -0,0 +1,173 @@
+[Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / authCatalog
+
+# Variable: authCatalog
+
+```ts
+const authCatalog: Catalog<
+	{
+		catalog: SchemaType<
+			"object",
+			{
+				actions: SchemaType<
+					"map",
+					{
+						description: SchemaType<"string", unknown>;
+						params: SchemaType<"zod", unknown>;
+					}
+				>;
+				components: SchemaType<
+					"map",
+					{
+						description: SchemaType<"string", unknown>;
+						example: SchemaType<"any", unknown>;
+						props: SchemaType<"zod", unknown>;
+						slots: SchemaType<"array", SchemaType<"string", unknown>>;
+					}
+				>;
+			}
+		>;
+		spec: SchemaType<
+			"object",
+			{
+				elements: SchemaType<
+					"record",
+					SchemaType<
+						"object",
+						{
+							children: SchemaType<"array", SchemaType<"string", unknown>>;
+							props: SchemaType<"propsOf", string>;
+							type: SchemaType<"ref", string>;
+							visible: SchemaType<"any", unknown>;
+						}
+					>
+				>;
+				root: SchemaType<"string", unknown>;
+			}
+		>;
+	},
+	{
+		actions: {
+			login: {
+				description: string;
+				params: ZodObject<
+					{
+						username: ZodString;
+					},
+					$strip
+				>;
+			};
+			logout: {
+				description: string;
+			};
+			routeDashboard: {
+				description: string;
+			};
+			routeHome: {
+				description: string;
+			};
+			routeLogin: {
+				description: string;
+			};
+			routeOverview: {
+				description: string;
+			};
+			routeProfile: {
+				description: string;
+			};
+			routeSettings: {
+				description: string;
+			};
+			routeStats: {
+				description: string;
+			};
+		};
+		components: {
+			About: {
+				props: ZodObject<
+					{
+						title: ZodString;
+					},
+					$strip
+				>;
+			};
+			Contact: {
+				props: ZodObject<
+					{
+						title: ZodString;
+					},
+					$strip
+				>;
+			};
+			Dashboard: {
+				props: ZodObject<
+					{
+						username: ZodString;
+						welcome: ZodBoolean;
+					},
+					$strip
+				>;
+			};
+			Home: {
+				props: ZodObject<
+					{
+						title: ZodString;
+					},
+					$strip
+				>;
+			};
+			Login: {
+				props: ZodObject<
+					{
+						title: ZodString;
+					},
+					$strip
+				>;
+			};
+			Navigation: {
+				props: ZodObject<
+					{
+						currentPath: ZodString;
+						isAuthenticated: ZodBoolean;
+					},
+					$strip
+				>;
+			};
+			Overview: {
+				props: ZodObject<
+					{
+						title: ZodString;
+					},
+					$strip
+				>;
+			};
+			Profile: {
+				props: ZodObject<
+					{
+						username: ZodString;
+					},
+					$strip
+				>;
+			};
+			Settings: {
+				props: ZodObject<
+					{
+						section: ZodOptional<ZodString>;
+						username: ZodString;
+					},
+					$strip
+				>;
+			};
+			Stats: {
+				props: ZodObject<
+					{
+						title: ZodString;
+					},
+					$strip
+				>;
+			};
+		};
+	}
+>;
+```
+
+Defined in: [packages/play-actor/examples/shared/src/catalog.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L14)

package/api/@xmachines/play-actor-shared/variables/authMachine.md

@@ -0,0 +1,189 @@
+[Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / authMachine
+
+# Variable: authMachine
+
+```ts
+const authMachine: StateMachine<AuthContext, AuthEvents, {
+}, never, never, never, never,
+  | "login"
+  | "home"
+  | "about"
+  | "contact"
+  | "profile"
+  | "settings"
+  | {
+  dashboard: "overview" | "stats";
+}, string, AuthInput, NonReducibleUnknown, EventObject, MetaObject, ToStateSchema<{
+  context: (__namedParameters) => object;
+  id: string;
+  initial: string;
+  on: {
+     auth.login: {
+        actions: ActionFunction<AuthContext, AuthEvents, AuthEvents, undefined, never, never, never, never, never>;
+        guard: (__namedParameters) => boolean;
+        target: string;
+     };
+     auth.logout: {
+        actions: ActionFunction<AuthContext, AuthEvents, AuthEvents, undefined, never, never, never, never, never>;
+        guard: (__namedParameters) => boolean;
+        target: string;
+     };
+  };
+  states: {
+     about: {
+        id: string;
+        meta: {
+           route: string;
+           view: {
+              component: string;
+              spec: {
+                 elements: {
+                    root: {
+                       children: ...[];
+                       props: {
+                          title: ...;
+                       };
+                       type: string;
+                    };
+                 };
+                 root: string;
+              };
+           };
+        };
+     };
+     contact: {
+        id: string;
+        meta: {
+           route: string;
+           view: {
+              component: string;
+              spec: {
+                 elements: {
+                    root: {
+                       children: ...[];
+                       props: {
+                          title: ...;
+                       };
+                       type: string;
+                    };
+                 };
+                 root: string;
+              };
+           };
+        };
+     };
+     dashboard: {
+        always: {
+           guard: (__namedParameters) => boolean;
+           target: string;
+        };
+        id: string;
+        initial: string;
+        meta: {
+           route: string;
+        };
+        states: {
+           overview: {
+              id: string;
+              meta: {
+                 route: string;
+                 view: {
+                    component: string;
+                    spec: PlaySpec;
+                 };
+              };
+           };
+           stats: {
+              id: string;
+              meta: {
+                 route: string;
+                 view: {
+                    component: string;
+                    spec: PlaySpec;
+                 };
+              };
+           };
+        };
+     };
+     home: {
+        id: string;
+        meta: {
+           route: string;
+           view: {
+              component: string;
+              spec: {
+                 elements: {
+                    root: {
+                       children: ...[];
+                       props: {
+                          title: ...;
+                       };
+                       type: string;
+                    };
+                 };
+                 root: string;
+              };
+           };
+        };
+     };
+     login: {
+        id: string;
+        meta: {
+           route: string;
+           view: {
+              component: string;
+              spec: {
+                 elements: {
+                    root: {
+                       children: ...[];
+                       on: {
+                          submit: ...;
+                       };
+                       props: {
+                          title: ...;
+                          username: ...;
+                       };
+                       type: string;
+                    };
+                 };
+                 root: string;
+                 state: {
+                    username: string;
+                 };
+              };
+           };
+        };
+     };
+     profile: {
+        always: {
+           guard: (__namedParameters) => boolean;
+           target: string;
+        };
+        id: string;
+        meta: {
+           route: string;
+           view: {
+              component: string;
+              spec: PlaySpec;
+           };
+        };
+     };
+     settings: {
+        always: {
+           guard: (__namedParameters) => boolean;
+           target: string;
+        };
+        id: string;
+        meta: {
+           route: string;
+           view: {
+              component: string;
+              spec: PlaySpec;
+           };
+        };
+     };
+  };
+}>>;
+```
+
+Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L49)

package/api/@xmachines/play-actor-shared/variables/authSetup.md

@@ -0,0 +1,22 @@
+[Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / authSetup
+
+# Variable: authSetup
+
+```ts
+const authSetup: SetupReturn<
+	AuthContext,
+	AuthEvents,
+	{},
+	{},
+	{},
+	{},
+	never,
+	string,
+	AuthInput,
+	NonReducibleUnknown,
+	EventObject,
+	MetaObject
+>;
+```
+
+Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L41)

package/api/@xmachines/play-dom/README.md

@@ -2,18 +2,77 @@
 
 # @xmachines/play-dom
 
-@xmachines/play-dom - Vanilla DOM renderer for XMachines Play architecture
+**Vanilla DOM renderer for XMachines**
 
-Provides a two-layer architecture:
+`connectRenderer` — a framework-free `PlayRenderer` equivalent that wires an XState v5 actor's `currentView` TC39 Signal to pure DOM rendering via a catalog-typed `DomRegistry`.
 
-- Inner layer (dom-renderer): Pure json-render-core compatible DOM renderer.
-  Zero XMachines dependencies. Upstreamable to @json-render/dom.
-- Outer layer (PlayRenderer): XMachines wrapper. Bridges actor.currentView
-  (TC39 Signal) to the inner DOM renderer using watchSignal.
+## Installation
 
-Also provides connectRenderer() as a backward-compat convenience function.
+```bash
+npm install @xmachines/play-dom
+```
 
-No framework required. Pure DOM APIs only.
+## Key Exports
+
+- `connectRenderer({ actor, registry, container })` — connect actor view signal to DOM
+- `defineRegistry(catalog, { components, actions })` — build a catalog-typed `DomRegistry`
+- `PlayRenderer` — class-based renderer (connect/disconnect lifecycle)
+- `ComponentFn<C, K>` — catalog-typed DOM component function type
+- `ComponentContext<C, K>` — context passed to each `ComponentFn` (props, emit, on, children, bindings)
+- `renderSpec(spec, store, registry, send, actorActions)` — pure Spec → DOM renderer
+
+## Usage
+
+```ts
+import { definePlayer } from "@xmachines/play-xstate";
+import { connectRenderer, defineRegistry } from "@xmachines/play-dom";
+import { authMachine, authCatalog, type AuthCatalog } from "@xmachines/play-actor-shared";
+import type { ComponentFn } from "@xmachines/play-dom";
+
+const Home: ComponentFn<AuthCatalog, "Home"> = ({ props }) => {
+	const el = document.createElement("section");
+	el.textContent = props.title;
+	return el;
+};
+
+const { registry } = defineRegistry(authCatalog, {
+	components: { Home /* ... */ },
+	actions: { login: "auth.login", logout: "auth.logout" },
+});
+
+const createPlayer = definePlayer({ machine: authMachine });
+const actor = createPlayer();
+actor.start();
+
+const container = document.getElementById("app")!;
+const disconnect = connectRenderer({ actor, registry, container });
+```
+
+## Learn More
+
+- [DOM Router adapter `@xmachines/play-dom-router`](../play-dom-router/README.md)
+
+@xmachines/play-dom — Vanilla DOM renderer for XMachines Play architecture.
+
+Public API split into two layers:
+
+**XMachines layer** (this package):
+
+- `PlayRenderer` — connects actor.currentView signal → DOM renderer
+- `connectRenderer()` — backward-compat functional API
+- `ConnectRendererOptions`, `PlayDomOptions`
+
+**json-render layer** (upstreamable to @json-render/dom):
+
+- `defineRegistry` — build a catalog-typed DomRegistry
+- `renderSpec` — pure Spec → DOM renderer (uses resolveElementProps from core)
+- `ComponentFn` — catalog-typed component function type
+- `ComponentContext` — catalog-typed render context (props, emit, on, children, bindings)
+- `ComponentRegistry` — catalog-typed registry input type
+- `DomComponentRenderer` — raw element-level renderer type
+- `DomRegistry` — raw registry type
+- `DomRenderContext` — raw render context
+- `EventHandle` — event handle returned by on()
 
 ## Classes
 
@@ -21,16 +80,23 @@ No framework required. Pure DOM APIs only.
 
 ## Interfaces
 
+- [ComponentContext](interfaces/ComponentContext.md)
 - [ConnectRendererOptions](interfaces/ConnectRendererOptions.md)
+- [DefineRegistryOptions](interfaces/DefineRegistryOptions.md)
+- [DefineRegistryResult](interfaces/DefineRegistryResult.md)
 - [DomRenderContext](interfaces/DomRenderContext.md)
+- [EventHandle](interfaces/EventHandle.md)
 - [PlayDomOptions](interfaces/PlayDomOptions.md)
 
 ## Type Aliases
 
+- [ComponentFn](type-aliases/ComponentFn.md)
+- [ComponentRegistry](type-aliases/ComponentRegistry.md)
 - [DomComponentRenderer](type-aliases/DomComponentRenderer.md)
 - [DomRegistry](type-aliases/DomRegistry.md)
 
 ## Functions
 
 - [connectRenderer](functions/connectRenderer.md)
+- [defineRegistry](functions/defineRegistry.md)
 - [renderSpec](functions/renderSpec.md)