@xmachines/docs 1.0.0-beta.34 → 1.0.0-beta.36

package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md

@@ -1,141 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-vue-router](../README.md) / VueBaseRouteMap
-
-# Class: VueBaseRouteMap
-
-Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/base-route-map.ts#L100)
-
-Shared bidirectional route map base class.
-
-All framework adapter `RouteMap` classes extend this — they add no logic of their
-own and inherit the full public API from here.
-
-**Lookup strategy:**
-
-- Static paths (no `:param`) → O(1) `Map` lookup
-- Dynamic paths → O(k) bucket-indexed scan using `URLPattern`, where `k` is the number
-  of routes sharing the same first path segment
-- Results are cached after the first match in an LRU cache (default 500 entries,
-  configurable via the `cacheSize` constructor option)
-
-**Pattern syntax** (`:param` / `:param?`):
-
-- `:param` — required segment, matches exactly one non-`/` segment
-- `:param?` — optional segment, matches zero or one non-`/` segment
-
-## Example
-
-```typescript
-import { BaseRouteMap } from "@xmachines/play-router";
-
-const map = new BaseRouteMap([
-	{ stateId: "home", path: "/" },
-	{ stateId: "profile", path: "/profile/:userId" },
-	{ stateId: "settings", path: "/settings/:section?" },
-]);
-
-map.getStateIdByPath("/"); // "home"
-map.getStateIdByPath("/profile/123"); // "profile"
-map.getStateIdByPath("/settings"); // "settings"
-map.getStateIdByPath("/unknown"); // null
-
-map.getPathByStateId("profile"); // "/profile/:userId"
-map.getPathByStateId("missing"); // null
-```
-
-## Extended by
-
-- [`RouteMap`](RouteMap.md)
-
-## Constructors
-
-### Constructor
-
-```ts
-new VueBaseRouteMap(mappings, options?): BaseRouteMap;
-```
-
-Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/base-route-map.ts#L125)
-
-Build a route map from an array of state ID ↔ path mappings.
-
-Static paths (no `:param`) are indexed in an O(1) `Map`.
-Parameterized paths are compiled to `URLPattern` and grouped into first-segment
-buckets for efficient candidate selection.
-
-#### Parameters
-
-| Parameter            | Type                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                  |
-| -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `mappings`           | [`RouteMapping`](../interfaces/RouteMapping.md)[] | Array of `{ stateId, path }` entries. Order determines priority when multiple patterns could match the same path.                                                                                                                                                                                                                                                                                            |
-| `options`            | \{ `cacheSize?`: `number`; \}                     | Optional configuration. `options.cacheSize`: Maximum number of resolved parameterized path lookups to cache. Defaults to `500`. Increase for applications with many unique parameterized URL values (e.g. user profile pages with thousands of distinct IDs). After eviction the path falls back to the O(k) bucket pattern scan — correct but slower. Minimum effective value is `1` (QuickLRU constraint). |
-| `options.cacheSize?` | `number`                                          | -                                                                                                                                                                                                                                                                                                                                                                                                            |
-
-#### Returns
-
-`BaseRouteMap`
-
-## Methods
-
-### getPathByStateId()
-
-```ts
-getPathByStateId(stateId): string | null;
-```
-
-Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/base-route-map.ts#L209)
-
-Look up the path pattern registered for a state ID.
-
-#### Parameters
-
-| Parameter | Type     | Description                                               |
-| --------- | -------- | --------------------------------------------------------- |
-| `stateId` | `string` | State machine state ID (e.g., `"profile"`, `"#settings"`) |
-
-#### Returns
-
-`string` \| `null`
-
-The registered path pattern, or `null` if the state ID is unknown
-
-#### Example
-
-```typescript
-map.getPathByStateId("profile"); // "/profile/:userId"
-map.getPathByStateId("missing"); // null
-```
-
----
-
-### getStateIdByPath()
-
-```ts
-getStateIdByPath(path): string | null;
-```
-
-Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/base-route-map.ts#L174)
-
-Resolve a URL path to its mapped state ID.
-
-Strips query strings and hash fragments before matching. Tries an O(1) exact
-lookup first, then falls back to bucket-indexed pattern matching. Results are
-cached after the first pattern match.
-
-#### Parameters
-
-| Parameter | Type     | Description                                                                    |
-| --------- | -------- | ------------------------------------------------------------------------------ |
-| `path`    | `string` | URL pathname, optionally including query/hash (e.g., `"/profile/123?ref=nav"`) |
-
-#### Returns
-
-`string` \| `null`
-
-The mapped state ID, or `null` if no route matches
-
-#### Example
-
-```typescript
-map.getStateIdByPath("/profile/123"); // "profile"
-map.getStateIdByPath("/unknown"); // null
-```

package/api/@xmachines/shared/functions/defineXmVitestConfig.md

@@ -1,25 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/shared](../README.md) / defineXmVitestConfig
-
-# Function: defineXmVitestConfig()
-
-```ts
-function defineXmVitestConfig(importMetaUrl, overrides): UserConfig;
-```
-
-Defined in: [index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/shared/src/index.ts#L10)
-
-Create a Vitest config with XMachines workspace defaults.
-
-This wrapper exposes the helper at the package top-level so API docs
-render it under `@xmachines/shared` instead of nested module pages.
-
-## Parameters
-
-| Parameter       | Type                            |
-| --------------- | ------------------------------- |
-| `importMetaUrl` | `string`                        |
-| `overrides`     | `Record`\<`string`, `unknown`\> |
-
-## Returns
-
-`UserConfig`

package/api/@xmachines/shared/functions/xmAliases.md

@@ -1,24 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/shared](../README.md) / xmAliases
-
-# Function: xmAliases()
-
-```ts
-function xmAliases(importMetaUrl): Record<string, string>;
-```
-
-Defined in: [index.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/shared/src/index.ts#L20)
-
-Build Vite/Vitest alias entries for all `@xmachines/*` workspace packages.
-
-This wrapper exposes the helper at the package top-level so API docs
-render it under `@xmachines/shared` instead of nested module pages.
-
-## Parameters
-
-| Parameter       | Type     |
-| --------------- | -------- |
-| `importMetaUrl` | `string` |
-
-## Returns
-
-`Record`\<`string`, `string`\>

package/api/_media/README.md

@@ -1,404 +0,0 @@
-[Documentation](../../README.md) / @xmachines/play-dom
-
-# @xmachines/play-dom
-
-**Vanilla DOM renderer for XMachines**
-
-Framework-free view rendering driven by an XState v5 actor's `currentView` TC39 Signal. Implements the same catalog-typed `defineRegistry` / `ComponentFn` / `ActionFn` API surface as `@json-render/react`, `/solid`, `/vue`, and `/svelte`.
-
-## Installation
-
-```bash
-npm install @xmachines/play-dom @json-render/core zod
-```
-
-## Key Exports
-
-| Export                                              | Description                                                                                                                     |
-| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `createPlayUI(registryResult, options?)`            | Batteries-included factory: returns `mount(actor, container) → disconnect` — parallel to `PlayUIProvider` in framework packages |
-| `createRenderer(catalog, componentMap)`             | One-call factory: returns `mount(actor, container, options?) → disconnect`                                                      |
-| `connectRenderer(options)`                          | Functional API: connect actor → DOM with full options                                                                           |
-| `defineRegistry(catalog, { components, actions })`  | Build a catalog-typed `DomRegistry` with typed action handlers                                                                  |
-| `UIProviderOptions`                                 | Standard options interface: `validationFunctions`, `navigate`, `functions`, `onRenderError`, `fallback`                         |
-| `PlayRenderer`                                      | Class-based renderer — `connect()` / `disconnect()` lifecycle                                                                   |
-| `schema`                                            | DOM schema for `defineCatalog` (mirrors `@json-render/react/schema`)                                                            |
-| `ComponentFn<C, K>`                                 | Catalog-typed DOM component function type                                                                                       |
-| `ComponentContext<C, K>`                            | Context passed to each `ComponentFn` — `props`, `on`, `emit`, `children`, `bindings`, `ctx`                                     |
-| `ActionFn<C, K>`                                    | `(params, setState, state) => Promise<void>` — catalog-typed action handler                                                     |
-| `SetState`                                          | `(updater: prev => next) => void` — write to the local state store                                                              |
-| `BaseComponentProps<P>`                             | Base type for catalog component prop definitions                                                                                |
-| `CatalogHasActions<C>`                              | Conditional type: `true` when catalog declares actions                                                                          |
-| `renderSpec(spec, store, registry, send, handlers)` | Pure Spec → DOM renderer (advanced use)                                                                                         |
-
-## Quick Start — `createPlayUI`
-
-The standard entry point — mirrors `PlayUIProvider` in framework packages. Pass a `registryResult` (from `defineRegistry`) plus optional `UIProviderOptions`, and get back a `mount` function:
-
-```typescript
-import { defineRegistry, createPlayUI, schema } from "@xmachines/play-dom";
-import { defineCatalog } from "@json-render/core";
-import { z } from "zod";
-import type { ComponentFn } from "@xmachines/play-dom";
-
-// 1. Define catalog
-const catalog = defineCatalog(schema, {
-	components: {
-		Home: { props: z.object({ title: z.string() }) },
-		Login: { props: z.object({ title: z.string(), username: z.string().optional() }) },
-	},
-	actions: {
-		login: { params: z.object({ username: z.string() }) },
-		logout: {},
-	},
-});
-
-// 2. Build registry with typed action handlers
-const registryResult = defineRegistry(catalog, {
-	components: {
-		Home: ({ props }) => {
-			const el = document.createElement("section");
-			el.textContent = props.title;
-			return el;
-		},
-		Login: ({ props, on }) => {
-			const section = document.createElement("section");
-			const button = document.createElement("button");
-			button.textContent = "Log In";
-			const submit = on("submit");
-			button.addEventListener("click", () => submit.emit());
-			section.append(button);
-			return section;
-		},
-	},
-	actions: {
-		login: async (params) => {
-			if (!params) return;
-			actor.send({ type: "auth.login", username: params.username });
-		},
-		logout: async () => actor.send({ type: "auth.logout" }),
-	},
-});
-
-// 3. Create the UI factory (once, at module level)
-const ui = createPlayUI(registryResult, {
-	onRenderError: (error, elementType) => console.warn(`<${elementType}> crashed:`, error),
-	fallback: (() => {
-		const el = document.createElement("p");
-		el.textContent = "Loading…";
-		return el;
-	})(),
-});
-
-// 4. Mount when actor and container are ready
-const actor = createPlayer()();
-actor.start();
-
-const disconnect = ui.mount(actor, document.getElementById("app")!);
-
-// Cleanup:
-disconnect();
-```
-
-## Quick Start — `createRenderer`
-
-The lower-level one-call pattern — takes a catalog and component map directly:
-
-```typescript
-import { createRenderer, schema } from "@xmachines/play-dom";
-import { defineCatalog } from "@json-render/core";
-import { z } from "zod";
-import type { ComponentFn } from "@xmachines/play-dom";
-
-// 1. Define catalog
-const catalog = defineCatalog(schema, {
-	components: {
-		Home: { props: z.object({ title: z.string() }) },
-		Login: { props: z.object({ title: z.string(), username: z.string().optional() }) },
-	},
-	actions: {
-		login: { params: z.object({ username: z.string() }) },
-		logout: {},
-	},
-});
-type AppCatalog = typeof catalog;
-
-// 2. Implement components
-const Home: ComponentFn<AppCatalog, "Home"> = ({ props }) => {
-	const el = document.createElement("section");
-	el.textContent = props.title;
-	return el;
-};
-
-const Login: ComponentFn<AppCatalog, "Login"> = ({ props, on }) => {
-	const section = document.createElement("section");
-	const input = document.createElement("input");
-	input.value = props.username ?? "";
-	input.addEventListener("input", () => ctx.store.update((s) => ({ ...s, username: input.value })));
-
-	const button = document.createElement("button");
-	button.textContent = "Log In";
-	const submit = on("submit");
-	button.addEventListener("click", () => submit.emit());
-
-	section.append(input, button);
-	return section;
-};
-
-// 3. Create the renderer factory (once, at module level)
-const mount = createRenderer(catalog, { Home, Login });
-
-// 4. Mount when actor and container are ready
-const actor = createPlayer()();
-actor.start();
-
-const disconnect = mount(actor, document.getElementById("app")!);
-
-// Cleanup:
-disconnect();
-```
-
-## `defineRegistry` — Full Control
-
-When you need `registryResult.executeAction()` or want to share the registry with `connectRenderer`:
-
-```typescript
-import { defineRegistry, connectRenderer, schema } from "@xmachines/play-dom";
-import { defineCatalog } from "@json-render/core";
-import { z } from "zod";
-
-const catalog = defineCatalog(schema, {
-	components: {
-		Home: { props: z.object({ title: z.string() }) },
-	},
-	actions: {
-		login: { params: z.object({ username: z.string() }) },
-		logout: {},
-	},
-});
-
-// Action handlers receive (params, setState, state)
-// - params: resolved from the spec's on.submit.params (e.g. { $state: "/username" })
-// - setState: write to the local state store (e.g. to clear a form)
-// - state: current local state store snapshot
-const registryResult = defineRegistry(catalog, {
-	components: {
-		Home: ({ props }) => {
-			const el = document.createElement("section");
-			el.textContent = props.title;
-			return el;
-		},
-	},
-	actions: {
-		login: async (params, setState) => {
-			if (!params) return;
-			actor.send({ type: "auth.login", username: params.username });
-			setState((prev) => ({ ...prev, username: "" })); // clear the form
-		},
-		logout: async () => actor.send({ type: "auth.logout" }),
-	},
-});
-
-const disconnect = connectRenderer({
-	actor,
-	registry: registryResult.registry,
-	registryResult, // wires setState/state from xstate store automatically
-	container: document.getElementById("app")!,
-});
-```
-
-## Component API
-
-### `ComponentFn<C, K>` — component function signature
-
-```typescript
-const MyCard: ComponentFn<AppCatalog, "Card"> = ({
-	props, // catalog-typed props for this component
-	children, // Node[] — rendered child nodes
-	on, // (eventName) => EventHandle — get emit() for catalog-declared events
-	emit, // (eventName) => void — fire an event directly
-	bindings, // Record<string, string> — $bindState paths for two-way bindings
-	ctx, // DomRenderContext — store, send, handlers, loading, functions
-}) => {
-	const el = document.createElement("div");
-	el.append(...children);
-	return el;
-};
-```
-
-### Two-way binding with `$bindState`
-
-In the view spec:
-
-```json
-{ "username": { "$bindState": "/username" } }
-```
-
-In the component:
-
-```typescript
-const Login: ComponentFn<AppCatalog, "Login"> = ({ props, ctx }) => {
-	const input = document.createElement("input");
-	input.value = props.username ?? "";
-	// Write back to the store on user input
-	input.addEventListener("input", () => {
-		ctx.store.update((s) => ({ ...s, username: input.value }));
-	});
-	return input;
-};
-```
-
-### `on()` — event handle
-
-```typescript
-const submit = on("submit"); // EventHandle
-if (submit.bound) {
-	button.addEventListener("click", (e) => {
-		if (submit.shouldPreventDefault) e.preventDefault();
-		submit.emit(); // resolves params from store, calls action handler
-	});
-}
-```
-
-### `ActionFn` — action handler signature
-
-```typescript
-// Full signature — all three params are available
-login: async (params, setState, state) => {
-  actor.send({ type: "auth.login", username: params!.username });
-  setState(prev => ({ ...prev, username: "" }));
-  console.log("previous state was:", state);
-},
-
-// Params-only — setState/state can be omitted if unused
-logout: async () => actor.send({ type: "auth.logout" }),
-route: async (params) => actor.send({ type: "play.route", to: params!.to }),
-```
-
-## Spec Features
-
-`renderSpec` / `renderElement` supports these spec directives:
-
-| Directive                                              | Description                                                                           |
-| ------------------------------------------------------ | ------------------------------------------------------------------------------------- |
-| `visible`                                              | Boolean or `{ $state: "/path" }` — hide element when false                            |
-| `on.submit` / `on.click`                               | Action binding — `{ action: "login", params: { username: { $state: "/username" } } }` |
-| `repeat: { statePath, key? }`                          | Render children once per item in the state array at `statePath`                       |
-| `watch: { "/path": actionBinding }`                    | Fire action when store path changes after mount                                       |
-| `props.username: { $bindState: "/username" }`          | Two-way binding — read from store, write back via `ctx.store.update()`                |
-| `props.value: { $state: "/value" }`                    | Read-only store reference                                                             |
-| `props.label: { $computed: "computeFn", args: [...] }` | Computed prop via `functions` map                                                     |
-
-## `PlayRenderer` — class API
-
-```typescript
-import { PlayRenderer, defineRegistry } from "@xmachines/play-dom";
-
-const { registry, registryResult } = defineRegistry(catalog, { components, actions });
-
-const renderer = new PlayRenderer(document.getElementById("app")!, actor, registry, {
-	registryResult,
-});
-
-renderer.connect(); // starts watching actor.currentView
-renderer.disconnect(); // stops watching, clears container
-
-// double-connect is safe — connect() calls disconnect() internally if already connected
-```
-
-## Options Reference
-
-### `ConnectRendererOptions` / `PlayDomOptions`
-
-| Option           | Type                            | Description                                                                   |
-| ---------------- | ------------------------------- | ----------------------------------------------------------------------------- |
-| `actor`          | `AbstractActor & Viewable`      | Actor providing `currentView` signal                                          |
-| `registry`       | `DomRegistry`                   | Component renderer map from `defineRegistry`                                  |
-| `registryResult` | `DefineRegistryResult`          | Preferred — auto-wires `setState`/`state` from xstate store                   |
-| `handlers`       | `Record<string, ActionHandler>` | Pre-resolved handlers (legacy / advanced)                                     |
-| `container`      | `HTMLElement`                   | DOM element to render into                                                    |
-| `fallback`       | `HTMLElement \| null`           | Shown on initial mount when view is `null` (initial mount only)               |
-| `store`          | `StateStore`                    | External store — controlled mode, overrides `spec.state`                      |
-| `loading`        | `boolean`                       | Streaming mode — suppresses missing-child warnings, exposes `ctx.ctx.loading` |
-
-## Learn More
-
-- [DOM Router adapter `@xmachines/play-dom-router`](../play-dom-router/README.md)
-- [API reference](../../_media/README.md)
-- [Play RFC](../../packages/docs/rfc/play.md)
-
-@xmachines/play-dom — Vanilla DOM renderer for XMachines Play architecture.
-
-Public API split into two layers:
-
-**XMachines layer** (this package):
-
-- `createRenderer()` — one-call factory: returns `mount(actor, container, options?) → disconnect`
-- `PlayRenderer` — class-based renderer with `connect()` / `disconnect()` lifecycle
-- `connectRenderer()` — functional API (backward-compat alternative to `PlayRenderer`)
-- `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()
-- `SetState` — state updater function passed to ActionFn
-- `CatalogHasActions` — conditional type: true when catalog declares actions
-- `BaseComponentProps` — base props type for catalog component definitions
-
-## Classes
-
-- [PlayRenderer](classes/PlayRenderer.md)
-
-## Interfaces
-
-- [ComponentContext](interfaces/ComponentContext.md)
-- [ConnectRendererOptions](interfaces/ConnectRendererOptions.md)
-- [CreatePlayUIOptions](interfaces/CreatePlayUIOptions.md)
-- [DefineRegistryResult](interfaces/DefineRegistryResult.md)
-- [DomRenderContext](interfaces/DomRenderContext.md)
-- [EventHandle](interfaces/EventHandle.md)
-- [MountOptions](interfaces/MountOptions.md)
-- [PlayDomOptions](interfaces/PlayDomOptions.md)
-- [UIProviderOptions](interfaces/UIProviderOptions.md)
-
-## Type Aliases
-
-- [ActionFn](type-aliases/ActionFn.md)
-- [Actions](type-aliases/Actions.md)
-- [BaseComponentProps](type-aliases/BaseComponentProps.md)
-- [CatalogHasActions](type-aliases/CatalogHasActions.md)
-- [ComponentFn](type-aliases/ComponentFn.md)
-- [ComponentRegistry](type-aliases/ComponentRegistry.md)
-- [DefineRegistryOptions](type-aliases/DefineRegistryOptions.md)
-- [DomComponentRenderer](type-aliases/DomComponentRenderer.md)
-- [DomRegistry](type-aliases/DomRegistry.md)
-- [DomSchema](type-aliases/DomSchema.md)
-- [MountFn](type-aliases/MountFn.md)
-- [RenderErrorHandler](type-aliases/RenderErrorHandler.md)
-- [SetState](type-aliases/SetState.md)
-
-## Variables
-
-- [schema](variables/schema.md)
-
-## Functions
-
-- [connectRenderer](functions/connectRenderer.md)
-- [createPlayUI](functions/createPlayUI.md)
-- [createRenderer](functions/createRenderer.md)
-- [defineRegistry](functions/defineRegistry.md)
-- [renderSpec](functions/renderSpec.md)
-
-## References
-
-### RenderErrorHandler
-
-Re-exports [RenderErrorHandler](type-aliases/RenderErrorHandler.md)