@xmachines/docs 6.1.0 → 7.0.0

package/guides/inspector.md

@@ -27,7 +27,9 @@ Create an inspector and hand its `inspect` observer to [`definePlayer`](../api/@
 ```typescript
 import { createBrowserInspector } from "@statelyai/inspect";
 import { definePlayer } from "@xmachines/play-xstate";
-import { appMachine } from "./machine.js";
+import type { AnyStateMachine } from "xstate";
+
+declare const appMachine: AnyStateMachine; // your machine
 
 const { inspect } = createBrowserInspector();
 
@@ -45,6 +47,12 @@ actor.start();
 That is the whole integration. [`PlayerOptions.inspect`](../api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md) is forwarded verbatim to XState's `createActor`, so anything XState accepts there is accepted here — a function, or an observer object with a `next` method:
 
 ```typescript
+import { definePlayer } from "@xmachines/play-xstate";
+import type { AnyStateMachine, InspectionEvent } from "xstate";
+
+declare const machine: AnyStateMachine; // your machine
+declare const sink: { write(event: InspectionEvent): void }; // your log
+
 // Function form — the common case
 definePlayer({ machine, options: { inspect: (event) => console.log(event.type) } });
 
@@ -61,6 +69,13 @@ Two properties of the attachment point matter in practice.
 **It is configured on the factory, not on the instance.** `definePlayer({ machine, options })` returns a factory; `options.inspect` belongs to that configuration, and every actor the factory creates reports to the same observer. The factory's per-call options bag carries `snapshot` for restoring persisted state and nothing else — there is no per-instance `inspect` override. When one factory produces several live actors (multi-user scenarios, SSR, tests), demultiplex the stream by root instead:
 
 ```typescript
+import { definePlayer } from "@xmachines/play-xstate";
+import type { AnyStateMachine, InspectionEvent } from "xstate";
+
+declare const machine: AnyStateMachine; // your machine
+
+const inspect = (event: InspectionEvent) => console.log(event.type);
+
 const createPlayer = definePlayer({ machine, options: { inspect } });
 
 const alice = createPlayer({ userId: "alice" });
@@ -87,7 +102,7 @@ The event types are XState's: `@xstate.actor` when an actor registers, `@xstate.
 
 `@xstate.actor` fires from _inside_ the actor's constructor. The `actorRef` it carries is a real `PlayerActor`, but a mid-construction one: `state`, `currentRoute`, `currentView` and `initialRoute` do not exist yet, and reading them there throws — XState itself refuses to read a snapshot in that window.
 
-```typescript
+```typescript fragment
 const inspect = (event: InspectionEvent) => {
 	if (event.type === "@xstate.actor") {
 		// ❌ throws — the atoms are not assigned yet
@@ -109,11 +124,17 @@ Capture the reference during construction if you need it, and read the atoms fro
 An inspector that is only created when the user asks for it — a dev-tools toggle, a keyboard shortcut, a debug panel button — cannot be passed to `definePlayer`, which ran at module scope long before the click. Pass a forwarding function instead, so the attachment point is fixed at factory time while the destination stays swappable:
 
 ```typescript
-let current: ((event: InspectionEvent) => void) | undefined;
+import { createBrowserInspector } from "@statelyai/inspect";
+import { definePlayer } from "@xmachines/play-xstate";
+import type { AnyStateMachine, InspectionEvent, Observer } from "xstate";
+
+declare const appMachine: AnyStateMachine; // your machine
+
+let current: Observer<InspectionEvent> | undefined;
 
 const createPlayer = definePlayer({
 	machine: appMachine,
-	options: { inspect: (event) => current?.(event) },
+	options: { inspect: (event) => current?.next?.(event) },
 });
 
 // Later, from a click handler
@@ -135,6 +156,10 @@ There is a catch worth knowing before you ship it: events that arrive while `cur
 
 ```typescript
 import { createWebSocketInspector } from "@statelyai/inspect";
+import { definePlayer } from "@xmachines/play-xstate";
+import type { AnyStateMachine } from "xstate";
+
+declare const appMachine: AnyStateMachine; // your machine
 
 const { inspect } = createWebSocketInspector({ url: "ws://localhost:8080" });
 
@@ -155,22 +180,49 @@ pnpm --filter @xmachines/play-react-demo run dev
 
 Click **Show Inspector** in the debug panel at the bottom of the page. The inspector opens in its own window with the machine already drawn and the session's history replayed, and it keeps updating as you log in, navigate, and log out.
 
-The demos share one controller, `createDemoInspector()` from `@xmachines/play-actor-shared`, which each demo passes straight through to `definePlayer`:
+The demos share one controller, `createDemoInspector()`, which each demo passes straight through to `definePlayer`. The controller lives in a private package of this repository, so you cannot install it. The block below shows the same wiring with the public API. It keeps each event from the creation of the actor, and it replays the events when the user opens the inspector:
 
 ```typescript
-const inspector = createDemoInspector();
+import { createBrowserInspector } from "@statelyai/inspect";
+import { definePlayer } from "@xmachines/play-xstate";
+import type { AnyStateMachine, InspectionEvent, Observer } from "xstate";
+
+declare const appMachine: AnyStateMachine; // your machine
+
+const buffer: InspectionEvent[] = [];
+let current: Observer<InspectionEvent> | undefined;
 
 const actor = definePlayer({
-	machine: authMachine,
-	options: { inspect: inspector.inspect },
+	machine: appMachine,
+	options: {
+		inspect: (event) => {
+			if (current) {
+				current.next?.(event);
+				return;
+			}
+			// Keep the last 500 events while nobody opens the inspector. A long session drops
+			// its oldest events, also the registration of the root actor, and the inspector
+			// then has no machine to draw. The demo controller pins each registration for
+			// that reason, and it costs more code.
+			buffer.push(event);
+			if (buffer.length > 500) buffer.shift();
+		},
+	},
 })();
 actor.start();
 
-// The debug panel's button
-<button onClick={() => inspector.show()}>Show Inspector</button>;
+// The click handler of the "Show Inspector" button of the debug panel
+export function showInspector() {
+	if (current) return;
+	// The inspector holds these events until its window connects, and it drops the oldest
+	// past `maxDeferredEvents`. The limit leaves room for the events of the handshake, so
+	// the inspector keeps every event of the replay.
+	current = createBrowserInspector({ maxDeferredEvents: 1000 }).inspect;
+	for (const event of buffer.splice(0)) current.next?.(event);
+}
 ```
 
-The controller answers the late-opening problem from the previous section: it buffers serialized events from actor creation, pins the registration of every live root so it can never roll out of the bounded buffer, and flushes those buffers when the inspector window completes its handshake. Several machines can be alive together — one for each document a host has open — and the handshake replays each of them. That is a demo trade-off rather than a general recommendation — every transition pays serialization whether or not anyone ever opens the inspector — but it is what makes the button work at any point in a session. The shared package's own README, at `packages/play-actor/examples/shared/README.md` in this repository, documents the design in full.
+The demo controller answers the late-opening problem from the previous section: it buffers serialized events from actor creation, pins the registration of every live root so it can never roll out of the bounded buffer, and flushes those buffers when the inspector window completes its handshake. Several machines can be alive together — one for each document a host has open — and the handshake replays each of them. That is a demo trade-off rather than a general recommendation — every transition pays serialization whether or not anyone ever opens the inspector — but it is what makes the button work at any point in a session. The shared package's own README, at `packages/play-actor/examples/shared/README.md` in this repository, documents the design in full.
 
 ---
 
@@ -179,6 +231,14 @@ The controller answers the late-opening problem from the previous section: it bu
 **Cost.** Inspection serializes events. A `console.log` observer is cheap; a browser inspector posting every transition, and any buffering scheme layered on top, is not. Gate the inspector behind a development-only branch, and prefer letting the bundler drop it entirely:
 
 ```typescript
+/// <reference types="vite/client" />
+import { createBrowserInspector } from "@statelyai/inspect";
+import { definePlayer } from "@xmachines/play-xstate";
+import type { AnyStateMachine } from "xstate";
+
+declare const appMachine: AnyStateMachine; // your machine
+
+// `import.meta.env.DEV` is the development flag of Vite
 const options = import.meta.env.DEV ? { inspect: createBrowserInspector().inspect } : {};
 
 const createPlayer = definePlayer({ machine: appMachine, options });

package/guides/routing.md

@@ -55,8 +55,11 @@ A **modifier** follows a param, a wildcard or a group:
 | `*`      | zero or more | matches                  |
 
 ```ts
+import { createMachine } from "xstate";
+
 const machine = createMachine({
 	id: "app",
+	initial: "home",
 	states: {
 		home: { meta: { route: "/" } },
 		profile: { meta: { route: "/profile/:userId" } },
@@ -184,7 +187,7 @@ CAUTION: a parallel state loses the position of its other regions when it is the
 
 A state whose navigation must re-enter the domain too declares the flag for itself. Here the root runs its `exit` and `entry` actions on each navigation to `dashboard`:
 
-```ts
+```ts fragment
 states: {
 	dashboard: { meta: { route: { path: "/dashboard", reenter: true } } },
 },

package/guides/state-machines.md

@@ -33,7 +33,6 @@ const authSetup = setup({
 	types: {
 		context: {} as { username: string | null },
 		events: {} as { type: "auth.login"; username: string } | { type: "auth.logout" },
-		input: {} as undefined,
 	},
 });
 
@@ -47,7 +46,8 @@ const authMachine = authSetup.createMachine({
 				"auth.login": {
 					target: "authenticated",
 					actions: authSetup.assign({
-						username: ({ event }) => event.username,
+						username: ({ event }) =>
+							event.type === "auth.login" ? event.username : null,
 					}),
 				},
 			},
@@ -78,6 +78,7 @@ XMachines extends XState's `meta` field on each state node. This is where routin
 
 ```typescript
 import { typedSpec } from "@xmachines/play-view";
+import { setup } from "xstate";
 
 const appMachine = setup({/* ... */}).createMachine({
 	id: "app",
@@ -126,6 +127,8 @@ const appMachine = setup({/* ... */}).createMachine({
 
 The machine's whole context is available to every view through the **`/context` projection**: the derived spec's `state` carries `context: <machine context>`. Specs read it with ordinary state expressions — `{ $state: "/context/username" }` in props, `visible` conditions, or `repeat.statePath`. The subtree is **read-only**: context changes only through machine events, and a `$bindState`/`setState` write under `/context` throws. URL data lives at its own paths (`/context/params/…`, `/context/query/…`, written into context by `formatPlayRouteTransitions`), so a URL param can never shadow a machine-owned field. When validating specs with tools like `validateSpec`, validate the **derived** view (`actor.currentView.get()`) — its `state` honestly describes the store contents — not the raw `meta.view`. A context change re-emits the view with the same `viewKey`; providers respond by refreshing `/context` in the live store, not by remounting the UI.
 
+**Give each state its own id, and do not use an array index as an id.** XState does not check that the ids of the states are unique, and a repeated id makes a `#id` target name two states. XMachines keys the route, the view and its store on the id of a state, so two states that share an id share one route entry, one store, and one key. An array index is a whole number from 0 to 2³² − 2 with no leading zero, such as `"42"`. JavaScript lists such a key first in every object that is keyed on ids, so the route of its state loses its place in the branch. [`@xmachines/play-xstate`](../api/@xmachines/play-xstate/README.md) writes one warning for each machine that breaks these rules.
+
 **The machine is the single source of truth for both routing and views.** There is no separate route configuration file. There is no switch statement in a component deciding what to render based on the URL. The state machine encodes all of that.
 
 ### A layout and its pages: `outlets`
@@ -133,6 +136,11 @@ The machine's whole context is available to every view through the **`/context`
 Without outlets, the deepest active state that declares a view wins, and a view on a parent state stays off the screen. Declare `outlets` in the view of the parent to show the parent view AND the view of its active child. Each outlet names an element of the parent view, and the view of the child goes into that element:
 
 ```typescript
+import { typedSpec, type ViewMeta } from "@xmachines/play-view";
+import { setup } from "xstate";
+
+declare const menuView: ViewMeta, homeView: ViewMeta, searchView: ViewMeta; // your views
+
 const shell = typedSpec({
 	root: "shell",
 	state: { collapsed: false },
@@ -166,11 +174,11 @@ const appMachine = setup({/* ... */}).createMachine({
 - **The key of an outlet** is the key of a child state in `states`, or `"*"` for each active child that has no outlet of its own. A child with neither stays off the screen.
 - **A compound state** fills one outlet with its active child. **A parallel state** fills one outlet for each region, in the order of `states`.
 - **`slot`** names a named slot of the element. Omit it to append the child view to the `children` of the element. The component of the element renders the slot, as the renderer of your framework describes.
-- **The view of a child** is the deepest view in its active subtree, and a child view can declare `outlets` of its own for a nested layout. A parallel state without outlets shows the region of the URL when that region has a view, and its first region that has a view otherwise.
+- **The view of a child** is the deepest view in its active subtree, and a child view can declare `outlets` of its own for a nested layout. A parallel state without outlets shows the region of the routes when that region has a view, and its first region that has a view otherwise. The region of the routes keeps the screen while it sits in a state without a route of its own.
 
 The derived spec holds the elements of every composed view. The keys of the outer view stay as you wrote them, and each key of a child view gets the id of its state as a prefix, for example `app.page.search/root`, so two views never collide.
 
-The `viewKey` of a composed view is the id of the outermost state that declares `outlets`. A change of the page therefore keeps the store of the layout: the `collapsed` value in the example above does not change. The first time that a page shows, the provider writes the keys of its authored `state` that the store does not hold. A page that comes back finds the values that it left. All the pages of one layout share one store, so two pages that declare the same key share one value: give each page its own keys. When two composed views declare the same state key, the outer view wins, and the library writes a warning.
+The `viewKey` of a composed view is the id of the outermost state that declares `outlets`. A change of the page therefore keeps the store of the layout: the `collapsed` value in the example above does not change. The first time that a page shows, the provider writes the keys of its authored `state` that the store does not hold. A page that comes back finds the values that it left. All the pages of one layout share one store, so two pages that declare the same key share one value: give each page its own keys. When two composed views declare the same state key, the outer view wins. The library writes one warning for each layout that names every key that two of its views declare, also for two pages that are never on the screen together.
 
 An outlet that names an element that its view does not hold throws `InvalidViewOutletError`. The actor reports it through its `onError` option, and it keeps the last good view.
 
@@ -198,7 +206,7 @@ A URL path has one hierarchy, and it cannot hold the branches of two regions. Ke
 
 For routing to work, the machine must respond to `play.route` events (sent by router bridges when the user navigates). Writing these transitions by hand is mechanical:
 
-```typescript
+```typescript fragment
 // Without formatPlayRouteTransitions — verbose and repetitive
 states: {
   home: {
@@ -218,6 +226,7 @@ states: {
 
 ```typescript
 import { formatPlayRouteTransitions } from "@xmachines/play-xstate/routing";
+import { setup } from "xstate";
 
 const appMachine = setup({/* ... */}).createMachine(
 	formatPlayRouteTransitions({
@@ -234,7 +243,7 @@ const appMachine = setup({/* ... */}).createMachine(
 
 [`formatPlayRouteTransitions`](../api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md) inspects all state nodes with a `meta.route` and generates the corresponding `play.route` guard transitions. The machine's context must include `params` and `query` fields (populated by the router bridge when params or query strings are present):
 
-```typescript
+```typescript fragment
 types: {
   context: {} as {
     params: Record<string, string>;
@@ -252,7 +261,12 @@ types: {
 Guards are the mechanism by which the actor controls whether a transition occurs. They are pure functions of `{ context, event }` that return a boolean.
 
 ```typescript
+import { setup } from "xstate";
+
 const authSetup = setup({
+	types: {
+		context: {} as { isAuthenticated: boolean; role: "user" | "admin" },
+	},
 	guards: {
 		isAuthenticated: ({ context }) => context.isAuthenticated,
 		isAdmin: ({ context }) => context.role === "admin",
@@ -280,7 +294,7 @@ Each combinator resolves a guard NAME against the `guards` of `setup()`, so a na
 
 Context is the machine's persistent data store. It survives transitions and can be read and updated by actions:
 
-```typescript
+```typescript fragment
 // Context is defined in setup({ types })
 types: {
   context: {} as {
@@ -307,22 +321,30 @@ Context is accessed in guards, actions, and when computing routes or views. It i
 A snapshot is a point-in-time serialisation of the machine's current state and context. XState produces snapshots in a JSON-compatible format:
 
 ```typescript
+import { definePlayer } from "@xmachines/play-xstate";
+import type { AnyStateMachine } from "xstate";
+
+declare const machine: AnyStateMachine; // your machine
+
+const createPlayer = definePlayer({ machine });
+const actor = createPlayer();
+actor.start();
+
 const snapshot = actor.getSnapshot();
 // snapshot.value → current state node name, e.g. "dashboard"
 // snapshot.context → current context object
 
-// Stop and serialize
+// Serialize and stop
+const saved = JSON.stringify(actor.getPersistedSnapshot());
 actor.stop();
-const saved = JSON.stringify(snapshot);
 
 // Restore
-const restored = JSON.parse(saved);
-const actor = createPlayer(undefined, { snapshot: restored });
-actor.start();
+const restored = createPlayer(undefined, { snapshot: JSON.parse(saved) });
+restored.start();
 // Actor resumes from where it left off
 ```
 
-[`definePlayer`](../api/@xmachines/play-xstate/index/functions/definePlayer.md) accepts an optional `restore` argument for this purpose. Restoration is useful for server-side rendering (hydrate with the server's snapshot), session persistence (resume after page reload), and testing (start from a known mid-flow state).
+The factory that [`definePlayer`](../api/@xmachines/play-xstate/index/functions/definePlayer.md) returns accepts an optional second argument, `{ snapshot }`, for this purpose. Serialize the result of `getPersistedSnapshot()`, and not of `getSnapshot()`: XState restores from the persisted form. Restoration is useful for server-side rendering (hydrate with the server's snapshot), session persistence (resume after page reload), and testing (start from a known mid-flow state).
 
 ---
 

package/guides/views.md

@@ -68,6 +68,9 @@ The view is an OPTIONAL capability of the actor. Compose it with `withView` of [
 ```ts
 import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
 import { withView } from "@xmachines/play-xstate/view";
+import type { AnyStateMachine } from "xstate";
+
+declare const machine: AnyStateMachine; // your machine
 
 const actor = definePlayer({ machine, actor: compose(PlayerActor, withView) })();
 actor.start();
@@ -81,7 +84,7 @@ The actor then holds `currentView`, a `ReadonlyAtom<PlaySpec | null>`. An applic
 
 **The deepest active state that declares a view supplies it**, unless a parent composes it. A state that declares no view shows the view of its nearest ancestor that declares one. An ancestor view without `outlets` does not show, because the view of its descendant replaces it:
 
-```ts
+```ts fragment
 states: {
 	dashboard: {
 		meta: { view: dashboardView },   // shows in dashboard.overview
@@ -96,13 +99,13 @@ states: {
 
 When no active state declares a view, `currentView` holds `null`, and the renderer shows its `fallback` content.
 
-A **parallel** state follows the same region as the route derivation: the first region whose active states declare a `meta.route`, or the first region when no region does. The view on the screen therefore belongs to the region of the URL. When that region holds no view, the view comes from another active region, so one region can own the URL and another region can own the view. Keep the routes in one region: the [State Machines](state-machines.md#a-layout-and-its-pages-outlets) guide shows what a second routed region does to the URL.
+A **parallel** state follows the same region as the route derivation: the first region whose active states declare a `meta.route`, else the first region that declares a route in any state, else the first region. A region that owns the routes therefore keeps the screen while it sits in a state without a route, such as a load. The view on the screen therefore belongs to the region of the URL. When that region holds no view, the view comes from another active region, so one region can own the URL and another region can own the view. Keep the routes in one region: the [State Machines](state-machines.md#a-layout-and-its-pages-outlets) guide shows what a second routed region does to the URL.
 
 ### A layout and its pages: `outlets`
 
 A parent view that declares `outlets` shows itself AND the view of its active child. Each outlet names an element of the parent view, and the view of the child goes into that element:
 
-```ts
+```ts fragment
 const shell = typedSpec({
 	root: "shell",
 	state: { collapsed: false },
@@ -130,6 +133,7 @@ states: {
 - `slot` names a named slot of the element. Omit it, and the renderer appends the child view to the `children` of the element.
 - The view of a child is the deepest view below it. A child view can declare `outlets` of its own, for a nested layout.
 - An outlet that names an element that its view does not hold throws `InvalidViewOutletError`. The actor reports it through `onError`, and it keeps the last valid view.
+- The keys of the outer view carry no prefix, and each key of a child view gets the id of its state and a `/` as a prefix. A key of the outer view such as `"page/root"` equals the key of the element `root` of the child state `page`, and the composition throws `ViewElementKeyCollisionError`. Do not start a key of the outer view with the id of a state and a `/`.
 
 The derived spec is ONE flat spec. The keys of the outer view stay as you wrote them. Each key of a child view gets the id of its state as a prefix: the `root` element of the view of the state `app.search` becomes `app.search/root`. Two views therefore never collide. The [State Machines](state-machines.md#a-layout-and-its-pages-outlets) guide shows a parallel layout with a named slot.
 
@@ -149,7 +153,7 @@ derived state = { ...meta.view.state, context: <the machine context> }
 
 A spec reads the context through the ordinary state grammar of json-render. The same path works in a prop, in a `visible` condition, and in `repeat.statePath`:
 
-```ts
+```ts fragment
 elements: {
 	greeting: { type: "Text", props: { text: { $state: "/context/username" } }, children: [] },
 	tasks: {
@@ -189,7 +193,7 @@ Domain state is the state of the application. Each change of it is an event, so
 
 This login form uses both. The field binds to `/username`, and the submit sends the value to the machine:
 
-```ts
+```ts fragment
 view: typedSpec({
 	root: "form",
 	state: { username: "" },
@@ -215,10 +219,26 @@ Keep high-frequency data in the ephemeral state or in a child actor, and not in
 A component emits a named event of json-render, such as `submit` or `press`. The `on` field of its element maps that name to an ACTION, with params that the renderer resolves from the store. The registry holds the handler of each action, and a handler of a domain action sends a machine event:
 
 ```ts
+import { defineCatalog } from "@xmachines/json-render-core";
+import { defineRegistry, schema, type ComponentFn } from "@xmachines/play-dom";
+import type { ViewActor } from "@xmachines/play-view";
+import { z } from "zod";
+
+declare const actor: ViewActor<unknown, { type: "auth.login"; username: string }>;
+
+const catalog = defineCatalog(schema, {
+	components: { Login: { props: z.object({ username: z.string() }) } },
+	actions: { login: { params: z.object({ username: z.string() }) } },
+});
+
+declare const Login: ComponentFn<typeof catalog, "Login">; // your component
+
 const registryResult = defineRegistry(catalog, {
 	components: { Login },
 	actions: {
-		login: async ({ username }) => actor.send({ type: "auth.login", username }),
+		login: async (params) => {
+			if (params) actor.send({ type: "auth.login", username: params.username });
+		},
 	},
 });
 ```
@@ -227,7 +247,7 @@ The guards of the machine then decide. The renderer changes no state of the mach
 
 The renderer implements four built-in actions over the ephemeral state: `setState`, `pushState`, `removeState` and `validateForm`. They need no handler in the registry. An `on` entry can hold an array of bindings, and the renderer runs them in order. For example, it sends the event, and then it clears the draft:
 
-```ts
+```ts fragment
 on: {
 	press: [
 		{ action: "addTask", params: { title: { $state: "/newTaskTitle" } } },
@@ -255,18 +275,18 @@ A renderer holds one view store for each view, and the `viewKey` decides its lif
 
 With the same `viewKey`, every renderer keeps the DOM nodes, the focus and the ephemeral state. A context change therefore updates a list under a field that has the focus, and the draft in the field stays.
 
-With a new `viewKey`, the ephemeral state starts again from `spec.state`. Two sibling states that each declare a view therefore reset a draft on each transition between them, also when their two specs are equal.
+With a new `viewKey`, the ephemeral state starts again from `spec.state`, and every renderer builds the view again. The state that a component keeps for itself, such as the text of an unbound input, goes with the old view. Two sibling states that each declare a view therefore reset a draft on each transition between them, also when their two specs are equal.
 
 A parent keeps the ephemeral state across a move between its children in one of two ways:
 
 - **Declare the view on the parent**, and no view on the children. The `viewKey` stays the id of the parent.
 - **Declare `outlets` on the parent.** The `viewKey` stays the id of the parent, and each child still shows its own view. A change of the page keeps the store of the layout, so the `collapsed` value of the [layout above](#a-layout-and-its-pages-outlets) does not change.
 
-In a composed view, all the views of one layout share ONE store. The first time that a page shows, the renderer writes each key of its authored `state` that the store does not hold. A page that comes back finds the values that it left. Two pages that declare the same key therefore share one value: give each page its own keys. When two composed views declare the same key, the outer view wins, and a warning names the key.
+In a composed view, all the views of one layout share ONE store. The first time that a page shows, the renderer writes each key of its authored `state` that the store does not hold. A page that comes back finds the values that it left. Two pages that declare the same key therefore share one value: give each page its own keys. When two composed views declare the same key, the outer view wins. play-xstate reads the states of the machine one time, and it writes one warning for each layout that names every key that two of its views declare.
 
 `currentView` also emits only on a real change of the view on the screen. An event that changes no context field and moves to no other view keeps the previous reference, and no subscriber runs. The gate compares the top-level fields of the context. It does not enter a value, so a new object in a field emits again, also when its contents are equal.
 
-In the **controlled mode**, you give the provider a `store`. The provider then ignores `spec.state`, and you own the seed and the lifetime of that store. The renderer still owns `/context`, and it refreshes the subtree in your store on each emission.
+In the **controlled mode**, you give the provider a `store`. The provider then ignores `spec.state`, and you own the seed and the lifetime of that store. The renderer still owns `/context`, and it refreshes the subtree in your store on each emission. The tree lives as long as its store, so a new `viewKey` keeps the tree in the controlled mode, and a new store builds it again.
 
 ---
 
@@ -274,16 +294,16 @@ In the **controlled mode**, you give the provider a `store`. The provider then i
 
 A failure of the DERIVATION stays inside the actor. `currentView` catches it, it keeps the last valid view, and it reports the error to the `onError` hook of the actor in a microtask. The transition continues for every other observer.
 
-A failure of the RENDER stays inside the provider. When a component throws, or the store does not resolve, the provider shows its `fallback` and it calls its own `onError` prop:
+A failure of the RENDER stays inside the provider. When a component throws, when the store does not resolve, or when the root of the view fails, the provider shows its `fallback` and it calls its own `onError` prop:
 
 | Renderer                                                          | The `onError` prop of the provider |
 | ----------------------------------------------------------------- | ---------------------------------- |
-| [`@xmachines/play-react`](../api/@xmachines/play-react/README.md) | `(error, info, reset) => void`     |
+| [`@xmachines/play-react`](../api/@xmachines/play-react/README.md) | `(error, reset, info) => void`     |
 | the four other renderers                                          | `(error, reset) => void`           |
 
 The provider reports one failure one time for one set of inputs — the actor, the view and the store — and not one time for each render. A new emission, or a call of `reset`, makes the next failure report again. Without `onError`, the provider writes the failure to `console.error`, so that no failure is silent. A handler that throws does not break the containment: the provider writes that failure to `console.error` too.
 
-`onRenderError` receives the failure of one catalog component, with the name of the component, and it replaces every handler of `defineRegistry`.
+`onRenderError` receives each failure that json-render reports, with `(error, name, info)`, and it replaces every handler of `defineRegistry`. `info.kind` names the failure: a catalog component that throws (`"element"`), a prop or a `visible` condition of a child (`"props"`, `"visible"`), an action chain or a watch chain (`"action"`, `"watch"`), or the root (`"root"`). A failure of the ROOT — its component, a prop, or its `visible` condition — leaves no view on the screen. json-render gives it to no error boundary of the host, so each of the five providers contains it as a failure of the view: it shows its `fallback`, it calls `onError` one time, and the next view renders again. `onRenderError` also receives it, with the kind `"root"`. A failure below the root reaches `onRenderError` alone, and the rest of the view stays. Without a handler of the host, the provider writes one console line for a failure of the root, and not two.
 
 ---
 
@@ -319,7 +339,7 @@ A provider takes a `ViewActor`: the actor contract and the `Viewable` capability
 
 Each one exports `schema` for `defineCatalog`, and `defineRegistry` for its own components. `PlayUIProvider` takes the `actor`, the `registryResult`, and the optional `store`, `fallback`, `onError` and `onRenderError`. The [Getting Started](getting-started.md#connecting-a-view-renderer) guide shows a complete mount for each framework.
 
-[`@xmachines/play-view`](../api/@xmachines/play-view/README.md) holds the part that the five share: the store lifecycle, the `/context` guard and the report rules. A shared contract suite runs the same scenarios against each renderer, so the five agree on what a viewer sees.
+[`@xmachines/play-view`](../api/@xmachines/play-view/README.md) holds the part that the five share: the view session, which resolves the store of each view outside a render, the `/context` guard and the report guard. A shared contract suite runs the same scenarios against each renderer, so the five agree on what a viewer sees.
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xmachines/docs",
-  "version": "6.1.0",
+  "version": "7.0.0",
   "description": "Documentation for XMachines",
   "keywords": [
     "documentation",
@@ -56,13 +56,13 @@
   },
   "devDependencies": {
     "@testing-library/jest-dom": "^7.0.1",
-    "@types/node": "^26.6.2",
-    "oxfmt": "^0.70.0",
-    "oxlint": "^1.85.0",
+    "@types/node": "^26.6.4",
+    "oxfmt": "^0.71.0",
+    "oxlint": "^1.86.0",
     "typedoc": "^0.28.20",
     "typedoc-plugin-llms-txt": "^0.1.2",
-    "typedoc-plugin-markdown": "^4.13.0",
-    "vitest": "^5.0.1"
+    "typedoc-plugin-markdown": "^4.13.1",
+    "vitest": "^5.0.3"
   },
   "engines": {
     "node": ">=24.0.0"

package/rfc/play.md

@@ -260,7 +260,7 @@ Wraps XState v5 to satisfy the `PlayActor` contract. Provides the primary API fo
 - Support snapshot restore for resumable sessions
 - Provide XState DevTools compatibility
 
-```ts
+```ts fragment
 import type { AnyStateMachine, InputFrom } from "xstate";
 
 interface PlayerConfig<TMachine extends AnyStateMachine> {
@@ -380,7 +380,7 @@ Each view renderer provides a `PlayRenderer` component that passively observes t
 
 **[`@xmachines/play-react`](../api/@xmachines/play-react/README.md) exports (representative):**
 
-```ts
+```ts fragment
 // Batteries-included composite — standard entry point
 // Props: actor, registryResult, store?, fallback?, onError?, onRenderError?,
 //        validationFunctions?, navigate?, functions?
@@ -438,13 +438,18 @@ The original RFC proposed an `@xmachines/play-ui` package for this purpose. The
 Defines the **UI vocabulary** — available components and their prop schemas. No framework code.
 
 ```ts
-import { defineCatalog, z } from "@xmachines/json-render-core";
+import { defineCatalog } from "@xmachines/json-render-core";
+import { schema } from "@xmachines/json-render-react/schema";
+import { z } from "zod";
 
-export const catalog = defineCatalog({
+export const catalog = defineCatalog(schema, {
 	components: {
 		Dashboard: { props: z.object({ title: z.string() }) },
 		Metric: { props: z.object({ value: z.number(), label: z.string() }) },
 	},
+	actions: {
+		submit: { description: "Submit the form" },
+	},
 });
 ```
 
@@ -454,12 +459,17 @@ Defines **Logic**. No framework code. No routing library imports.
 
 ```ts
 import { setup } from "xstate";
-import { definePlayer } from "@xmachines/play-xstate";
+import { compose, definePlayer, PlayerActor } from "@xmachines/play-xstate";
+import { withRouting } from "@xmachines/play-xstate/routing";
+import { withView } from "@xmachines/play-xstate/view";
+import { typedSpec } from "@xmachines/play-view";
 
 export const machine = setup({/* types, guards, actions */}).createMachine({
+	id: "dashboard",
 	initial: "overview",
 	states: {
 		overview: {
+			id: "overview",
 			meta: {
 				route: "/dashboard",
 				view: typedSpec({
@@ -478,20 +488,27 @@ export const machine = setup({/* types, guards, actions */}).createMachine({
 	},
 });
 
-// definePlayer returns a factory function
-export const createDashboard = definePlayer({ machine });
+// definePlayer returns a factory function. The router and the renderer need both capabilities
+export const createDashboard = definePlayer({
+	machine,
+	actor: compose(PlayerActor, withRouting, withView),
+});
 ```
 
 ### 6.3 Application (`App.tsx`)
 
 Binds Logic to a View Renderer and Router Adapter.
 
-```tsx
-import { createDashboard, machine } from "./features/dashboard/player";
-import { catalog } from "./catalog";
+```tsx fragment
+import { createRootRoute, createRouter } from "@tanstack/react-router";
+import { createDashboard, machine } from "./dashboard.player.js";
+import { catalog } from "./catalog.js";
 import { PlayUIProvider, PlayRenderer, defineRegistry } from "@xmachines/play-react";
-import { TanStackReactRouterBridge } from "@xmachines/play-tanstack-react-router";
-import { extractMachineRoutes, createRouteMap } from "@xmachines/play-router/xstate";
+import {
+	createRouteMapFromTree,
+	TanStackReactRouterBridge,
+} from "@xmachines/play-tanstack-react-router";
+import { extractMachineRoutes } from "@xmachines/play-router/xstate";
 
 // 1. Create the actor
 const actor = createDashboard();
@@ -516,7 +533,8 @@ const routeTree = extractMachineRoutes(machine);
 const routeMap = createRouteMapFromTree(routeTree);
 
 // 4. Connect router adapter (router, actor, routeMap)
-const bridge = new TanStackReactRouterBridge(tanstackRouter, actor, routeMap);
+const router = createRouter({ routeTree: createRootRoute() });
+const bridge = new TanStackReactRouterBridge(router, actor, routeMap);
 bridge.connect();
 
 // 5. Render — PlayUIProvider is the batteries-included composite; PlayRenderer is the zero-prop leaf

package/api/@xmachines/play-view/index/functions/createFailureLatch.md

@@ -1,20 +0,0 @@
-[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / createFailureLatch
-
-# Function: createFailureLatch()
-
-```ts
-function createFailureLatch(): FailureLatch;
-```
-
-Defined in: [packages/play-view/src/failure-latch.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L202)
-
-Makes a [FailureLatch](../interfaces/FailureLatch.md).
-
-The latch holds the three inputs BESIDE the flag. Clearing on each emission would be
-enough for a provider that can hook every emission, and the identity check covers the
-one that cannot: a render that runs again with nothing changed reports nothing, whether
-or not the provider noticed that it ran.
-
-## Returns
-
-[`FailureLatch`](../interfaces/FailureLatch.md)

package/api/@xmachines/play-view/index/functions/sameViewInputs.md

@@ -1,25 +0,0 @@
-[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / sameViewInputs
-
-# Function: sameViewInputs()
-
-```ts
-function sameViewInputs(a, b): boolean;
-```
-
-Defined in: [packages/play-view/src/failure-latch.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L45)
-
-Answers whether two sets of inputs are the SAME attempt.
-
-Identity, and not a deep compare: a provider holds the references that it rendered, and
-a new spec object is a new attempt even when it holds equal fields.
-
-## Parameters
-
-| Parameter | Type                                        |
-| --------- | ------------------------------------------- |
-| `a`       | [`ViewInputs`](../interfaces/ViewInputs.md) |
-| `b`       | [`ViewInputs`](../interfaces/ViewInputs.md) |
-
-## Returns
-
-`boolean`