@xmachines/docs 3.0.0 → 5.0.0

package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md

@@ -10,7 +10,7 @@ type PlayRouterProviderBaseProps<TRouter, TActor> = PlayRouterProviderBaseProps<
 >;
 ```
 
-Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L34)
+Defined in: [play-solid-router/src/create-play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L34)
 
 The props of a Solid `PlayRouterProvider`.
 
@@ -20,7 +20,7 @@ bound to `JSX.Element`. See `PlayRouterProviderBaseProps` of
 
 ## Type Parameters
 
-| Type Parameter                                               | Default type                              |
-| ------------------------------------------------------------ | ----------------------------------------- |
-| `TRouter`                                                    | -                                         |
-| `TActor` _extends_ [`PlayActor`](../interfaces/PlayActor.md) | [`PlayActor`](../interfaces/PlayActor.md) |
+| Type Parameter                                                       | Default type                                      |
+| -------------------------------------------------------------------- | ------------------------------------------------- |
+| `TRouter`                                                            | -                                                 |
+| `TActor` _extends_ [`RoutableActor`](../interfaces/RoutableActor.md) | [`RoutableActor`](../interfaces/RoutableActor.md) |

package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md

@@ -6,7 +6,7 @@
 type SolidRouterHooks = object;
 ```
 
-Defined in: [packages/play-solid-router/src/play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-solid-router/src/play-router-provider.tsx#L37)
+Defined in: [play-solid-router/src/play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-solid-router/src/play-router-provider.tsx#L34)
 
 The three results of the Solid Router hooks that `PlayRouterProvider` and
 `SolidRouterBridge` need. Give them directly from the hook calls of your component:
@@ -31,7 +31,7 @@ const params = useParams(); // → SolidRouterHooks.params
 location: Location;
 ```
 
-Defined in: [packages/play-solid-router/src/play-router-provider.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-solid-router/src/play-router-provider.tsx#L39)
+Defined in: [play-solid-router/src/play-router-provider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-solid-router/src/play-router-provider.tsx#L36)
 
 ---
 
@@ -41,7 +41,7 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:39](https:/
 navigate: Navigator;
 ```
 
-Defined in: [packages/play-solid-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-solid-router/src/play-router-provider.tsx#L38)
+Defined in: [play-solid-router/src/play-router-provider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-solid-router/src/play-router-provider.tsx#L35)
 
 ---
 
@@ -51,4 +51,4 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:38](https:/
 params: Params;
 ```
 
-Defined in: [packages/play-solid-router/src/play-router-provider.tsx:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-solid-router/src/play-router-provider.tsx#L40)
+Defined in: [play-solid-router/src/play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-solid-router/src/play-router-provider.tsx#L37)

package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md

@@ -6,7 +6,7 @@
 const PlayRouterProvider: <TActor>(props) => any;
 ```
 
-Defined in: [packages/play-solid-router/src/play-router-provider.tsx:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-solid-router/src/play-router-provider.tsx#L99)
+Defined in: [play-solid-router/src/play-router-provider.tsx:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-solid-router/src/play-router-provider.tsx#L96)
 
 Connects a `PlayerActor` to Solid Router. It keeps the actor state and the browser
 URL in step, in both directions.
@@ -38,9 +38,9 @@ function AppShell() {
 
 ## Type Parameters
 
-| Type Parameter                                               |
-| ------------------------------------------------------------ |
-| `TActor` _extends_ [`PlayActor`](../interfaces/PlayActor.md) |
+| Type Parameter                                                       |
+| -------------------------------------------------------------------- |
+| `TActor` _extends_ [`RoutableActor`](../interfaces/RoutableActor.md) |
 
 ## Parameters
 

package/api/@xmachines/play-svelte/README.md

@@ -2,9 +2,9 @@
 
 # @xmachines/play-svelte
 
-Svelte 5 renderer for the XMachines Play architecture. It connects an actor to a catalog-driven `@xmachines/json-render-svelte` UI, with Svelte 5 runes and TC39 Signals.
+Svelte 5 renderer for the XMachines Play architecture. It connects an actor to a catalog-driven `@xmachines/json-render-svelte` UI, with Svelte 5 runes and atoms.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-3.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-svelte)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-5.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-svelte)
 
 ## Installation
 
@@ -15,10 +15,14 @@ pnpm add @xmachines/play-svelte
 **Peer dependencies.** Install them separately:
 
 ```bash
-pnpm add svelte@^5.0.0 xstate@^5.31.0 @xstate/store@^3.17.0 \
+pnpm add svelte@^5.0.0 @xmachines/play @xmachines/play-atom @xstate/store@^4.2.3 \
   @xmachines/json-render-core@^0.20.0-xm.4 @xmachines/json-render-svelte@^0.20.0-xm.4 @xmachines/json-render-xstate@^0.20.0-xm.4
 ```
 
+`@xstate/store` is the peer of [`@xmachines/play-atom`](../play-atom/README.md), and not of this
+package: this package reads the atom through [`@xmachines/play-atom`](../play-atom/README.md) and
+imports the engine in no source file. Install ONE copy of it.
+
 ## Usage
 
 ### Basic setup
@@ -93,7 +97,7 @@ actor.send({ type: "some.event" });
 | Component          | Description                                                                                                                   |
 | ------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
 | `<PlayUIProvider>` | Composite provider. It wraps `ActorProvider` and `JsonUIProvider`. Use it as the standard entry point for an actor-driven UI. |
-| `<ActorProvider>`  | Primitive provider — owns actor lifecycle, signal subscription, per-view `StateStore`, and `onRenderError` injection.         |
+| `<ActorProvider>`  | Primitive provider — owns actor lifecycle, atom subscription, per-view `StateStore`, and `onRenderError` injection.           |
 | `<PlayRenderer>`   | Zero-prop leaf component — reads `getPlayViewContext()` and renders `<Renderer>` from `@xmachines/json-render-svelte`.        |
 
 ### Functions
@@ -105,6 +109,13 @@ actor.send({ type: "some.event" });
 | `getPlayViewContext()`             | Returns the `ViewContextValue` (spec, registry, handlers, store) from the nearest `ActorProvider` ancestor. Every field is a GETTER: read `view.spec` where you use it, and destructure it not.                         |
 | `setActorContext(actor)`           | Sets the actor context. `ActorProvider` uses it internally.                                                                                                                                                             |
 
+> **The names of this package are Svelte names.** [`@xmachines/play-react`](../play-react/README.md),
+> [`@xmachines/play-vue`](../play-vue/README.md) and [`@xmachines/play-solid`](../play-solid/README.md) export `useActor` and `usePlayView`,
+> because `use*` is the convention of a React hook and of a Vue composable. Svelte has
+> `getContext` and `setContext`, and `@xmachines/json-render-svelte` names its own readers
+> `get*Context`. This package re-exports that library, so one import surface holds one
+> convention. The difference is deliberate, and it is no drift.
+
 ### Types
 
 | Type                       | Description                                                                                                                           |
@@ -112,7 +123,7 @@ actor.send({ type: "some.event" });
 | `ActorProviderProps`       | Props for `<ActorProvider>`: `actor`, `registryResult`, optional `store`, `fallback` snippet, `onError`, `onRenderError`, `children`. |
 | `PlayUIProviderProps`      | Extends `ActorProviderProps` with optional `validationFunctions`, `navigate`, and `functions`.                                        |
 | `ViewContextValue`         | The view context shape that `ActorProvider` provides and `PlayRenderer` reads.                                                        |
-| `AnyPlayActor`             | `AbstractActor<AnyActorLogic> & Viewable` — the actor shape that `ActorProvider` and `getActorContext` accept.                        |
+| `AnyPlayActor`             | `ViewActor` — the actor shape that `ActorProvider` and `getActorContext` accept.                                                      |
 | `DefineRegistryOptions<C>` | Options for `defineRegistry`: `components`, catalog-typed `actions`, and `onRenderError`.                                             |
 | `ActionFn<C, K>`           | The handler type for one action. The params come from the catalog.                                                                    |
 | `Actions<C>`               | Map of catalog-typed action handlers.                                                                                                 |
@@ -144,29 +155,6 @@ import type {
 } from "@xmachines/play-svelte";
 ```
 
-## Testing
-
-Run the test suite for this package:
-
-```bash
-pnpm --filter @xmachines/play-svelte test
-```
-
-Or from within the package directory:
-
-```bash
-pnpm test
-```
-
-The tests run with [Vitest](https://vitest.dev/) in a `jsdom` environment, together with `@testing-library/svelte`. The browser tests are in `test/browser/`. They use a separate config with Playwright:
-
-```bash
-# From the package directory
-pnpm exec vitest --config vitest.browser.config.ts
-```
-
-**Coverage thresholds:** 80% for lines, functions, branches, and statements. The v8 provider enforces them.
-
 ## License
 
 MIT — see [LICENSE](./LICENSE).
@@ -176,7 +164,7 @@ MIT — see [LICENSE](./LICENSE).
 The package splits the provider from the renderer, in the same way as
 @xmachines/json-render-svelte:
 
-- ActorProvider: the low-level provider. It owns the actor lifecycle, the signal
+- ActorProvider: the low-level provider. It owns the actor lifecycle, the atom
   subscription, the StateStore of each view, and the injection of onRenderError
 - PlayUIProvider: the composite provider (ActorProvider and JsonUIProvider)
 - PlayRenderer: the leaf without props. It reads getPlayViewContext() and renders
@@ -209,6 +197,7 @@ consumer therefore imports everything from @xmachines/play-svelte, and not from
 ## Variables
 
 - [PlayRenderer](variables/PlayRenderer.md)
+- [schema](variables/schema.md)
 
 ## Functions
 

package/api/@xmachines/play-svelte/functions/defineRegistry.md

@@ -6,7 +6,7 @@
 function defineRegistry<C>(catalog, options): DefineRegistryResult;
 ```
 
-Defined in: [packages/play-svelte/src/define-registry.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-svelte/src/define-registry.ts#L156)
+Defined in: [packages/play-svelte/src/define-registry.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-svelte/src/define-registry.ts#L156)
 
 Creates a component registry, and gives each action handler its catalog-typed `params`.
 

package/api/@xmachines/play-svelte/functions/getActorContext.md

@@ -6,7 +6,7 @@
 function getActorContext(): AnyPlayActor;
 ```
 
-Defined in: [packages/play-svelte/src/actor-context.svelte.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-svelte/src/actor-context.svelte.ts#L42)
+Defined in: [packages/play-svelte/src/actor-context.svelte.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-svelte/src/actor-context.svelte.ts#L45)
 
 Returns the actor of the nearest ActorProvider ancestor.
 

package/api/@xmachines/play-svelte/functions/getPlayViewContext.md

@@ -6,7 +6,7 @@
 function getPlayViewContext(): ViewContextValue;
 ```
 
-Defined in: [packages/play-svelte/src/actor-context.svelte.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-svelte/src/actor-context.svelte.ts#L69)
+Defined in: [packages/play-svelte/src/actor-context.svelte.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-svelte/src/actor-context.svelte.ts#L72)
 
 Returns the current view context of the nearest ActorProvider ancestor.
 

package/api/@xmachines/play-svelte/functions/setActorContext.md

@@ -6,7 +6,7 @@
 function setActorContext(actor): void;
 ```
 
-Defined in: [packages/play-svelte/src/actor-context.svelte.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-svelte/src/actor-context.svelte.ts#L31)
+Defined in: [packages/play-svelte/src/actor-context.svelte.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-svelte/src/actor-context.svelte.ts#L34)
 
 ## Parameters
 

package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md

@@ -2,7 +2,7 @@
 
 # Interface: ActorProviderProps
 
-Defined in: [packages/play-svelte/src/actor-context.svelte.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-svelte/src/actor-context.svelte.ts#L78)
+Defined in: [packages/play-svelte/src/actor-context.svelte.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-svelte/src/actor-context.svelte.ts#L81)
 
 The framework-agnostic base props. Every `ActorProvider` implementation shares
 them: React, Vue, Solid, and Svelte. `TRegistry` holds the
@@ -16,7 +16,7 @@ Each framework package extends this interface with its `fallback` field, its
 ## Example
 
 ```ts
-import type { BaseActorProviderProps } from "@xmachines/play-actor";
+import type { BaseActorProviderProps, ViewActor } from "@xmachines/play-view";
 import type { DefineRegistryResult } from "@xmachines/json-render-react";
 
 interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult> {
@@ -27,7 +27,7 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
 
 ## Extends
 
-- [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md)\<`DefineRegistryResult`\>
+- [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md)\<`DefineRegistryResult`\>
 
 ## Extended by
 
@@ -35,12 +35,12 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
 
 ## Properties
 
-| Property                                              | Type                                                                                                                                                                                                                                                             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Inherited from                                                                                                                                                                      | Defined in                                                                                                                                                             |
-| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                   | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | The actor instance with the currentView signal. It requires the Viewable capability.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor)                   | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L163)               |
-| <a id="property-children"></a> `children`             | `Snippet`                                                                                                                                                                                                                                                        | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | -                                                                                                                                                                                   | [packages/play-svelte/src/actor-context.svelte.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-svelte/src/actor-context.svelte.ts#L120) |
-| <a id="property-fallback"></a> `fallback?`            | `Snippet`\<\[\]\>                                                                                                                                                                                                                                                | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | -                                                                                                                                                                                   | [packages/play-svelte/src/actor-context.svelte.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-svelte/src/actor-context.svelte.ts#L79)   |
-| <a id="property-onerror"></a> `onError?`              | (`error`, `reset`) => `void`                                                                                                                                                                                                                                     | The optional callback. The provider calls it when the outer `<svelte:boundary>` catches an error, and when the resolution of the store fails. The second parameter is the `reset` callback, for a retry that the host starts. The reset resolves the view that the actor holds at the moment of the call, and not the view that failed: the host can keep the callback on a "Retry" button while the actor moves on. A reset that the host calls from inside this handler starts no second retry, because no input changed between the two attempts. **ONE reset serves a failure of either kind, and it retries the failure on the screen NOW.** A host can keep the callback — a "Retry" button of a toast outlives the failure that opened it — and the press retries whatever failure stands at that moment, and not the one that handed the callback out. The four other renderers hand the host one reset the same way, and the five hold ONE contract. **Each reset does nothing after the provider is destroyed.** The host can hold the callback — a "Retry" button of a toast outlives the route that opened it — and a reset of a provider that is gone would report to the host a second time, from a component that renders nothing. The callback stays safe to hold, and safe to call. While the error is active, the provider renders the `fallback` instead of its children. The provider clears the error on the next view emission (when `currentView` changes), so a view transition retries the render. Element-level catalog component throws are caught upstream by the per-element boundary of @json-render, and reported through `onRenderError`. This boundary is the outer net for everything else. **A handler that THROWS reaches no caller.** The provider contains that throw, and it writes the throw to `console.error`. Svelte catches such a throw itself, and it leaves its own `calling_on_error` flag raised: every later reset of the host then raises `svelte_boundary_reset_onerror`, so the "Retry" button throws and the boundary can never clear. Report a failure from this handler. To ESCALATE one, raise it from a task of your own — `queueMicrotask(() => { throw error; })` — which reaches the global handler of the page and leaves the containment whole. The five renderers hold this one rule. | -                                                                                                                                                                                   | [packages/play-svelte/src/actor-context.svelte.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-svelte/src/actor-context.svelte.ts#L119) |
-| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                                                                                    | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror)   | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L177)               |
-| <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult`                                                                                                                                                                                                                                           | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L165)               |
-| <a id="property-store"></a> `store?`                  | `StateStore`                                                                                                                                                                                                                                                     | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store)                   | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L172)               |
+| Property                                              | Type                                                           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Inherited from                                                                                                                                                                                | Defined in                                                                                                                                                             |
+| ----------------------------------------------------- | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`                   | [`ViewActor`](../../play-view/index/type-aliases/ViewActor.md) | The actor instance with the currentView atom. It requires the Viewable capability.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`actor`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-actor)                   | [packages/play-view/src/view-types.ts:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-types.ts#L169)                         |
+| <a id="property-children"></a> `children`             | `Snippet`                                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | -                                                                                                                                                                                             | [packages/play-svelte/src/actor-context.svelte.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-svelte/src/actor-context.svelte.ts#L123) |
+| <a id="property-fallback"></a> `fallback?`            | `Snippet`\<\[\]\>                                              | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | -                                                                                                                                                                                             | [packages/play-svelte/src/actor-context.svelte.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-svelte/src/actor-context.svelte.ts#L82)   |
+| <a id="property-onerror"></a> `onError?`              | (`error`, `reset`) => `void`                                   | The optional callback. The provider calls it when the outer `<svelte:boundary>` catches an error, and when the resolution of the store fails. The second parameter is the `reset` callback, for a retry that the host starts. The reset resolves the view that the actor holds at the moment of the call, and not the view that failed: the host can keep the callback on a "Retry" button while the actor moves on. A reset that the host calls from inside this handler starts no second retry, because no input changed between the two attempts. **ONE reset serves a failure of either kind, and it retries the failure on the screen NOW.** A host can keep the callback — a "Retry" button of a toast outlives the failure that opened it — and the press retries whatever failure stands at that moment, and not the one that handed the callback out. The four other renderers hand the host one reset the same way, and the five hold ONE contract. **Each reset does nothing after the provider is destroyed.** The host can hold the callback — a "Retry" button of a toast outlives the route that opened it — and a reset of a provider that is gone would report to the host a second time, from a component that renders nothing. The callback stays safe to hold, and safe to call. While the error is active, the provider renders the `fallback` instead of its children. The provider clears the error on the next view emission (when `currentView` changes), so a view transition retries the render. Element-level catalog component throws are caught upstream by the per-element boundary of @json-render, and reported through `onRenderError`. This boundary is the outer net for everything else. **A handler that THROWS reaches no caller.** The provider contains that throw, and it writes the throw to `console.error`. Svelte catches such a throw itself, and it leaves its own `calling_on_error` flag raised: every later reset of the host then raises `svelte_boundary_reset_onerror`, so the "Retry" button throws and the boundary can never clear. Report a failure from this handler. To ESCALATE one, raise it from a task of your own — `queueMicrotask(() => { throw error; })` — which reaches the global handler of the page and leaves the containment whole. The five renderers hold this one rule. | -                                                                                                                                                                                             | [packages/play-svelte/src/actor-context.svelte.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-svelte/src/actor-context.svelte.ts#L122) |
+| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)  | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-onrendererror)   | [packages/play-view/src/view-types.ts:183](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-types.ts#L183)                         |
+| <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult`                                         | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-view/src/view-types.ts:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-types.ts#L171)                         |
+| <a id="property-store"></a> `store?`                  | `StateStore`                                                   | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`store`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-store)                   | [packages/play-view/src/view-types.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-view/src/view-types.ts#L178)                         |

package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md

@@ -2,7 +2,7 @@
 
 # Interface: DefineRegistryOptions\<C\>
 
-Defined in: [packages/play-svelte/src/define-registry.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-svelte/src/define-registry.ts#L94)
+Defined in: [packages/play-svelte/src/define-registry.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-svelte/src/define-registry.ts#L94)
 
 The options of `defineRegistry`.
 
@@ -19,6 +19,6 @@ The shape is the same as the shape above it, but the untyped
 
 | Property                                             | Type                                                          | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Defined in                                                                                                                                                   |
 | ---------------------------------------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-actions"></a> `actions?`             | [`Actions`](../type-aliases/Actions.md)\<`C`\>                | The catalog-typed map of the action handlers. Each handler receives `params` with the exact schema of the catalog action, or `undefined` when the caller gives no params. It also receives the `setState` argument and the `state` argument of the package above. Test for `undefined` before you read a param: **Example** `actions: { login: async (params) => { if (!params) return; actor.send({ type: "auth.login", username: params.username }); }, logout: async () => actor.send({ type: "auth.logout" }), }`                                                                                                                                                                                                                                                                                                                                                                                                                                                         | [packages/play-svelte/src/define-registry.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-svelte/src/define-registry.ts#L118) |
-| <a id="property-components"></a> `components?`       | `Components`\<`C`\>                                           | The Svelte component implementations, with the catalog component name as the key.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | [packages/play-svelte/src/define-registry.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-svelte/src/define-registry.ts#L98)   |
-| <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The callback that the renderer calls when a catalog component throws during a render. The inner `<svelte:boundary>` of `@xmachines/json-render-svelte` catches the error, and that boundary wraps each element. With this callback, the default `console.error(...)` fallback does not run: the renderer removes the component from the DOM, and your callback receives the error and the name of the element type. You can then report the error, or you can recover from it. **Example** `const { registry, handlers } = defineRegistry(authCatalog, { components: { Login, Dashboard }, actions: { ... }, onRenderError(error, elementType) { console.warn(`Component <${elementType}> crashed:`, error); reportToSentry(error, { componentType: elementType }); }, });` **Param** **error** The value that the component threw. It is not always an `Error` instance. **Param** **elementType** The name of the catalog component that failed, for example `"Dashboard"`. | [packages/play-svelte/src/define-registry.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-svelte/src/define-registry.ts#L143) |
+| <a id="property-actions"></a> `actions?`             | [`Actions`](../type-aliases/Actions.md)\<`C`\>                | The catalog-typed map of the action handlers. Each handler receives `params` with the exact schema of the catalog action, or `undefined` when the caller gives no params. It also receives the `setState` argument and the `state` argument of the package above. Test for `undefined` before you read a param: **Example** `actions: { login: async (params) => { if (!params) return; actor.send({ type: "auth.login", username: params.username }); }, logout: async () => actor.send({ type: "auth.logout" }), }`                                                                                                                                                                                                                                                                                                                                                                                                                                                         | [packages/play-svelte/src/define-registry.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-svelte/src/define-registry.ts#L118) |
+| <a id="property-components"></a> `components?`       | `Components`\<`C`\>                                           | The Svelte component implementations, with the catalog component name as the key.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | [packages/play-svelte/src/define-registry.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-svelte/src/define-registry.ts#L98)   |
+| <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The callback that the renderer calls when a catalog component throws during a render. The inner `<svelte:boundary>` of `@xmachines/json-render-svelte` catches the error, and that boundary wraps each element. With this callback, the default `console.error(...)` fallback does not run: the renderer removes the component from the DOM, and your callback receives the error and the name of the element type. You can then report the error, or you can recover from it. **Example** `const { registry, handlers } = defineRegistry(authCatalog, { components: { Login, Dashboard }, actions: { ... }, onRenderError(error, elementType) { console.warn(`Component <${elementType}> crashed:`, error); reportToSentry(error, { componentType: elementType }); }, });` **Param** **error** The value that the component threw. It is not always an `Error` instance. **Param** **elementType** The name of the catalog component that failed, for example `"Dashboard"`. | [packages/play-svelte/src/define-registry.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-svelte/src/define-registry.ts#L143) |