@xmachines/docs 1.0.0-beta.30 → 1.0.0-beta.32

package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / AuthCatalog
+
+# Type Alias: AuthCatalog
+
+```ts
+type AuthCatalog = typeof authCatalog;
+```
+
+Defined in: [packages/play-solid/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/catalog.ts#L6)

package/examples/@xmachines/play-solid-demo/variables/About.md

@@ -6,4 +6,4 @@
 const About: ComponentFn<AuthCatalog, "About">;
 ```
 
-Defined in: [components/About.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/examples/demo/src/components/About.tsx#L4)
+Defined in: [packages/play-solid/examples/demo/src/components/About.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/About.tsx#L4)

package/examples/@xmachines/play-solid-demo/variables/Contact.md

@@ -6,4 +6,4 @@
 const Contact: ComponentFn<AuthCatalog, "Contact">;
 ```
 
-Defined in: [components/Contact.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/examples/demo/src/components/Contact.tsx#L4)
+Defined in: [packages/play-solid/examples/demo/src/components/Contact.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Contact.tsx#L4)

package/examples/@xmachines/play-solid-demo/variables/Dashboard.md

@@ -6,4 +6,4 @@
 const Dashboard: ComponentFn<AuthCatalog, "Dashboard">;
 ```
 
-Defined in: [components/Dashboard.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/examples/demo/src/components/Dashboard.tsx#L4)
+Defined in: [packages/play-solid/examples/demo/src/components/Dashboard.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Dashboard.tsx#L4)

package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md

@@ -0,0 +1,11 @@
+[Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / DebugPanel
+
+# Variable: DebugPanel
+
+```ts
+const DebugPanel: Component<{
+	actor: AuthActor;
+}>;
+```
+
+Defined in: [packages/play-solid/examples/demo/src/components/DebugPanel.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/DebugPanel.tsx#L5)

package/examples/@xmachines/play-solid-demo/variables/Home.md

@@ -6,4 +6,4 @@
 const Home: ComponentFn<AuthCatalog, "Home">;
 ```
 
-Defined in: [components/Home.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/examples/demo/src/components/Home.tsx#L4)
+Defined in: [packages/play-solid/examples/demo/src/components/Home.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Home.tsx#L4)

package/examples/@xmachines/play-solid-demo/variables/Login.md

@@ -6,4 +6,4 @@
 const Login: ComponentFn<AuthCatalog, "Login">;
 ```
 
-Defined in: [components/Login.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/examples/demo/src/components/Login.tsx#L7)
+Defined in: [packages/play-solid/examples/demo/src/components/Login.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Login.tsx#L7)

package/examples/@xmachines/play-solid-demo/variables/NavBar.md

@@ -0,0 +1,11 @@
+[Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / NavBar
+
+# Variable: NavBar
+
+```ts
+const NavBar: Component<{
+	actor: AuthActor;
+}>;
+```
+
+Defined in: [packages/play-solid/examples/demo/src/components/NavBar.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/NavBar.tsx#L28)

package/examples/@xmachines/play-solid-demo/variables/NavBarView.md

@@ -0,0 +1,12 @@
+[Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / NavBarView
+
+# Variable: NavBarView
+
+```ts
+const NavBarView: ComponentFn<AuthCatalog, "NavBar">;
+```
+
+Defined in: [packages/play-solid/examples/demo/src/components/NavBar.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/NavBar.tsx#L20)
+
+Catalog-typed NavBar component for use in defineRegistry components map.
+Receives props from spec (isAuthenticated, username) and renders a static nav.

package/examples/@xmachines/play-solid-demo/variables/Navigation.md

@@ -6,4 +6,4 @@
 const Navigation: ComponentFn<AuthCatalog, "Navigation">;
 ```
 
-Defined in: [components/Navigation.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/examples/demo/src/components/Navigation.tsx#L4)
+Defined in: [packages/play-solid/examples/demo/src/components/Navigation.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Navigation.tsx#L4)

package/examples/@xmachines/play-solid-demo/variables/Overview.md

@@ -6,4 +6,4 @@
 const Overview: ComponentFn<AuthCatalog, "Overview">;
 ```
 
-Defined in: [components/Overview.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/examples/demo/src/components/Overview.tsx#L4)
+Defined in: [packages/play-solid/examples/demo/src/components/Overview.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Overview.tsx#L4)

package/examples/@xmachines/play-solid-demo/variables/Profile.md

@@ -6,4 +6,4 @@
 const Profile: ComponentFn<AuthCatalog, "Profile">;
 ```
 
-Defined in: [components/Profile.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/examples/demo/src/components/Profile.tsx#L4)
+Defined in: [packages/play-solid/examples/demo/src/components/Profile.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Profile.tsx#L4)

package/examples/@xmachines/play-solid-demo/variables/Settings.md

@@ -6,4 +6,4 @@
 const Settings: ComponentFn<AuthCatalog, "Settings">;
 ```
 
-Defined in: [components/Settings.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/examples/demo/src/components/Settings.tsx#L4)
+Defined in: [packages/play-solid/examples/demo/src/components/Settings.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Settings.tsx#L4)

package/examples/@xmachines/play-solid-demo/variables/Shell.md

@@ -0,0 +1,13 @@
+[Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / Shell
+
+# Variable: Shell
+
+```ts
+const Shell: Component<{
+	actor: AuthActor;
+	registryResult: DefineRegistryResult;
+	router?: unknown;
+}>;
+```
+
+Defined in: [packages/play-solid/examples/demo/src/components/Shell.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Shell.tsx#L8)

package/examples/@xmachines/play-solid-demo/variables/Stats.md

@@ -6,4 +6,4 @@
 const Stats: ComponentFn<AuthCatalog, "Stats">;
 ```
 
-Defined in: [components/Stats.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/examples/demo/src/components/Stats.tsx#L4)
+Defined in: [packages/play-solid/examples/demo/src/components/Stats.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Stats.tsx#L4)

package/examples/@xmachines/play-solid-demo/variables/authCatalog.md

@@ -0,0 +1,172 @@
+[Documentation](../../../README.md) / [@xmachines/play-solid-demo](../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: "Login with username";
+				params: ZodObject<
+					{
+						username: ZodString;
+					},
+					$strip
+				>;
+			};
+			logout: {
+				description: "Logout and return to home";
+			};
+			route: {
+				description: "Navigate to a route by path (e.g. '#home', '#login', '#dashboard')";
+				params: ZodObject<
+					{
+						params: ZodOptional<ZodRecord<ZodString, ZodString>>;
+						to: ZodString;
+					},
+					$strip
+				>;
+			};
+		};
+		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;
+						username: ZodOptional<ZodString>;
+					},
+					$strip
+				>;
+			};
+			NavBar: {
+				props: ZodObject<
+					{
+						isAuthenticated: ZodBoolean;
+						username: ZodNullable<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-solid/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/catalog.ts#L5)

package/examples/@xmachines/play-solid-router-demo/README.md

@@ -51,9 +51,7 @@ const routeMap = createRouteMap(authMachine);
 	actor={actor}
 	routeMap={routeMap}
 	router={{ navigate, location, params }}
-	renderer={(currentActor, currentRouter) => (
-		<Shell actor={currentActor} router={currentRouter} />
-	)}
+	renderer={(currentActor, currentRouter) => <Shell actor={currentActor} router={currentRouter} />}
 />;
 ```
 

package/examples/README.md

@@ -34,7 +34,7 @@ Complete working implementations of actor-authoritative routing with all archite
 - [@xmachines/play-solid-demo](@xmachines/play-solid-demo/README.md)
 - [@xmachines/play-svelte-demo](@xmachines/play-svelte-demo/README.md)
 - [@xmachines/play-vue-demo](@xmachines/play-vue-demo/README.md)
-  <!-- typedoc:renderer-demos:end -->
+<!-- typedoc:renderer-demos:end -->
 
 ### Router Demos
 
@@ -48,7 +48,7 @@ Complete working implementations of actor-authoritative routing with all archite
 - [@xmachines/play-tanstack-react-router-demo](@xmachines/play-tanstack-react-router-demo/README.md)
 - [@xmachines/play-tanstack-solid-router-demo](@xmachines/play-tanstack-solid-router-demo/README.md)
 - [@xmachines/play-vue-router-demo](@xmachines/play-vue-router-demo/README.md)
-  <!-- typedoc:router-demos:end -->
+<!-- typedoc:router-demos:end -->
 
 ## Running the Code Examples
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xmachines/docs",
-  "version": "1.0.0-beta.30",
+  "version": "1.0.0-beta.32",
   "description": "Documentation for XMachines",
   "keywords": [
     "documentation",
@@ -49,12 +49,12 @@
     "test": "vitest run"
   },
   "devDependencies": {
-    "@xmachines/shared": "1.0.0-beta.30",
-    "oxfmt": "^0.43.0",
-    "oxlint": "^1.57.0",
-    "typedoc": "^0.28.18",
+    "@xmachines/shared": "1.0.0-beta.32",
+    "oxfmt": "^0.45.0",
+    "oxlint": "^1.60.0",
+    "typedoc": "^0.28.19",
     "typedoc-plugin-llms-txt": "^0.1.2",
     "typedoc-plugin-markdown": "^4.11.0",
-    "vitest": "^4.1.2"
+    "vitest": "^4.1.4"
   }
 }

package/rfc/play.md

@@ -20,24 +20,24 @@ The reference implementation provides a modular monorepo that satisfies the arch
 ### 2.1 Roles
 
 - **The Actor (Logic Engine)**
-    - Pure, environment-agnostic logic runtime
-    - Owns state, guards, errors, and route validity
-    - Emits _Virtual Routes_ as derived intent
+  - Pure, environment-agnostic logic runtime
+  - Owns state, guards, errors, and route validity
+  - Emits _Virtual Routes_ as derived intent
 
 - **The Runtime Adapter (Infrastructure Layer)**
-    - Environment-specific adapter (Browser, Native, Server, Test Runner)
-    - Reflects Actor output into the environment
-    - Forwards environment events to the Actor without interpretation
+  - Environment-specific adapter (Browser, Native, Server, Test Runner)
+  - Reflects Actor output into the environment
+  - Forwards environment events to the Actor without interpretation
 
 - **The View**
-    - Passive consumer of Actor state
-    - No business rules or routing authority
+  - Passive consumer of Actor state
+  - No business rules or routing authority
 
 ### 2.2 Communication Medium
 
 - **Signals (TC39 Proposal)**
-    - Used exclusively for Actor ↔ Adapter communication
-    - Enables synchronous, glitch-free propagation
+  - Used exclusively for Actor ↔ Adapter communication
+  - Enables synchronous, glitch-free propagation
 
 ---
 
@@ -75,9 +75,9 @@ The reference implementation provides a modular monorepo that satisfies the arch
 - Defines **Virtual Routes** as metadata on state nodes
 - Validates all incoming navigation intents
 - On invalid intent:
-    1. Transitions to an error or fallback state
-    2. Emits a corresponding Virtual Route (e.g. `/error`, `/login`)
-    3. Forces the environment to realign with Actor state
+  1. Transitions to an error or fallback state
+  2. Emits a corresponding Virtual Route (e.g. `/error`, `/login`)
+  3. Forces the environment to realign with Actor state
 
 The Actor has zero knowledge of:
 
@@ -114,9 +114,9 @@ Wraps the TC39 Signals (Stage 1) polyfill. By isolating the reactive primitive w
 **Exports:**
 
 - `Signal` — Re-exported namespace from `signal-polyfill`:
-    - `Signal.State` — Actor output snapshot
-    - `Signal.Computed` — Lazy, pull-based derivation of routes and views
-    - `Signal.subtle.Watcher` — Synchronous observation for Runtime Adapters
+  - `Signal.State` — Actor output snapshot
+  - `Signal.Computed` — Lazy, pull-based derivation of routes and views
+  - `Signal.subtle.Watcher` — Synchronous observation for Runtime Adapters
 - `watchSignal` — Convenience function: subscribes to a single signal with a one-shot watcher lifecycle and microtask batching; returns a cleanup function
 
 #### 5.1.2 `@xmachines/play`
@@ -251,9 +251,9 @@ Provides the complete routing infrastructure: route extraction from state machin
 - `RouterBridge` — Interface: `{ connect(): void; disconnect(): void }`
 - `PlayRouteEvent` — Routing event: `{ type: 'play.route'; to: string; params?; query?; match? }`
 - `RouterBridgeBase` — Abstract base class that encapsulates common bridge logic (signal watching, route synchronization, param/query extraction). Subclasses implement only three methods:
-    - `navigateRouter(path)` — Push a path into the framework router
-    - `watchRouterChanges()` — Subscribe to framework router navigation events
-    - `unwatchRouterChanges()` — Unsubscribe from framework router events
+  - `navigateRouter(path)` — Push a path into the framework router
+  - `watchRouterChanges()` — Subscribe to framework router navigation events
+  - `unwatchRouterChanges()` — Unsubscribe from framework router events
 
 **Route Extraction Exports:**
 

package/api/@xmachines/play-react/functions/useStateBinding.md

@@ -1,34 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-react](../README.md) / useStateBinding
-
-# ~~Function: useStateBinding()~~
-
-```ts
-function useStateBinding<T>(path): [T | undefined, (value) => void];
-```
-
-Defined in: `@json-render/react`
-
-Hook to get and set a value from the state model (like useState).
-
-## Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `T`            |
-
-## Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `path`    | `string` |
-
-## Returns
-
-\[`T` \| `undefined`, (`value`) => `void`\]
-
-## Deprecated
-
-Use [useBoundProp](useBoundProp.md) with `$bindState` expressions instead.
-`useStateBinding` takes a raw state path string, while `useBoundProp` works
-with the renderer's `bindings` map and supports both `$bindState` and
-`$bindItem` expressions.

package/api/@xmachines/play-solid/functions/useStateBinding.md

@@ -1,25 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-solid](../README.md) / useStateBinding
-
-# Function: useStateBinding()
-
-```ts
-function useStateBinding<T>(path): [Accessor<T | undefined>, (value) => void];
-```
-
-Defined in: `@json-render/solid`
-
-## Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `T`            |
-
-## Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `path`    | `string` |
-
-## Returns
-
-\[`Accessor`\<`T` \| `undefined`\>, (`value`) => `void`\]

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

@@ -1,32 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / useStateBinding
-
-# Function: useStateBinding()
-
-```ts
-function useStateBinding<T>(path): [ComputedRef<T | undefined>, (value) => void];
-```
-
-Defined in: `@json-render/vue`
-
-Composable to get and set a value from the state model by path.
-
-This is the path-based variant for use in arbitrary composables. For
-registry components that receive `bindings` from the renderer, prefer
-`useBoundProp` which reads the already-resolved prop value and writes back
-to the bound path.
-
-## Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `T`            |
-
-## Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `path`    | `string` |
-
-## Returns
-
-\[`ComputedRef`\<`T` \| `undefined`\>, (`value`) => `void`\]