@xmachines/docs 6.1.0 → 7.1.0

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

@@ -0,0 +1,75 @@
+[Examples](../../README.md) / @xmachines/play-solid-router-trivia-demo
+
+# @xmachines/play-solid-router-trivia-demo
+
+Solid Router integration demo of the shared **trivia** machine for the XMachines Play architecture.
+
+[![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
+- `PlayRouterProvider` renderer-based integration with `@solidjs/router` — the game states map to `/`, `/trivia`, `/win`, and `/lose`
+- Shell, catalog, and component kit imported from the workspace-only [`@xmachines/play-solid-gallery-demo`](../play-solid-gallery-demo/README.md) renderer gallery
+- Actor-authoritative navigation: a deep link to `/trivia` (or `/win`) whose status prerequisite does not hold bounces home and the URL is overwritten (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-solid-router-trivia-demo run dev
+```
+
+Then open `http://localhost:3069`.
+
+## Step-by-Step Code Flow
+
+1. `src/main.tsx` mounts `<App />` on `#root` via Solid's `render`.
+2. `src/runtime.ts` creates the actor, starts it, builds the `registryResult` from `triviaCatalog` + `demoComponents` (both from [`@xmachines/play-solid-gallery-demo`](../play-solid-gallery-demo/README.md)), and pre-builds `routes` and `routeMap` — all module-level singletons, so no re-render can recreate them.
+3. `src/App.tsx` declares the machine's routes on `<Router>` and renders `Layout` as the router root.
+4. `Layout` reads `useNavigate()`, `useLocation()`, and `useParams()` and hands them to `PlayRouterProvider` as its `router` prop; `onCleanup` stops the actor when Solid disposes of the layout.
+5. `PlayRouterProvider` creates the `SolidRouterBridge` synchronously, forwards navigation intent to the actor, reflects actor-approved routes back to the URL, and disconnects in `onCleanup`.
+6. `Shell` (from the renderer gallery) receives `actor`, `router`, `registryResult`, and `inspector`.
+7. Browser tests in `test/browser/` delegate to the shared trivia router suite.
+
+## Key Files
+
+- `src/main.tsx` - Vite bootstrap that mounts `<App />` via Solid's `render`
+- `src/runtime.ts` - actor lifecycle, registry, route extraction, and route map creation
+- `src/App.tsx` - Solid Router wiring, `PlayRouterProvider` integration, and renderer composition
+- `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:** Navigation triggers URL changes, which the `PlayRouterProvider` intercepts and converts into `play.route` events. The actor evaluates these events against its internal guards and transitions.
+2. **Passive Infrastructure:** The router does not execute business logic. The actor dictates whether navigation is permitted.
+3. **State-Driven Reset:** An external history change to a route the machine has not earned is overwritten back from actor state — the URL always reflects the machine.
+
+## Available Scripts
+
+| Command                                                                   | Description                                    |
+| ------------------------------------------------------------------------- | ---------------------------------------------- |
+| `pnpm --filter @xmachines/play-solid-router-trivia-demo run dev`          | Start Vite dev server (http://localhost:3069/) |
+| `pnpm --filter @xmachines/play-solid-router-trivia-demo run build`        | Build production bundle                        |
+| `pnpm --filter @xmachines/play-solid-router-trivia-demo run preview`      | Preview built bundle                           |
+| `pnpm --filter @xmachines/play-solid-router-trivia-demo run test`         | Run Vitest test suite                          |
+| `pnpm --filter @xmachines/play-solid-router-trivia-demo run test:browser` | Run browser-focused Vitest suite               |
+
+## Verification
+
+```bash
+pnpm --filter @xmachines/play-solid-router-trivia-demo run test
+pnpm --filter @xmachines/play-solid-router-trivia-demo run test:browser
+```
+
+Expected result: the library-pattern invariants pass in Node and the shared trivia router browser suite completes.
+
+## Learn More
+
+- [Solid Router adapter](../../../api/@xmachines/play-solid-router/README.md)
+- [Solid renderer gallery](../play-solid-gallery-demo/README.md)
+- [Inspecting a Running Actor](../../../guides/inspector.md)

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

@@ -0,0 +1,130 @@
+[Examples](../../README.md) / @xmachines/play-svelte-gallery-demo
+
+# @xmachines/play-svelte-gallery-demo
+
+Svelte 5 renderer gallery for [`@xmachines/play-svelte`](../../../api/@xmachines/play-svelte/README.md) — all nine demo 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, and the auth login wall) 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 in Svelte 5 runes mode and registered with every machine's typed `defineRegistry` catalog — `Field` also registers its declarative `checks` with the `ValidationProvider` and renders each `formErrors` message in a `data-demo-error` node
+- 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-svelte-gallery-demo run dev
+```
+
+Then open `http://localhost:3023`.
+
+## Step-by-Step Code Flow
+
+1. `src/main.ts` mounts `App.svelte` with Svelte's `mount` — the gallery App takes no props, because it owns the per-selection actor lifecycle itself.
+2. `src/App.svelte` keeps the inspector in its `<script module>` block (one singleton per page) and the current selection in `$state.raw`; `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.svelte` wraps `<PlayUIProvider actor registryResult><PlayRenderer /></PlayUIProvider>` in the standard demo chrome plus the `DebugPanel`; the gallery passes `title` and a `nav` snippet carrying the "Back to gallery" button.
+6. Browser tests in `test/browser/` delegate one file per machine to that machine's shared renderer suite.
+
+```svelte
+<!-- src/App.svelte (shape) -->
+<script module lang="ts">
+	const inspector = createDemoInspector();
+</script>
+
+<script lang="ts">
+	let active: ActiveMachine | null = $state.raw(null);
+
+	function openMachine(entry: GalleryMachineEntry): void {
+		active?.runtime.actor.stop();
+		active = { entry, runtime: entry.createRuntime(inspector.inspect) };
+	}
+</script>
+```
+
+## Key Files
+
+- `src/main.ts` - Svelte entry point that mounts `App.svelte`
+- `src/App.svelte` - 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.ts` - one file per machine, delegating to the shared suites
+- `test/browser/gallery-picker.browser.test.ts` - 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 — Svelte 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.
+4. **Runes Only:** Every `.svelte` file in this package compiles in runes mode (`$props`, `$state`, `$derived`, `$effect`), the policy `xmSvelteRunes()` enforces workspace-wide.
+
+## Available Scripts
+
+| Command                                                              | Description                                    |
+| -------------------------------------------------------------------- | ---------------------------------------------- |
+| `pnpm --filter @xmachines/play-svelte-gallery-demo run dev`          | Start Vite dev server (http://localhost:3023/) |
+| `pnpm --filter @xmachines/play-svelte-gallery-demo run build`        | Build production bundle                        |
+| `pnpm --filter @xmachines/play-svelte-gallery-demo run preview`      | Preview built bundle                           |
+| `pnpm --filter @xmachines/play-svelte-gallery-demo run test`         | Run Vitest test suite                          |
+| `pnpm --filter @xmachines/play-svelte-gallery-demo run test:browser` | Run browser-focused Vitest suite               |
+
+## Verification
+
+```bash
+pnpm --filter @xmachines/play-svelte-gallery-demo run test
+pnpm --filter @xmachines/play-svelte-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-svelte](../../../api/@xmachines/play-svelte/README.md)
+- [Inspecting a Running Actor](../../../guides/inspector.md)
+
+## Interfaces
+
+- [GalleryMachineEntry](interfaces/GalleryMachineEntry.md)
+- [GalleryRuntime](interfaces/GalleryRuntime.md)
+
+## Type Aliases
+
+- [App](type-aliases/App.md)
+- [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
+
+- [App](variables/App.md)
+- [authCatalog](variables/authCatalog.md)
+- [demoComponents](variables/demoComponents.md)
+- [donutCatalog](variables/donutCatalog.md)
+- [fetchCatalog](variables/fetchCatalog.md)
+- [flightCatalog](variables/flightCatalog.md)
+- [galleryMachines](variables/galleryMachines.md)
+- [stopwatchCatalog](variables/stopwatchCatalog.md)
+- [temperatureCatalog](variables/temperatureCatalog.md)
+- [ticTacToeCatalog](variables/ticTacToeCatalog.md)
+- [todoMvcCatalog](variables/todoMvcCatalog.md)
+- [triviaCatalog](variables/triviaCatalog.md)

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

@@ -0,0 +1,13 @@
+[Examples](../../../README.md) / [@xmachines/play-svelte-gallery-demo](../README.md) / GalleryMachineEntry
+
+# Interface: GalleryMachineEntry
+
+Defined in: [packages/play-svelte/examples/gallery/src/machines.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/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-svelte/examples/gallery/src/machines.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/examples/gallery/src/machines.ts#L94) |
+| <a id="property-label"></a> `label`                 | `string`                                             | Picker button label and machine-view title.                                                                                              | [packages/play-svelte/examples/gallery/src/machines.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/examples/gallery/src/machines.ts#L89) |
+| <a id="property-slug"></a> `slug`                   | [`GallerySlug`](../type-aliases/GallerySlug.md)      | -                                                                                                                                        | [packages/play-svelte/examples/gallery/src/machines.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/examples/gallery/src/machines.ts#L87) |

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

@@ -0,0 +1,14 @@
+[Examples](../../../README.md) / [@xmachines/play-svelte-gallery-demo](../README.md) / GalleryRuntime
+
+# Interface: GalleryRuntime
+
+Defined in: [packages/play-svelte/examples/gallery/src/machines.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/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-svelte/examples/gallery/src/machines.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/examples/gallery/src/machines.ts#L82) |
+| <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](../../../../api/@xmachines/play-svelte/interfaces/DefineRegistryResult.md) | [packages/play-svelte/examples/gallery/src/machines.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/examples/gallery/src/machines.ts#L83) |

package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/App.md

@@ -0,0 +1,9 @@
+[Examples](../../../README.md) / [@xmachines/play-svelte-gallery-demo](../README.md) / App
+
+# Type Alias: App
+
+```ts
+type App = SvelteComponent;
+```
+
+Defined in: `svelte`

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,16 @@
+[Examples](../../../README.md) / [@xmachines/play-svelte-gallery-demo](../README.md) / KitCatalog
+
+# Type Alias: KitCatalog
+
+```ts
+type KitCatalog = FetchCatalog;
+```
+
+Defined in: [packages/play-svelte/examples/gallery/src/catalogs.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/examples/gallery/src/catalogs.ts#L57)
+
+The catalog the shared component KIT is typed against.
+
+ComponentContext 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-svelte-gallery-demo/type-aliases/StopwatchCatalog.md

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

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

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

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

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

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

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

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

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

package/examples/@xmachines/play-svelte-gallery-demo/variables/App.md

@@ -0,0 +1,9 @@
+[Examples](../../../README.md) / [@xmachines/play-svelte-gallery-demo](../README.md) / App
+
+# Variable: App
+
+```ts
+const App: LegacyComponentType;
+```
+
+Defined in: `svelte`

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

@@ -0,0 +1,126 @@
+[Examples](../../../README.md) / [@xmachines/play-svelte-gallery-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>;
+        repeat: {
+           inner?: unknown;
+           kind: "any";
+           optional: true;
+        };
+        slots: {
+           inner?: SchemaType<"array", SchemaType<..., ...>>;
+           kind: "record";
+           optional: true;
+        };
+        type: SchemaType<"ref", string>;
+        visible: {
+           inner?: unknown;
+           kind: "any";
+           optional: true;
+        };
+     }>>;
+     root: SchemaType<"string", unknown>;
+  }>;
+}, {
+  actions: {
+     login: {
+        description: "Log in with a username (sends auth.login to the machine)";
+        params: ZodObject<{
+           username: ZodString;
+        }, $strip>;
+     };
+     logout: {
+        description: "Log out and return to home (sends auth.logout)";
+     };
+     route: {
+        description: "Navigate to a route by state id (e.g. '#home', '#login', '#dashboard')";
+        params: ZodObject<{
+           params: ZodOptional<ZodRecord<ZodString, ZodString>>;
+           to: ZodString;
+        }, $strip>;
+     };
+  };
+  components: {
+     Button: {
+        props: ZodObject<{
+           disabled: ZodOptional<ZodBoolean>;
+           label: ZodString;
+           testId: ZodOptional<ZodString>;
+           variant: ZodOptional<ZodEnum<{
+              danger: "danger";
+              primary: "primary";
+              secondary: "secondary";
+           }>>;
+        }, $strip>;
+     };
+     Field: {
+        props: ZodObject<{
+           checks: ZodOptional<ZodArray<ZodCustom<ValidationCheck, ValidationCheck>>>;
+           formErrors: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString>>>;
+           inputType: ZodOptional<ZodEnum<{
+              email: "email";
+              text: "text";
+              textarea: "textarea";
+           }>>;
+           label: ZodString;
+           placeholder: ZodOptional<ZodString>;
+           testId: ZodOptional<ZodString>;
+           value: ZodOptional<ZodString>;
+        }, $strip>;
+     };
+     Page: {
+        props: ZodObject<{
+           page: ZodString;
+           title: ZodString;
+        }, $strip>;
+     };
+     Panel: {
+        props: ZodObject<{
+           note: ZodOptional<ZodString>;
+           testId: ZodOptional<ZodString>;
+           title: ZodOptional<ZodString>;
+           tone: ZodOptional<ZodEnum<{
+              danger: "danger";
+              default: "default";
+              muted: "muted";
+              success: "success";
+           }>>;
+        }, $strip>;
+     };
+     Text: {
+        props: ZodObject<{
+           testId: ZodOptional<ZodString>;
+           tone: ZodOptional<ZodEnum<{
+              danger: "danger";
+              default: "default";
+              muted: "muted";
+              success: "success";
+           }>>;
+           value: ZodString;
+        }, $strip>;
+     };
+  };
+}>;
+```
+
+Defined in: [packages/play-svelte/examples/gallery/src/catalogs.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/examples/gallery/src/catalogs.ts#L46)
+
+Built catalogs, one per machine — router demos import theirs from here.

package/examples/@xmachines/play-svelte-gallery-demo/variables/demoComponents.md

@@ -0,0 +1,21 @@
+[Examples](../../../README.md) / [@xmachines/play-svelte-gallery-demo](../README.md) / demoComponents
+
+# Variable: demoComponents
+
+```ts
+const demoComponents: object;
+```
+
+Defined in: [packages/play-svelte/examples/gallery/src/components/demo-components.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/examples/gallery/src/components/demo-components.ts#L11)
+
+demoComponents — the full catalog component map, shared with the router demos.
+
+## Type Declaration
+
+| Name                                  | Type                  | Defined in                                                                                                                                                                                                              |
+| ------------------------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-button"></a> `Button` | `LegacyComponentType` | [packages/play-svelte/examples/gallery/src/components/demo-components.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/examples/gallery/src/components/demo-components.ts#L15) |
+| <a id="property-field"></a> `Field`   | `LegacyComponentType` | [packages/play-svelte/examples/gallery/src/components/demo-components.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/examples/gallery/src/components/demo-components.ts#L14) |
+| <a id="property-page"></a> `Page`     | `LegacyComponentType` | [packages/play-svelte/examples/gallery/src/components/demo-components.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/examples/gallery/src/components/demo-components.ts#L12) |
+| <a id="property-panel"></a> `Panel`   | `LegacyComponentType` | [packages/play-svelte/examples/gallery/src/components/demo-components.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/examples/gallery/src/components/demo-components.ts#L13) |
+| <a id="property-text"></a> `Text`     | `LegacyComponentType` | [packages/play-svelte/examples/gallery/src/components/demo-components.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-svelte/examples/gallery/src/components/demo-components.ts#L16) |