@xmachines/docs 6.1.0 → 7.1.0

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

@@ -0,0 +1,76 @@
+[Examples](../../README.md) / @xmachines/play-dom-router-todomvc-demo
+
+# @xmachines/play-dom-router-todomvc-demo
+
+Vanilla DOM Router integration demo of the shared **TodoMVC** machine — actor-authoritative routing over the browser History API, with no framework.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## What This Demonstrates
+
+- Shared TodoMVC machine reused without framework-specific business logic
+- `createBrowserHistory` + `createRouter` + `connectRouter` wiring actor ↔ `window.history` — the filter states map to `/`, `/active`, and `/completed`
+- Shell, catalog, and component kit imported from the workspace-only [`@xmachines/play-dom-gallery-demo`](../play-dom-gallery-demo/README.md) renderer gallery
+- Actor-authoritative navigation: a deep link is honored when valid and overwritten back when invalid (State-Driven Reset)
+- Stately inspector attached at creation via `options.inspect` — the debug panel's **Show Inspector** button opens the live machine in its own window
+
+## Running the Demo
+
+From the repository root:
+
+```bash
+pnpm install
+pnpm --filter @xmachines/play-dom-router-todomvc-demo run dev
+```
+
+Then open `http://localhost:3060`.
+
+## Step-by-Step Code Flow
+
+1. `src/main.ts` looks up `#app` (throws if absent), calls `initApp(app)`, and registers unload cleanup.
+2. `src/App.ts` starts the actor, connects the router, mounts the shell, and returns one cleanup function. There is no component tree — `initApp(container) => cleanup` is the DOM family's top-level unit.
+3. `src/runtime.ts` creates the inspector, the `createPlayer` factory (`definePlayer` with `options.inspect`), the pre-built `routeMap` (`createRouteMap(todoMvcMachine)`), and `createRegistryResult` — the demo's DOM-free wiring layer.
+4. `src/router.ts` extracts the route tree with `extractMachineRoutes`, wraps `window.history` with `createBrowserHistory`, pairs the two through `createRouter`, and installs the bridge with `connectRouter`.
+5. `initShell` (from [`@xmachines/play-dom-gallery-demo`](../play-dom-gallery-demo/README.md)) writes the demo chrome, connects `createPlayUI(registryResult)(actor, content)`, and appends the debug panel.
+6. Browser tests in `test/browser/` delegate to the shared TodoMVC router suite.
+
+## Key Files
+
+- `src/main.ts` - host lookup, app bootstrap, and unload cleanup
+- `src/App.ts` - actor lifecycle, router connection, and `initShell` composition
+- `src/runtime.ts` - actor factory (`createPlayer`), pre-built `routeMap`, and `createRegistryResult`
+- `src/router.ts` - `createBrowserHistory`, `createRouter`, and `connectRouter` wiring
+- `test/library-pattern.test.ts` - architecture boundary and invariant assertions
+- `test/browser/shared-demo.browser.test.ts` - delegates to the shared TodoMVC router browser suite
+
+## Architecture Invariants
+
+1. **Actor Authority:** A `popstate` event or an in-view `route` action becomes a `play.route` event. The actor evaluates it against its guards and decides — the URL never decides.
+2. **Passive Infrastructure:** The bridge writes `window.history` and the DOM renders `actor.currentView`. Neither holds business state.
+3. **State-Driven Reset:** An external history change to an invalid route is overwritten back from actor state — the URL always reflects the machine.
+
+## Available Scripts
+
+| Command                                                                  | Description                                    |
+| ------------------------------------------------------------------------ | ---------------------------------------------- |
+| `pnpm --filter @xmachines/play-dom-router-todomvc-demo run dev`          | Start Vite dev server (http://localhost:3060/) |
+| `pnpm --filter @xmachines/play-dom-router-todomvc-demo run build`        | Build production bundle                        |
+| `pnpm --filter @xmachines/play-dom-router-todomvc-demo run preview`      | Preview built bundle                           |
+| `pnpm --filter @xmachines/play-dom-router-todomvc-demo run test`         | Run Vitest test suite                          |
+| `pnpm --filter @xmachines/play-dom-router-todomvc-demo run test:browser` | Run browser-focused Vitest suite               |
+
+## Verification
+
+```bash
+pnpm --filter @xmachines/play-dom-router-todomvc-demo run test
+pnpm --filter @xmachines/play-dom-router-todomvc-demo run test:browser
+```
+
+Expected result: the library-pattern assertions pass, and the shared TodoMVC router browser suite completes.
+
+## Learn More
+
+- [Play DOM Router](../../../api/@xmachines/play-dom-router/README.md)
+- [DOM renderer gallery](../play-dom-gallery-demo/README.md)
+- [Play Router](../../../api/@xmachines/play-router/README.md)
+- [Inspecting a Running Actor](../../../guides/inspector.md)

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

@@ -0,0 +1,76 @@
+[Examples](../../README.md) / @xmachines/play-dom-router-trivia-demo
+
+# @xmachines/play-dom-router-trivia-demo
+
+Vanilla DOM Router integration demo of the shared **trivia** machine — actor-authoritative routing over the browser History API, with no framework.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## What This Demonstrates
+
+- Shared trivia machine reused without framework-specific business logic
+- `createBrowserHistory` + `createRouter` + `connectRouter` wiring actor ↔ `window.history` — the quiz states map to `/`, `/trivia`, `/win`, and `/lose`
+- Shell, catalog, and component kit imported from the workspace-only [`@xmachines/play-dom-gallery-demo`](../play-dom-gallery-demo/README.md) renderer gallery
+- Actor-authoritative navigation: only `/` is reachable from a cold start, and a deep link to `/trivia` while idle is overwritten back (State-Driven Reset)
+- Stately inspector attached at creation via `options.inspect` — the debug panel's **Show Inspector** button opens the live machine in its own window
+
+## Running the Demo
+
+From the repository root:
+
+```bash
+pnpm install
+pnpm --filter @xmachines/play-dom-router-trivia-demo run dev
+```
+
+Then open `http://localhost:3061`.
+
+## Step-by-Step Code Flow
+
+1. `src/main.ts` looks up `#app` (throws if absent), calls `initApp(app)`, and registers unload cleanup.
+2. `src/App.ts` starts the actor, connects the router, mounts the shell, and returns one cleanup function. There is no component tree — `initApp(container) => cleanup` is the DOM family's top-level unit.
+3. `src/runtime.ts` creates the inspector, the `createPlayer` factory (`definePlayer` with `options.inspect`), the pre-built `routeMap` (`createRouteMap(triviaMachine)`), and `createRegistryResult` — the demo's DOM-free wiring layer.
+4. `src/router.ts` extracts the route tree with `extractMachineRoutes`, wraps `window.history` with `createBrowserHistory`, pairs the two through `createRouter`, and installs the bridge with `connectRouter`.
+5. `initShell` (from [`@xmachines/play-dom-gallery-demo`](../play-dom-gallery-demo/README.md)) writes the demo chrome, connects `createPlayUI(registryResult)(actor, content)`, and appends the debug panel.
+6. Browser tests in `test/browser/` delegate to the shared trivia router suite.
+
+## Key Files
+
+- `src/main.ts` - host lookup, app bootstrap, and unload cleanup
+- `src/App.ts` - actor lifecycle, router connection, and `initShell` composition
+- `src/runtime.ts` - actor factory (`createPlayer`), pre-built `routeMap`, and `createRegistryResult`
+- `src/router.ts` - `createBrowserHistory`, `createRouter`, and `connectRouter` wiring
+- `test/library-pattern.test.ts` - architecture boundary and invariant assertions
+- `test/browser/shared-demo.browser.test.ts` - delegates to the shared trivia router browser suite
+
+## Architecture Invariants
+
+1. **Actor Authority:** A `popstate` event or an in-view `route` action becomes a `play.route` event. The actor evaluates it against its guards and decides — the URL never decides.
+2. **Passive Infrastructure:** The bridge writes `window.history` and the DOM renders `actor.currentView`. Neither holds business state.
+3. **State-Driven Reset:** A jump to `/trivia` or `/win` whose status prerequisite does not hold bounces the actor home, and the bridge writes the URL back to `/`.
+
+## Available Scripts
+
+| Command                                                                 | Description                                    |
+| ----------------------------------------------------------------------- | ---------------------------------------------- |
+| `pnpm --filter @xmachines/play-dom-router-trivia-demo run dev`          | Start Vite dev server (http://localhost:3061/) |
+| `pnpm --filter @xmachines/play-dom-router-trivia-demo run build`        | Build production bundle                        |
+| `pnpm --filter @xmachines/play-dom-router-trivia-demo run preview`      | Preview built bundle                           |
+| `pnpm --filter @xmachines/play-dom-router-trivia-demo run test`         | Run Vitest test suite                          |
+| `pnpm --filter @xmachines/play-dom-router-trivia-demo run test:browser` | Run browser-focused Vitest suite               |
+
+## Verification
+
+```bash
+pnpm --filter @xmachines/play-dom-router-trivia-demo run test
+pnpm --filter @xmachines/play-dom-router-trivia-demo run test:browser
+```
+
+Expected result: the library-pattern assertions pass, and the shared trivia router browser suite completes.
+
+## Learn More
+
+- [Play DOM Router](../../../api/@xmachines/play-dom-router/README.md)
+- [DOM renderer gallery](../play-dom-gallery-demo/README.md)
+- [Play Router](../../../api/@xmachines/play-router/README.md)
+- [Inspecting a Running Actor](../../../guides/inspector.md)

package/examples/@xmachines/play-react-gallery-demo/README.md

@@ -0,0 +1,123 @@
+[Examples](../../README.md) / @xmachines/play-react-gallery-demo
+
+# @xmachines/play-react-gallery-demo
+
+React renderer gallery for [`@xmachines/play-react`](../../../api/@xmachines/play-react/README.md) — all nine shared machines behind one picker, actor + `PlayRenderer` without a router.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## What This Demonstrates
+
+- All nine shared machines (fetch, stopwatch, tic-tac-toe, temperature, TodoMVC, trivia, donut, flight, auth) reused without framework-specific business logic
+- A home-screen picker: selecting a machine stops the previous actor, creates a FRESH actor for the chosen machine, and renders its views; "Back to gallery" returns to the picker
+- The five-component demo kit (Page, Panel, Field, Button, Text) defined ONCE and registered with every machine's typed `defineRegistry` catalog — `Field` also renders the declarative `checks`/`formErrors` contract behind `[data-demo-error]`
+- Routing machines run WITHOUT a router here — navigation happens via their in-view route-action buttons; the actor owns view switching
+- One shared Stately inspector (`createDemoInspector()`) serving every selection — the debug panel's **Show Inspector** button opens the live machine in its own window
+
+## Running the Demo
+
+From the repository root:
+
+```bash
+pnpm install
+pnpm --filter @xmachines/play-react-gallery-demo run dev
+```
+
+Then open `http://localhost:3021`.
+
+## Step-by-Step Code Flow
+
+1. `src/main.tsx` mounts `<App />`.
+2. `src/App.tsx` renders the picker; `openMachine(entry)` stops any previous actor and calls `entry.createRuntime(inspector.inspect)`.
+3. `src/machines.ts` holds one `GalleryMachineEntry` per machine: `createRuntime` builds a fresh started actor via `definePlayer({ machine, options: { inspect } })()` and its `defineRegistry(catalog, { components: demoComponents, actions: create<Prefix>ActionHandlers(actor) })`.
+4. `src/catalogs.ts` builds all nine catalogs with `defineCatalog(schema, <prefix>CatalogDef)` — router demos import theirs from the barrel.
+5. `Shell` wraps `<PlayUIProvider actor registryResult><PlayRenderer /></PlayUIProvider>` in the standard demo chrome plus the `DebugPanel`; the gallery passes `title` and a `nav` slot carrying the "Back to gallery" button.
+6. Browser tests in `test/browser/` delegate one file per machine to that machine's shared renderer suite.
+
+## Key Files
+
+- `src/main.tsx` - React entry point that mounts `<App />`
+- `src/App.tsx` - picker, per-selection actor lifecycle, and `Shell` composition
+- `src/machines.ts` - the machine registry: slug, label, and `createRuntime` per machine
+- `src/catalogs.ts` - the nine built catalogs plus the `KitCatalog` typing alias
+- `src/components/` - the five-component kit (Page, Panel, Field, Button, Text) plus `Shell` and `DebugPanel`
+- `src/index.ts` - barrel exporting `App`, the kit, `demoComponents`, `Shell`, `DebugPanel`, and every built catalog for the router demos
+- `test/library-pattern.test.ts` - architecture boundary and invariant assertions
+- `test/browser/<slug>-demo.browser.test.tsx` - one file per machine, delegating to the shared suites
+- `test/browser/gallery-picker.browser.test.tsx` - picker smoke test (open/close roundtrip)
+
+## Architecture Invariants
+
+1. **Actor Authority:** Views dispatch machine events (and `route` actions on routing machines) to the actor. The actor evaluates guards and transitions — React never decides which view to render.
+2. **Passive Infrastructure:** `PlayRenderer` observes the `actor.currentView` atom only. It holds no business state and makes no routing decisions.
+3. **Fresh Actor Per Selection:** Reopening a machine always starts from its initial state, matching the demo inspector's "one live machine" semantics.
+
+## Available Scripts
+
+| Command                                                             | Description                                    |
+| ------------------------------------------------------------------- | ---------------------------------------------- |
+| `pnpm --filter @xmachines/play-react-gallery-demo run dev`          | Start Vite dev server (http://localhost:3021/) |
+| `pnpm --filter @xmachines/play-react-gallery-demo run build`        | Build production bundle                        |
+| `pnpm --filter @xmachines/play-react-gallery-demo run preview`      | Preview built bundle                           |
+| `pnpm --filter @xmachines/play-react-gallery-demo run test`         | Run Vitest test suite                          |
+| `pnpm --filter @xmachines/play-react-gallery-demo run test:browser` | Run browser-focused Vitest suite               |
+
+## Verification
+
+```bash
+pnpm --filter @xmachines/play-react-gallery-demo run test
+pnpm --filter @xmachines/play-react-gallery-demo run test:browser
+```
+
+Expected result: library-pattern invariant tests pass and all nine machine suites plus the picker smoke test complete.
+
+## Learn More
+
+- [play-react](../../../api/@xmachines/play-react/README.md)
+- [React Router TodoMVC demo](../play-react-router-todomvc-demo/README.md)
+- [Inspecting a Running Actor](../../../guides/inspector.md)
+
+## Interfaces
+
+- [GalleryMachineEntry](interfaces/GalleryMachineEntry.md)
+- [GalleryRuntime](interfaces/GalleryRuntime.md)
+
+## Type Aliases
+
+- [AuthCatalog](type-aliases/AuthCatalog.md)
+- [DonutCatalog](type-aliases/DonutCatalog.md)
+- [FetchCatalog](type-aliases/FetchCatalog.md)
+- [FlightCatalog](type-aliases/FlightCatalog.md)
+- [GalleryActor](type-aliases/GalleryActor.md)
+- [GallerySlug](type-aliases/GallerySlug.md)
+- [KitCatalog](type-aliases/KitCatalog.md)
+- [StopwatchCatalog](type-aliases/StopwatchCatalog.md)
+- [TemperatureCatalog](type-aliases/TemperatureCatalog.md)
+- [TicTacToeCatalog](type-aliases/TicTacToeCatalog.md)
+- [TodoMvcCatalog](type-aliases/TodoMvcCatalog.md)
+- [TriviaCatalog](type-aliases/TriviaCatalog.md)
+
+## Variables
+
+- [authCatalog](variables/authCatalog.md)
+- [Button](variables/Button.md)
+- [DebugPanel](variables/DebugPanel.md)
+- [demoComponents](variables/demoComponents.md)
+- [donutCatalog](variables/donutCatalog.md)
+- [fetchCatalog](variables/fetchCatalog.md)
+- [Field](variables/Field.md)
+- [flightCatalog](variables/flightCatalog.md)
+- [galleryMachines](variables/galleryMachines.md)
+- [Page](variables/Page.md)
+- [Panel](variables/Panel.md)
+- [Shell](variables/Shell.md)
+- [stopwatchCatalog](variables/stopwatchCatalog.md)
+- [temperatureCatalog](variables/temperatureCatalog.md)
+- [Text](variables/Text.md)
+- [ticTacToeCatalog](variables/ticTacToeCatalog.md)
+- [todoMvcCatalog](variables/todoMvcCatalog.md)
+- [triviaCatalog](variables/triviaCatalog.md)
+
+## Functions
+
+- [App](functions/App.md)

package/examples/@xmachines/play-react-gallery-demo/functions/App.md

@@ -0,0 +1,13 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / App
+
+# Function: App()
+
+```ts
+function App(): Element;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/App.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/App.tsx#L28)
+
+## Returns
+
+`Element`

package/examples/@xmachines/play-react-gallery-demo/interfaces/GalleryMachineEntry.md

@@ -0,0 +1,13 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / GalleryMachineEntry
+
+# Interface: GalleryMachineEntry
+
+Defined in: [packages/play-react/examples/gallery/src/machines.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/machines.ts#L86)
+
+## Properties
+
+| Property                                            | Type                                                 | Description                                                                                                                              | Defined in                                                                                                                                                                        |
+| --------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-createruntime"></a> `createRuntime` | (`inspect`) => [`GalleryRuntime`](GalleryRuntime.md) | Create a fresh, STARTED actor and its registry for one selection. The caller owns the runtime and must stop the actor when done with it. | [packages/play-react/examples/gallery/src/machines.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/machines.ts#L94) |
+| <a id="property-label"></a> `label`                 | `string`                                             | Picker button label and machine-view title.                                                                                              | [packages/play-react/examples/gallery/src/machines.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/machines.ts#L89) |
+| <a id="property-slug"></a> `slug`                   | [`GallerySlug`](../type-aliases/GallerySlug.md)      | -                                                                                                                                        | [packages/play-react/examples/gallery/src/machines.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/machines.ts#L87) |

package/examples/@xmachines/play-react-gallery-demo/interfaces/GalleryRuntime.md

@@ -0,0 +1,14 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / GalleryRuntime
+
+# Interface: GalleryRuntime
+
+Defined in: [packages/play-react/examples/gallery/src/machines.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/machines.ts#L81)
+
+One live selection: the started actor plus its registry.
+
+## Properties
+
+| Property                                              | Type                                                                                               | Defined in                                                                                                                                                                        |
+| ----------------------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`                   | [`GalleryActor`](../type-aliases/GalleryActor.md)                                                  | [packages/play-react/examples/gallery/src/machines.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/machines.ts#L82) |
+| <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](../../../../api/@xmachines/play-react/interfaces/DefineRegistryResult.md) | [packages/play-react/examples/gallery/src/machines.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/machines.ts#L83) |

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

@@ -0,0 +1,9 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / AuthCatalog
+
+# Type Alias: AuthCatalog
+
+```ts
+type AuthCatalog = typeof authCatalog;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/catalogs.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/catalogs.ts#L47)

package/examples/@xmachines/play-react-gallery-demo/type-aliases/DonutCatalog.md

@@ -0,0 +1,9 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / DonutCatalog
+
+# Type Alias: DonutCatalog
+
+```ts
+type DonutCatalog = typeof donutCatalog;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/catalogs.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/catalogs.ts#L41)

package/examples/@xmachines/play-react-gallery-demo/type-aliases/FetchCatalog.md

@@ -0,0 +1,9 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / FetchCatalog
+
+# Type Alias: FetchCatalog
+
+```ts
+type FetchCatalog = typeof fetchCatalog;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/catalogs.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/catalogs.ts#L23)

package/examples/@xmachines/play-react-gallery-demo/type-aliases/FlightCatalog.md

@@ -0,0 +1,9 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / FlightCatalog
+
+# Type Alias: FlightCatalog
+
+```ts
+type FlightCatalog = typeof flightCatalog;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/catalogs.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/catalogs.ts#L44)

package/examples/@xmachines/play-react-gallery-demo/type-aliases/GalleryActor.md

@@ -0,0 +1,20 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / GalleryActor
+
+# Type Alias: GalleryActor
+
+```ts
+type GalleryActor =
+	| FetchActor
+	| StopwatchActor
+	| TicTacToeActor
+	| TemperatureActor
+	| TodoMvcActor
+	| TriviaActor
+	| DonutActor
+	| FlightActor
+	| AuthActor;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/machines.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/machines.ts#L58)
+
+Any of the nine machine actors — what the gallery Shell and DebugPanel accept.

package/examples/@xmachines/play-react-gallery-demo/type-aliases/GallerySlug.md

@@ -0,0 +1,18 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / GallerySlug
+
+# Type Alias: GallerySlug
+
+```ts
+type GallerySlug =
+	| "fetch"
+	| "stopwatch"
+	| "tictactoe"
+	| "temperature"
+	| "todomvc"
+	| "trivia"
+	| "donut"
+	| "flight"
+	| "auth";
+```
+
+Defined in: [packages/play-react/examples/gallery/src/machines.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/machines.ts#L69)

package/examples/@xmachines/play-react-gallery-demo/type-aliases/KitCatalog.md

@@ -0,0 +1,16 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / KitCatalog
+
+# Type Alias: KitCatalog
+
+```ts
+type KitCatalog = FetchCatalog;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/catalogs.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/catalogs.ts#L57)
+
+The catalog the shared component KIT is typed against.
+
+ComponentFn only constrains a component through the catalog's component
+schemas, and those are identical across all nine catalogs — so the kit is
+typed once against this representative and registers cleanly with every
+machine's defineRegistry call.

package/examples/@xmachines/play-react-gallery-demo/type-aliases/StopwatchCatalog.md

@@ -0,0 +1,9 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / StopwatchCatalog
+
+# Type Alias: StopwatchCatalog
+
+```ts
+type StopwatchCatalog = typeof stopwatchCatalog;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/catalogs.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/catalogs.ts#L26)

package/examples/@xmachines/play-react-gallery-demo/type-aliases/TemperatureCatalog.md

@@ -0,0 +1,9 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / TemperatureCatalog
+
+# Type Alias: TemperatureCatalog
+
+```ts
+type TemperatureCatalog = typeof temperatureCatalog;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/catalogs.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/catalogs.ts#L32)

package/examples/@xmachines/play-react-gallery-demo/type-aliases/TicTacToeCatalog.md

@@ -0,0 +1,9 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / TicTacToeCatalog
+
+# Type Alias: TicTacToeCatalog
+
+```ts
+type TicTacToeCatalog = typeof ticTacToeCatalog;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/catalogs.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/catalogs.ts#L29)

package/examples/@xmachines/play-react-gallery-demo/type-aliases/TodoMvcCatalog.md

@@ -0,0 +1,9 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / TodoMvcCatalog
+
+# Type Alias: TodoMvcCatalog
+
+```ts
+type TodoMvcCatalog = typeof todoMvcCatalog;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/catalogs.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/catalogs.ts#L35)

package/examples/@xmachines/play-react-gallery-demo/type-aliases/TriviaCatalog.md

@@ -0,0 +1,9 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / TriviaCatalog
+
+# Type Alias: TriviaCatalog
+
+```ts
+type TriviaCatalog = typeof triviaCatalog;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/catalogs.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/catalogs.ts#L38)

package/examples/@xmachines/play-react-gallery-demo/variables/Button.md

@@ -0,0 +1,12 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / Button
+
+# Variable: Button
+
+```ts
+const Button: ComponentFn<KitCatalog, "Button">;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/components/Button.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/components/Button.tsx#L8)
+
+Button — emits `press`; the spec's `on.press` binding decides what happens
+(a host action sending a machine event, or a built-in like setState).

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

@@ -0,0 +1,21 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / DebugPanel
+
+# Variable: DebugPanel
+
+```ts
+const DebugPanel: FC<{
+  actor: GalleryActor;
+  inspector: DemoInspector;
+}>;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/components/DebugPanel.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/components/DebugPanel.tsx#L19)
+
+DebugPanel — Live debug footer. Observes the state of the actor through a computed
+label atom and displays it, plus the button that opens the Stately inspector window.
+Works with any of the nine gallery actors.
+
+The label atom collapses the union of nine snapshot types into one string, so one
+`useAtomEffect` call can watch it. The gallery hands this component a NEW actor each
+time the user opens a machine, so the atom and the watcher both depend on `[actor]`:
+a watcher with no dependency list stays on the atoms of the FIRST actor.

package/examples/@xmachines/play-react-gallery-demo/variables/Field.md

@@ -0,0 +1,24 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / Field
+
+# Variable: Field
+
+```ts
+const Field: ComponentFn<KitCatalog, "Field">;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/components/Field.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/components/Field.tsx#L21)
+
+Field — labelled input with two-way $bindState binding and declarative
+validation checks.
+
+`useBoundProp` wires `value` to the bound view-state path when the spec
+passes `{ $bindState: "/path" }`, so a Button can read the draft back with
+`{ $state: "/path" }` params and clear it with a chained `setState` built-in.
+
+Registration happens by rendering: `useFieldValidation` registers the bound
+state path (and its `props.checks`) with the ValidationProvider so the
+`validateForm` built-in sees it. The error DISPLAY deliberately reads
+`props.formErrors` — the result map `validateForm` wrote back to view state —
+rather than the local hook, so every renderer surfaces errors at the same
+moment: after submit. The message node carries `data-demo-error={testId}`,
+the DOM contract the shared browser suites assert on.

package/examples/@xmachines/play-react-gallery-demo/variables/Page.md

@@ -0,0 +1,14 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / Page
+
+# Variable: Page
+
+```ts
+const Page: ComponentFn<KitCatalog, "Page">;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/components/Page.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/components/Page.tsx#L10)
+
+Page — the root of every view.
+
+Renders `data-page={page}` (the state name) so the browser suites can wait
+for a specific view, plus an `h2` title and the spec children.

package/examples/@xmachines/play-react-gallery-demo/variables/Panel.md

@@ -0,0 +1,15 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / Panel
+
+# Variable: Panel
+
+```ts
+const Panel: ComponentFn<KitCatalog, "Panel">;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/components/Panel.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/components/Panel.tsx#L11)
+
+Panel — generic container leaf.
+
+Renders an optional title and note, then its spec `children` — which is how
+repeat containers work: the element renders ONCE and its children render per
+item, so a Panel is both the list shell and the row.

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

@@ -0,0 +1,26 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / Shell
+
+# Variable: Shell
+
+```ts
+const Shell: FC<{
+  actor: GalleryActor;
+  inspector: DemoInspector;
+  nav?: ReactNode;
+  registryResult: DefineRegistryResult;
+  router?: unknown;
+  title?: string;
+}>;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/components/Shell.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/components/Shell.tsx#L19)
+
+Demo Shell layout component.
+
+Wraps PlayRenderer and DebugPanel in the standard demo chrome. There is no
+NavBar — every ported machine drives its own navigation through in-view
+buttons (route actions on routing machines, plain events elsewhere).
+
+The gallery App and the router demos share this one Shell: the gallery
+passes `title`/`nav` (machine label + "Back to gallery" button); router
+demos render it bare with their bridged `router`.

package/examples/@xmachines/play-react-gallery-demo/variables/Text.md

@@ -0,0 +1,15 @@
+[Examples](../../../README.md) / [@xmachines/play-react-gallery-demo](../README.md) / Text
+
+# Variable: Text
+
+```ts
+const Text: ComponentFn<KitCatalog, "Text">;
+```
+
+Defined in: [packages/play-react/examples/gallery/src/components/Text.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/examples/gallery/src/components/Text.tsx#L11)
+
+Text — one paragraph of live text.
+
+`String(props.value)` on purpose: $state-resolved values may arrive as
+numbers (counts, elapsed millis), and React must never render `NaN`-prone
+raw objects — the DOM contract promises text.