@xmachines/docs 2.0.0 → 2.1.0

package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md

@@ -2,21 +2,23 @@
 
 # Interface: RouterBridge
 
-Defined in: [packages/play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-router/src/types.ts#L341)
+Defined in: [packages/play-router/src/types.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L358)
 
-RouterBridge interface for runtime infrastructure adapters
+The RouterBridge interface of a runtime infrastructure adapter
 
-Defines the lifecycle connection between Infrastructure (e.g., a framework router) and
-the Actor. Infrastructure "bridges" to the Actor by observing its signals and
-managing its own lifecycle accordingly.
+The interface defines the connection of the lifecycle between the infrastructure,
+for example a framework router, and the Actor. The infrastructure builds a "bridge"
+to the Actor: it observes the signals of the Actor, and it manages its own
+lifecycle accordingly.
 
-**Architectural Context:** Implements **Passive Infrastructure (INV-04)** by establishing
-a unidirectional observation pattern. Infrastructure connects to observe Actor signals
-(currentRoute, currentView, state) and reflects changes without making state decisions.
+**Architectural context:** the interface implements **Passive Infrastructure
+(INV-04)**, because it gives an observation in one direction. The infrastructure
+connects to observe the signals of the Actor (currentRoute, currentView, and
+state), and it reflects each change. It makes no decision about the state.
 
 ## Example
 
-Framework router bridge implementation
+The implementation of a framework router bridge
 
 ```typescript
 import type { RouterBridge } from "@xmachines/play-router";
@@ -26,7 +28,7 @@ class MyRouterBridge implements RouterBridge {
 	private watcher: Signal.Watcher | null = null;
 
 	async connect(): Promise<void> {
-		// Start observing actor.currentRoute signal
+		// Start the observation of the actor.currentRoute signal
 		this.watcher = new Signal.subtle.Watcher(() => {
 			const route = actor.currentRoute.get();
 			if (route) router.navigate(route);
@@ -35,7 +37,7 @@ class MyRouterBridge implements RouterBridge {
 	}
 
 	async disconnect(): Promise<void> {
-		// Stop observing, cleanup watchers
+		// Stop the observation, and clean the watchers up
 		this.watcher?.unwatch(actor.currentRoute);
 		this.watcher = null;
 	}
@@ -44,7 +46,7 @@ class MyRouterBridge implements RouterBridge {
 
 ## See
 
-[Play RFC](../../../../rfc/play.md) - Invariant INV-04
+[Play RFC](../../../../rfc/play.md) - invariant INV-04
 
 ## Methods
 
@@ -54,25 +56,26 @@ class MyRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
 
-Defined in: [packages/play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-router/src/types.ts#L357)
+Defined in: [packages/play-router/src/types.ts:375](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L375)
 
-Connect the router bridge to the Actor
+Connects the router bridge to the Actor
 
-Called when Infrastructure should begin observing Actor signals and
-synchronizing its state (e.g., browser URL) with Actor state.
+The infrastructure calls it when it must start the observation of the Actor
+signals, and when it must bring its own state, for example the browser URL, in line
+with the Actor state.
 
 #### Returns
 
 `void` \| `Promise`\<`void`\>
 
-Promise that resolves when connection is established, or void for synchronous connection
+The promise that resolves after the connection, or void for a synchronous connection
 
 #### Example
 
 ```typescript
 const bridge: RouterBridge = createBridge(actor, router);
 await bridge.connect();
-// Bridge now observing actor.currentRoute signal
+// The bridge observes the actor.currentRoute signal now
 ```
 
 ---
@@ -83,22 +86,22 @@ await bridge.connect();
 disconnect(): void | Promise<void>;
 ```
 
-Defined in: [packages/play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-router/src/types.ts#L373)
+Defined in: [packages/play-router/src/types.ts:391](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L391)
 
-Disconnect the router bridge from the Actor
+Disconnects the router bridge from the Actor
 
-Called when Infrastructure should stop observing and clean up resources
-(e.g., signal watchers, event listeners).
+The infrastructure calls it when it must stop the observation and free its
+resources, for example a signal watcher and an event listener.
 
 #### Returns
 
 `void` \| `Promise`\<`void`\>
 
-Promise that resolves when disconnection is complete, or void for synchronous disconnection
+The promise that resolves after the disconnection, or void for a synchronous disconnection
 
 #### Example
 
 ```typescript
 await bridge.disconnect();
-// Bridge stopped observing, resources cleaned up
+// The bridge stopped its observation, and it freed its resources
 ```

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

@@ -6,14 +6,14 @@
 type PlayRouterBridgeConstructor<TRouter> = (router, actor, routeMap) => RouterBridge;
 ```
 
-Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L25)
+Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L24)
 
-Constructor shape a bridge class must satisfy to be used with
+The constructor shape that a bridge class must satisfy for
 `createPlayRouterProvider`: `(router, actor, routeMap) → RouterBridge`.
 
-Bridges with a different constructor shape (e.g. `SolidRouterBridge`, which
-takes the hook results as separate arguments) are adapted with a thin
-subclass that repackages the `router` prop.
+A bridge with another constructor shape, for example `SolidRouterBridge`, which
+takes each hook result as a separate argument, receives a thin subclass. That
+subclass packs the `router` prop again.
 
 ## Type Parameters
 

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

@@ -6,8 +6,8 @@
 type RoutableActor = PlayActor;
 ```
 
-Defined in: [packages/play-solid-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-solid-router/src/play-router-provider.tsx#L19)
+Defined in: [packages/play-solid-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-solid-router/src/play-router-provider.tsx#L19)
 
 ## Deprecated
 
-Use `PlayActor` from `@xmachines/play-router`. Will be removed in the next major version.
+Use `PlayActor` from `@xmachines/play-router`. The next major version removes this alias.

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

@@ -6,10 +6,10 @@
 type SolidRouterHooks = object;
 ```
 
-Defined in: [packages/play-solid-router/src/play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-solid-router/src/play-router-provider.tsx#L37)
+Defined in: [packages/play-solid-router/src/play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-solid-router/src/play-router-provider.tsx#L37)
 
-The three Solid Router hook results that `PlayRouterProvider` and `SolidRouterBridge`
-require. Pass these directly from your component's hook calls:
+The three results of the Solid Router hooks that `PlayRouterProvider` and
+`SolidRouterBridge` need. Give them directly from the hook calls of your component:
 
 ```tsx
 const navigate = useNavigate(); // → SolidRouterHooks.navigate
@@ -17,11 +17,11 @@ const location = useLocation(); // → SolidRouterHooks.location
 const params = useParams(); // → SolidRouterHooks.params
 ```
 
-- `navigate` — used to push URL changes when the actor's `currentRoute` changes.
-- `location` — `pathname` and `search` are read at `connect()` time for deep-link sync.
-  Subsequent pathname changes drive router→actor sync via `createEffect`.
-- `params` — Solid's pre-parsed path parameters for the current route segment. Used
-  directly in `extractParams()` to avoid re-parsing with URLPattern.
+- `navigate` — the bridge pushes each URL change with it, when the `currentRoute` of the actor changes.
+- `location` — the bridge reads `pathname` and `search` at the moment of `connect()`, for a deep link.
+  Each later change of the pathname then goes to the actor, through `createEffect`.
+- `params` — the path parameters of the current route segment, which Solid parsed already. The bridge
+  uses them directly in `extractParams()`, and it parses them not again with URLPattern.
 
 ## Properties
 
@@ -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/v2.0.0/packages/play-solid-router/src/play-router-provider.tsx#L39)
+Defined in: [packages/play-solid-router/src/play-router-provider.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-solid-router/src/play-router-provider.tsx#L39)
 
 ---
 
@@ -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/v2.0.0/packages/play-solid-router/src/play-router-provider.tsx#L38)
+Defined in: [packages/play-solid-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-solid-router/src/play-router-provider.tsx#L38)
 
 ---
 
@@ -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/v2.0.0/packages/play-solid-router/src/play-router-provider.tsx#L40)
+Defined in: [packages/play-solid-router/src/play-router-provider.tsx:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-solid-router/src/play-router-provider.tsx#L40)

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

@@ -6,17 +6,18 @@
 const PlayRouterProvider: <TActor>(props) => any;
 ```
 
-Defined in: [packages/play-solid-router/src/play-router-provider.tsx:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-solid-router/src/play-router-provider.tsx#L92)
+Defined in: [packages/play-solid-router/src/play-router-provider.tsx:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-solid-router/src/play-router-provider.tsx#L94)
 
-Connects a `PlayerActor` to Solid Router, keeping actor state and browser URL
-in sync bidirectionally.
+Connects a `PlayerActor` to Solid Router. It keeps the actor state and the browser
+URL in step, in both directions.
 
-The bridge is created synchronously at component evaluation time (Solid's
-execution model) and torn down via `onCleanup` when the component is disposed.
-Unlike React, prop stability is not a concern — Solid's `props` accessor is
-already reactive and the bridge is created once per component instance.
+The component creates the bridge synchronously, during its own evaluation, because
+this is the execution model of Solid. It disconnects the bridge in `onCleanup`,
+when Solid disposes of the component. React is different: the stability of a prop
+is no concern here, because the `props` accessor of Solid is reactive already, and
+the component creates the bridge one time for each of its instances.
 
-The `router` prop must be obtained from Solid Router hooks in the parent component:
+Take the `router` prop from the Solid Router hooks in the parent component:
 
 ```tsx
 function AppShell() {

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

@@ -2,11 +2,9 @@
 
 # @xmachines/play-svelte
 
-Svelte 5 renderer for the XMachines Play architecture — connects an actor to a `@xmachines/json-render-svelte` catalog-driven UI using 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 TC39 Signals.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-2.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-svelte)
-
-Part of the [xmachines-js monorepo](../../README.md).
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-2.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-svelte)
 
 ## Installation
 
@@ -14,7 +12,7 @@ Part of the [xmachines-js monorepo](../../README.md).
 pnpm add @xmachines/play-svelte
 ```
 
-**Peer dependencies** (must be installed separately):
+**Peer dependencies.** Install them separately:
 
 ```bash
 pnpm add svelte@^5.0.0 xstate@^5.31.0 @xstate/store@^3.17.0 \
@@ -25,7 +23,7 @@ pnpm add svelte@^5.0.0 xstate@^5.31.0 @xstate/store@^3.17.0 \
 
 ### Basic setup
 
-Define a catalog and registry once, then pass both to `PlayUIProvider` with your actor. `PlayRenderer` renders the current actor view automatically:
+Define the catalog and the registry one time. Then give both to `PlayUIProvider`, together with your actor. `PlayRenderer` then renders the current view of the actor:
 
 ```svelte
 <!-- App.svelte -->
@@ -55,15 +53,23 @@ Define a catalog and registry once, then pass both to `PlayUIProvider` with your
 
 ### Lower-level: ActorProvider
 
-Use `ActorProvider` directly when you need fine-grained control over rendering — for example, to wrap with a custom layout or inject the `@xmachines/json-render-svelte` providers individually:
+Use `ActorProvider` directly when you need more control over the rendering. For example, use it to add a custom layout, or to add each `@xmachines/json-render-svelte` provider one by one:
 
 ```svelte
 <script lang="ts">
   import { ActorProvider } from "@xmachines/play-svelte";
 
-  let { actor, registryResult } = $props();
+  let { actor, registryResult, children } = $props();
+
+  function handleError(error: unknown, reset: () => void) {
+    console.error(error);
+  }
 </script>
 
+{#snippet loadingSnippet()}
+  <div>Loading…</div>
+{/snippet}
+
 <ActorProvider {actor} {registryResult} fallback={loadingSnippet} onError={handleError}>
   <!-- children rendered inside StateProvider tree -->
   {@render children()}
@@ -84,20 +90,20 @@ actor.send({ type: "some.event" });
 
 ### Components
 
-| Component          | Description                                                                                                            |
-| ------------------ | ---------------------------------------------------------------------------------------------------------------------- |
-| `<PlayUIProvider>` | Batteries-included composite — wraps `ActorProvider` + `JsonUIProvider`. Standard entry point for actor-driven UI.     |
-| `<ActorProvider>`  | Primitive provider — owns actor lifecycle, signal subscription, per-view `StateStore`, and `onRenderError` injection.  |
-| `<PlayRenderer>`   | Zero-prop leaf component — reads `getPlayViewContext()` and renders `<Renderer>` from `@xmachines/json-render-svelte`. |
+| 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.         |
+| `<PlayRenderer>`   | Zero-prop leaf component — reads `getPlayViewContext()` and renders `<Renderer>` from `@xmachines/json-render-svelte`.        |
 
 ### Functions
 
 | Function                           | Description                                                                                                                                                                                                             |
 | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `defineRegistry(catalog, options)` | Creates a typed component registry. Wraps `@xmachines/json-render-svelte`'s `defineRegistry` with catalog-typed `params` on action handlers. Import from `@xmachines/play-svelte`, not `@xmachines/json-render-svelte`. |
-| `getActorContext()`                | Returns the `AnyPlayActor` from the nearest `ActorProvider` ancestor. Throws if called outside the provider tree.                                                                                                       |
+| `getActorContext()`                | Returns the `AnyPlayActor` of the nearest `ActorProvider` ancestor. It throws when the caller is outside the provider tree.                                                                                             |
 | `getPlayViewContext()`             | Returns the `ViewContextValue` (spec, registry, handlers, store) from the nearest `ActorProvider` ancestor.                                                                                                             |
-| `setActorContext(actor)`           | Sets the actor context — used internally by `ActorProvider`.                                                                                                                                                            |
+| `setActorContext(actor)`           | Sets the actor context. `ActorProvider` uses it internally.                                                                                                                                                             |
 
 ### Types
 
@@ -105,17 +111,17 @@ 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 provided by `ActorProvider` and consumed by `PlayRenderer`.                                                    |
-| `AnyPlayActor`             | `AbstractActor<AnyActorLogic> & Viewable` — the actor shape accepted by `ActorProvider` and `getActorContext`.                        |
+| `ViewContextValue`         | The view context shape that `ActorProvider` provides and `PlayRenderer` reads.                                                        |
+| `AnyPlayActor`             | `AbstractActor<AnyActorLogic> & Viewable` — the actor shape that `ActorProvider` and `getActorContext` accept.                        |
 | `DefineRegistryOptions<C>` | Options for `defineRegistry`: `components`, catalog-typed `actions`, and `onRenderError`.                                             |
-| `ActionFn<C, K>`           | Per-action handler type with params inferred from catalog.                                                                            |
+| `ActionFn<C, K>`           | The handler type for one action. The params come from the catalog.                                                                    |
 | `Actions<C>`               | Map of catalog-typed action handlers.                                                                                                 |
-| `SetState`                 | State setter function type passed as the second argument to action handlers.                                                          |
-| `RenderErrorHandler`       | Callback `(error: unknown, elementType: string) => void` invoked when a catalog component throws.                                     |
+| `SetState`                 | The state setter type. Each action handler receives it as the second argument.                                                        |
+| `RenderErrorHandler`       | The callback `(error: unknown, elementType: string) => void`. The renderer calls it when a catalog component throws.                  |
 
 ### Re-exports from `@xmachines/json-render-svelte`
 
-Import everything from `@xmachines/play-svelte` — these providers are re-exported for convenience:
+Import everything from `@xmachines/play-svelte`. This package re-exports these providers:
 
 ```ts
 import {
@@ -152,30 +158,33 @@ Or from within the package directory:
 pnpm test
 ```
 
-Tests run with [Vitest](https://vitest.dev/) in a `jsdom` environment using `@testing-library/svelte`. Browser-specific tests are in `test/browser/` and use a separate Playwright-backed config:
+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% lines, functions, branches, and statements (enforced via v8 provider).
+**Coverage thresholds:** 80% for lines, functions, branches, and statements. The v8 provider enforces them.
 
 ## License
 
 MIT — see [LICENSE](./LICENSE).
 
-@xmachines/play-svelte - Svelte renderer for XMachines Play architecture
+@xmachines/play-svelte - Svelte renderer for the XMachines Play architecture
 
-Provides a provider/renderer split that mirrors @xmachines/json-render-svelte patterns:
+The package splits the provider from the renderer, in the same way as
+@xmachines/json-render-svelte:
 
-- ActorProvider: primitive escape-hatch (owns actor lifecycle, signal subscription,
-  per-view StateStore, onRenderError injection)
-- PlayUIProvider: batteries-included composite (ActorProvider + JsonUIProvider)
-- PlayRenderer: zero-prop leaf — reads getPlayViewContext() and renders Renderer
+- ActorProvider: the low-level provider. It owns the actor lifecycle, the signal
+  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
+  the Renderer
 
-Re-exports primitives from @xmachines/json-render-svelte so consumers import everything
-from @xmachines/play-svelte rather than @xmachines/json-render-svelte directly.
+The package re-exports the primitives of @xmachines/json-render-svelte. A
+consumer therefore imports everything from @xmachines/play-svelte, and not from
+@xmachines/json-render-svelte.
 
 ## Interfaces
 

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

@@ -6,12 +6,13 @@
 function defineRegistry<C>(catalog, options): DefineRegistryResult;
 ```
 
-Defined in: [packages/play-svelte/src/define-registry.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-svelte/src/define-registry.ts#L154)
+Defined in: [packages/play-svelte/src/define-registry.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte/src/define-registry.ts#L156)
 
-Create a component registry, restoring catalog-typed `params` on action handlers.
+Creates a component registry, and gives each action handler its catalog-typed `params`.
 
-Drop-in replacement for `defineRegistry` from `@xmachines/json-render-svelte`. Import from
-`@xmachines/play-svelte` to get per-action param type inference for free.
+This function is the drop-in replacement for `defineRegistry` from
+`@xmachines/json-render-svelte`. Import it from `@xmachines/play-svelte`, and each
+action then gets its param type from the catalog.
 
 ## Type Parameters
 
@@ -21,10 +22,10 @@ Drop-in replacement for `defineRegistry` from `@xmachines/json-render-svelte`. I
 
 ## Parameters
 
-| Parameter | Type                                                                     | Description                                                                |
-| --------- | ------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
-| `catalog` | `C`                                                                      | The json-render catalog defining component prop shapes and action schemas. |
-| `options` | [`DefineRegistryOptions`](../interfaces/DefineRegistryOptions.md)\<`C`\> | Registry options. `actions` entries receive params typed from the catalog. |
+| Parameter | Type                                                                     | Description                                                                                         |
+| --------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------- |
+| `catalog` | `C`                                                                      | The json-render catalog. It defines the prop shape of each component and the schema of each action. |
+| `options` | [`DefineRegistryOptions`](../interfaces/DefineRegistryOptions.md)\<`C`\> | The registry options. Each `actions` entry receives its params with the type from the catalog.      |
 
 ## Returns
 

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

@@ -6,11 +6,12 @@
 function getActorContext(): AnyPlayActor;
 ```
 
-Defined in: [packages/play-svelte/src/actor-context.svelte.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-svelte/src/actor-context.svelte.ts#L38)
+Defined in: [packages/play-svelte/src/actor-context.svelte.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte/src/actor-context.svelte.ts#L42)
 
-Get the actor from the nearest ActorProvider ancestor.
+Returns the actor of the nearest ActorProvider ancestor.
 
-Renamed from useActor() to match @xmachines/json-render-svelte's get*Context() convention (D-07).
+This function had the name useActor() before. The new name follows the
+get*Context() convention of @xmachines/json-render-svelte (D-07).
 
 ## Returns
 
@@ -18,4 +19,4 @@ Renamed from useActor() to match @xmachines/json-render-svelte's get*Context() c
 
 ## Throws
 
-if called outside <ActorProvider> or <PlayUIProvider>
+When the caller is outside <ActorProvider> or <PlayUIProvider>

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

@@ -6,9 +6,9 @@
 function getPlayViewContext(): ViewContextValue;
 ```
 
-Defined in: [packages/play-svelte/src/actor-context.svelte.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-svelte/src/actor-context.svelte.ts#L59)
+Defined in: [packages/play-svelte/src/actor-context.svelte.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte/src/actor-context.svelte.ts#L63)
 
-Get the current view context from the nearest ActorProvider ancestor.
+Returns the current view context of the nearest ActorProvider ancestor.
 
 ## Returns
 
@@ -16,4 +16,4 @@ Get the current view context from the nearest ActorProvider ancestor.
 
 ## Throws
 
-if called outside <ActorProvider> or <PlayUIProvider>
+When the caller is outside <ActorProvider> or <PlayUIProvider>

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:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-svelte/src/actor-context.svelte.ts#L28)
+Defined in: [packages/play-svelte/src/actor-context.svelte.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte/src/actor-context.svelte.ts#L31)
 
 ## Parameters
 

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

@@ -2,14 +2,16 @@
 
 # Interface: ActorProviderProps
 
-Defined in: [packages/play-svelte/src/actor-context.svelte.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-svelte/src/actor-context.svelte.ts#L68)
+Defined in: [packages/play-svelte/src/actor-context.svelte.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte/src/actor-context.svelte.ts#L72)
 
-Framework-agnostic base props shared by every `ActorProvider` implementation
-(React, Vue, Solid, Svelte). `TRegistry` captures the framework-specific
-`DefineRegistryResult` type; `RenderErrorHandler` is sourced from
-`@xmachines/json-render-core` so no second generic is needed.
+The framework-agnostic base props. Every `ActorProvider` implementation shares
+them: React, Vue, Solid, and Svelte. `TRegistry` holds the
+`DefineRegistryResult` type of the framework. `RenderErrorHandler` comes from
+`@xmachines/json-render-core`, and a second generic parameter is therefore not
+necessary.
 
-Framework packages extend this with their `fallback`, `onError`, and `children` fields.
+Each framework package extends this interface with its `fallback` field, its
+`onError` field, and its `children` field.
 
 ## Example
 
@@ -33,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) | Actor instance with currentView signal (requires Viewable capability).                                                                                                                                                      | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor)                   | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L156)             |
-| <a id="property-children"></a> `children`             | `Snippet`                                                                                                                                                                                                                                                        | -                                                                                                                                                                                                                           | -                                                                                                                                                                                   | [packages/play-svelte/src/actor-context.svelte.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-svelte/src/actor-context.svelte.ts#L71) |
-| <a id="property-fallback"></a> `fallback?`            | `Snippet`\<\[\]\>                                                                                                                                                                                                                                                | -                                                                                                                                                                                                                           | -                                                                                                                                                                                   | [packages/play-svelte/src/actor-context.svelte.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-svelte/src/actor-context.svelte.ts#L69) |
-| <a id="property-onerror"></a> `onError?`              | (`error`, `reset`) => `void`                                                                                                                                                                                                                                     | -                                                                                                                                                                                                                           | -                                                                                                                                                                                   | [packages/play-svelte/src/actor-context.svelte.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-svelte/src/actor-context.svelte.ts#L70) |
-| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                                                                                    | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry.                                                                                           | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror)   | [packages/play-actor/src/abstract-actor.ts:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L169)             |
-| <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult`                                                                                                                                                                                                                                           | Full result from defineRegistry() — contains the component registry and action handlers factory.                                                                                                                            | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L158)             |
-| <a id="property-store"></a> `store?`                  | `StateStore`                                                                                                                                                                                                                                                     | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store)                   | [packages/play-actor/src/abstract-actor.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L164)             |
+| 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/v2.1.0/packages/play-actor/src/abstract-actor.ts#L163)             |
+| <a id="property-children"></a> `children`             | `Snippet`                                                                                                                                                                                                                                                        | -                                                                                                                                                                                                                                                                                 | -                                                                                                                                                                                   | [packages/play-svelte/src/actor-context.svelte.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte/src/actor-context.svelte.ts#L75) |
+| <a id="property-fallback"></a> `fallback?`            | `Snippet`\<\[\]\>                                                                                                                                                                                                                                                | -                                                                                                                                                                                                                                                                                 | -                                                                                                                                                                                   | [packages/play-svelte/src/actor-context.svelte.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte/src/actor-context.svelte.ts#L73) |
+| <a id="property-onerror"></a> `onError?`              | (`error`, `reset`) => `void`                                                                                                                                                                                                                                     | -                                                                                                                                                                                                                                                                                 | -                                                                                                                                                                                   | [packages/play-svelte/src/actor-context.svelte.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte/src/actor-context.svelte.ts#L74) |
+| <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/v2.1.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/v2.1.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/v2.1.0/packages/play-actor/src/abstract-actor.ts#L172)             |