@xmachines/docs 6.1.0 → 7.0.0

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

@@ -0,0 +1,39 @@
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / createActorProxy
+
+# Function: createActorProxy()
+
+```ts
+function createActorProxy<TActor>(getActor): TActor;
+```
+
+Defined in: [packages/play-view/src/actor-proxy.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/actor-proxy.ts#L32)
+
+Makes a proxy that behaves like the current actor.
+
+- A read, a write, a definition (`Object.defineProperty`), a delete, and a membership
+  test (`in`) reach the current actor.
+- An enumeration (`Object.keys`, a spread) lists the own keys of the current actor.
+- `instanceof` answers with the prototype of the current actor.
+- `Object.preventExtensions` and `Object.freeze` throw a `TypeError`. The proxy stands
+  for each actor of the props in turn, so it cannot promise a fixed set of keys.
+- A method comes back bound to the current actor, so `this` and a private field work
+  as in a direct call. The proxy keeps one bound method for each actor and method, so
+  a repeated read returns the SAME function (`actor.send === actor.send`).
+
+## Type Parameters
+
+| Type Parameter              |
+| --------------------------- |
+| `TActor` _extends_ `object` |
+
+## Parameters
+
+| Parameter  | Type           | Description                                                        |
+| ---------- | -------------- | ------------------------------------------------------------------ |
+| `getActor` | () => `TActor` | Returns the actor of the props. The proxy calls it at each access. |
+
+## Returns
+
+`TActor`
+
+The proxy.

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

@@ -0,0 +1,35 @@
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / createRenderErrorBinding
+
+# Function: createRenderErrorBinding()
+
+```ts
+function createRenderErrorBinding<TResult>(): (result, handler, onRootFailure?) => TResult;
+```
+
+Defined in: [packages/play-view/src/provider-guards.ts:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/provider-guards.ts#L160)
+
+Makes a binding of an `onRenderError` handler to a registry result, for one provider.
+
+A provider calls the binding on each render with the registry result, the handler of
+that render, and the containment of a failure of the root. The binding returns:
+
+- the registry result itself, when it receives neither a handler nor a containment;
+- else one copy for each registry. The copy gives each report to
+  [forwardRenderError](forwardRenderError.md), with the LATEST handler, and it gives a failure of the
+  root to the LATEST containment. A host that passes a new inline function on each
+  render therefore keeps one registry identity, and the renderer below resolves no
+  element again for it.
+
+The copy comes from [attachRenderErrorHandler](attachRenderErrorHandler.md), so it keeps the slot metadata.
+
+## Type Parameters
+
+| Type Parameter               | Description                                           |
+| ---------------------------- | ----------------------------------------------------- |
+| `TResult` _extends_ `object` | The result type of `defineRegistry` of the framework. |
+
+## Returns
+
+The binding of one provider.
+
+(`result`, `handler`, `onRootFailure?`) => `TResult`

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

@@ -6,7 +6,7 @@
 function createReportGuard(messages): ReportGuard;
 ```
 
-Defined in: [packages/play-view/src/failure-latch.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L134)
+Defined in: [packages/play-view/src/report-guard.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/report-guard.ts#L98)
 
 Makes a [ReportGuard](../interfaces/ReportGuard.md).
 

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

@@ -0,0 +1,29 @@
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / createViewSession
+
+# Function: createViewSession()
+
+```ts
+function createViewSession<TActor>(actor, store, options): ViewSession<TActor>;
+```
+
+Defined in: [packages/play-view/src/view-session.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-session.ts#L152)
+
+Makes a view session.
+
+## Type Parameters
+
+| Type Parameter                                                 |
+| -------------------------------------------------------------- |
+| `TActor` _extends_ [`ViewActor`](../type-aliases/ViewActor.md) |
+
+## Parameters
+
+| Parameter | Type                                                        | Description                                                    |
+| --------- | ----------------------------------------------------------- | -------------------------------------------------------------- |
+| `actor`   | `TActor`                                                    | The actor of the provider.                                     |
+| `store`   | `StateStore` \| `undefined`                                 | The controlled store of the host, or `undefined`.              |
+| `options` | [`ViewSessionOptions`](../interfaces/ViewSessionOptions.md) | See [ViewSessionOptions](../interfaces/ViewSessionOptions.md). |
+
+## Returns
+
+[`ViewSession`](../interfaces/ViewSession.md)\<`TActor`\>

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

@@ -6,7 +6,7 @@
 function createViewStoreLifecycle(createStore): ViewStoreLifecycle;
 ```
 
-Defined in: [packages/play-view/src/view-store-lifecycle.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-store-lifecycle.ts#L124)
+Defined in: [packages/play-view/src/view-store-lifecycle.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-store-lifecycle.ts#L135)
 
 Creates a coordinator of the lifecycle.
 

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

@@ -0,0 +1,45 @@
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / forwardRenderError
+
+# Function: forwardRenderError()
+
+```ts
+function forwardRenderError(handler, registry, error, name, info): boolean;
+```
+
+Defined in: [packages/play-view/src/provider-guards.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/provider-guards.ts#L116)
+
+Gives one report of json-render to the handler of the host, and tells the caller
+whether the report is a failure of the root.
+
+The five providers hold one rule for a report, and this function holds it for them:
+
+- The report goes to `handler`, the `onRenderError` of the host. Without it, the
+  report goes to the handler that `defineRegistry` put on `registry`. Without that one
+  too, the report goes to the one `[json-render]` console line of core. `info` goes
+  through without a change, and a handler that throws gives its error to `reportError`.
+- A failure of the ROOT (`info.kind` `"root"`) leaves no view on the screen, and the
+  provider contains it as a failure of the view: it shows its fallback, and it calls its
+  `onError`. The function therefore writes no console line for such a report. The
+  containment reports the failure to `onError`, or writes its own line, and a second
+  line would report one failure two times. A handler of the host still receives it.
+- A component can call the handler itself, at the context of the renderer, with the two
+  arguments `(error, name)`. Such a call is no failure of the root. It reaches the
+  handler with the info `{ kind: "element", type: name }`, because the handler of the
+  host declares a required `info`. Without a handler, it goes to one `console.error`
+  line, as the component writes when the context holds no handler.
+
+## Parameters
+
+| Parameter  | Type                                                                                   | Description                                                                 |
+| ---------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `handler`  | \| [`OnRenderError`](../../../play-dom/type-aliases/OnRenderError.md) \| `undefined`   | The `onRenderError` of the host, or `undefined`.                            |
+| `registry` | `object`                                                                               | The registry of the caller, which can hold the handler of `defineRegistry`. |
+| `error`    | `unknown`                                                                              | The value that failed.                                                      |
+| `name`     | `string`                                                                               | The name of the report: the element type, or the action name of a chain.    |
+| `info`     | \| [`RenderErrorInfo`](../../../play-dom/interfaces/RenderErrorInfo.md) \| `undefined` | The info of the report, or `undefined` for a call of a component.           |
+
+## Returns
+
+`boolean`
+
+`true` for a failure of the root, which the caller contains.

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

@@ -6,7 +6,7 @@
 function guardContextWrites(store): StateStore;
 ```
 
-Defined in: [packages/play-view/src/context-projection.ts:132](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/context-projection.ts#L132)
+Defined in: [packages/play-view/src/context-projection.ts:136](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/context-projection.ts#L136)
 
 ## Parameters
 

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

@@ -6,7 +6,7 @@
 function refreshContextSubtree(store, view): void;
 ```
 
-Defined in: [packages/play-view/src/context-projection.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/context-projection.ts#L185)
+Defined in: [packages/play-view/src/context-projection.ts:189](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/context-projection.ts#L189)
 
 Refreshes the `/context` subtree of a live store from the composed state of a
 derived view. An emission with the same `viewKey` means that only the projection

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

@@ -6,7 +6,7 @@
 function reuseComposedState(prev, next): PlaySpec | null;
 ```
 
-Defined in: [packages/play-view/src/context-projection.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/context-projection.ts#L68)
+Defined in: [packages/play-view/src/context-projection.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/context-projection.ts#L72)
 
 Reuses the composed `state` of the previous emission, or the complete previous
 spec, when the value of the projection did not change.

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

@@ -6,7 +6,7 @@
 function toAtomState(state): Record<string, unknown>;
 ```
 
-Defined in: [packages/play-view/src/provider-guards.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/provider-guards.ts#L39)
+Defined in: [packages/play-view/src/provider-guards.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/provider-guards.ts#L47)
 
 Converts the `state` field of a spec into a plain object for `createAtom`, in a safe way.
 

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

@@ -6,7 +6,7 @@
 function typedSpec(spec): ViewMeta;
 ```
 
-Defined in: [packages/play-view/src/view-types.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L131)
+Defined in: [packages/play-view/src/view-types.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L126)
 
 The identity helper gives a view spec literal the type [ViewMeta](../interfaces/ViewMeta.md) at the
 definition site. The compiler therefore checks the spec, and the IDE completes it.

package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md

@@ -2,11 +2,11 @@
 
 # Interface: BaseActorProviderProps\<TRegistry, TActor\>
 
-Defined in: [packages/play-view/src/view-types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L219)
+Defined in: [packages/play-view/src/view-types.ts:214](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L214)
 
 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
+`DefineRegistryResult` type of the framework. `OnRenderError` comes from
 `@xmachines/json-render-core`, and a second generic parameter is therefore not
 necessary.
 
@@ -41,9 +41,9 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
 
 ## Properties
 
-| Property                                              | Type                                                                         | Description                                                                                                                                                                                                                                                                       | Defined in                                                                                                                                     |
-| ----------------------------------------------------- | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                   | `TActor`                                                                     | The actor instance with the currentView atom. It requires the Viewable capability.                                                                                                                                                                                                | [packages/play-view/src/view-types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L224) |
-| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../../../play-dom/type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry.                                                                                                                                             | [packages/play-view/src/view-types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L238) |
-| <a id="property-registryresult"></a> `registryResult` | `TRegistry`                                                                  | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.                                                                                                                                                                  | [packages/play-view/src/view-types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L226) |
-| <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. | [packages/play-view/src/view-types.ts:233](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L233) |
+| Property                                              | Type                                                               | Description                                                                                                                                                                                                                                                                                                                                                                                                    | Defined in                                                                                                                                     |
+| ----------------------------------------------------- | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`                   | `TActor`                                                           | The actor instance with the currentView atom. It requires the Viewable capability.                                                                                                                                                                                                                                                                                                                             | [packages/play-view/src/view-types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L219) |
+| <a id="property-onrendererror"></a> `onRenderError?`  | [`OnRenderError`](../../../play-dom/type-aliases/OnRenderError.md) | The renderer calls it with `(error, name, info)` for each failure that it reports: a catalog component that throws, a prop or a `visible` condition that fails, an action chain or a watch chain that fails, and a failure of the root. `info.kind` names the kind of the failure. A handler with the two parameters `(error, name)` stays valid. This handler replaces every onRenderError of defineRegistry. | [packages/play-view/src/view-types.ts:236](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L236) |
+| <a id="property-registryresult"></a> `registryResult` | `TRegistry`                                                        | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.                                                                                                                                                                                                                                                                                               | [packages/play-view/src/view-types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L221) |
+| <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.                                                                                                                              | [packages/play-view/src/view-types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L228) |

package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md

@@ -2,7 +2,7 @@
 
 # Interface: BaseViewContextValue\<TRegistry\>
 
-Defined in: [packages/play-view/src/view-types.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L163)
+Defined in: [packages/play-view/src/view-types.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L158)
 
 The framework-agnostic base of the `ViewContextValue` type in each framework.
 
@@ -28,7 +28,7 @@ same generic parameter as in `BaseActorProviderProps`.
 
 | Property                                  | Type                                  | Description                                                                                                            | Defined in                                                                                                                                     |
 | ----------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore.                                                             | [packages/play-view/src/view-types.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L167) |
-| <a id="property-registry"></a> `registry` | `TRegistry`                           | The component registry, from registryResult.registry.                                                                  | [packages/play-view/src/view-types.ts:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L169) |
-| <a id="property-spec"></a> `spec`         | [`PlaySpec`](PlaySpec.md)             | The current PlaySpec to render.                                                                                        | [packages/play-view/src/view-types.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L165) |
-| <a id="property-store"></a> `store`       | `StateStore`                          | The active StateStore. Give it to JSONUIProvider or JsonUIProvider as `store`, and the providers then share the state. | [packages/play-view/src/view-types.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L173) |
+| <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore.                                                             | [packages/play-view/src/view-types.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L162) |
+| <a id="property-registry"></a> `registry` | `TRegistry`                           | The component registry, from registryResult.registry.                                                                  | [packages/play-view/src/view-types.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L164) |
+| <a id="property-spec"></a> `spec`         | [`PlaySpec`](PlaySpec.md)             | The current PlaySpec to render.                                                                                        | [packages/play-view/src/view-types.ts:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L160) |
+| <a id="property-store"></a> `store`       | `StateStore`                          | The active StateStore. Give it to JSONUIProvider or JsonUIProvider as `store`, and the providers then share the state. | [packages/play-view/src/view-types.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L168) |

package/api/@xmachines/play-view/index/interfaces/ComposedView.md

@@ -2,7 +2,7 @@
 
 # Interface: ComposedView
 
-Defined in: [packages/play-view/src/compose-views.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/compose-views.ts#L44)
+Defined in: [packages/play-view/src/compose-views.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/compose-views.ts#L48)
 
 The static half of a composed view: everything but the `/context` projection.
 
@@ -10,7 +10,7 @@ The static half of a composed view: everything but the `/context` projection.
 
 | Property                                    | Modifier   | Type                                                                           | Description                                                                     | Defined in                                                                                                                                         |
 | ------------------------------------------- | ---------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-elements"></a> `elements`   | `readonly` | `Record`\<`string`, `UIElement`\<`string`, `Record`\<`string`, `unknown`\>\>\> | The elements of every composed view, with the keys of the child views prefixed. | [packages/play-view/src/compose-views.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/compose-views.ts#L48) |
-| <a id="property-root"></a> `root`           | `readonly` | `string`                                                                       | The root key of the outermost view.                                             | [packages/play-view/src/compose-views.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/compose-views.ts#L46) |
-| <a id="property-state"></a> `state?`        | `readonly` | `Record`\<`string`, `unknown`\>                                                | The authored state of every composed view. The outer view wins on a conflict.   | [packages/play-view/src/compose-views.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/compose-views.ts#L50) |
-| <a id="property-viewparts"></a> `viewParts` | `readonly` | readonly `string`[]                                                            | The ids of the composed state nodes, outermost first.                           | [packages/play-view/src/compose-views.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/compose-views.ts#L52) |
+| <a id="property-elements"></a> `elements`   | `readonly` | `Record`\<`string`, `UIElement`\<`string`, `Record`\<`string`, `unknown`\>\>\> | The elements of every composed view, with the keys of the child views prefixed. | [packages/play-view/src/compose-views.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/compose-views.ts#L52) |
+| <a id="property-root"></a> `root`           | `readonly` | `string`                                                                       | The root key of the outermost view.                                             | [packages/play-view/src/compose-views.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/compose-views.ts#L50) |
+| <a id="property-state"></a> `state?`        | `readonly` | `Record`\<`string`, `unknown`\>                                                | The authored state of every composed view. The outer view wins on a conflict.   | [packages/play-view/src/compose-views.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/compose-views.ts#L54) |
+| <a id="property-viewparts"></a> `viewParts` | `readonly` | readonly `string`[]                                                            | The ids of the composed state nodes, outermost first.                           | [packages/play-view/src/compose-views.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/compose-views.ts#L56) |

package/api/@xmachines/play-view/index/interfaces/HandlerFactory.md

@@ -0,0 +1,19 @@
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / HandlerFactory
+
+# Interface: HandlerFactory\<THandlers\>
+
+Defined in: [packages/play-view/src/provider-guards.ts:199](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/provider-guards.ts#L199)
+
+The part of a `defineRegistry` result that builds the action handlers.
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `THandlers`    |
+
+## Properties
+
+| Property                                  | Type                                       | Defined in                                                                                                                                               |
+| ----------------------------------------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-handlers"></a> `handlers` | (`getSetState`, `getState`) => `THandlers` | [packages/play-view/src/provider-guards.ts:200](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/provider-guards.ts#L200) |

package/api/@xmachines/play-view/index/interfaces/PlaySpec.md

@@ -2,7 +2,7 @@
 
 # Interface: PlaySpec
 
-Defined in: [packages/play-view/src/view-types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L58)
+Defined in: [packages/play-view/src/view-types.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L53)
 
 The view that an actor publishes, and that every renderer receives: the XMachines
 extension of the `Spec` type of `@xmachines/json-render-core`.
@@ -26,5 +26,5 @@ An author writes a [ViewMeta](ViewMeta.md), and not this type.
 | <a id="property-elements"></a> `elements`    | `public`   | `Record`\<`string`, `UIElement`\> | Flat map of elements by key                                                                                                                                                                                                                                                                                                                                                  | `Spec.elements` | -                                                                                                                                            |
 | <a id="property-root"></a> `root`            | `public`   | `string`                          | Root element key                                                                                                                                                                                                                                                                                                                                                             | `Spec.root`     | -                                                                                                                                            |
 | <a id="property-state"></a> `state?`         | `public`   | `Record`\<`string`, `unknown`\>   | Optional initial state to seed the state model. Components using statePath will read from / write to this state.                                                                                                                                                                                                                                                             | `Spec.state`    | -                                                                                                                                            |
-| <a id="property-viewkey"></a> `viewKey?`     | `readonly` | `string`                          | The identity of the view of this derived spec. `deriveCurrentView` sets it from the meta entry that the derivation selected. A provider uses it as the key of its store lifecycle: a new `viewKey` seeds the store again, and the same `viewKey` refreshes `/context` in place, which keeps the ephemeral view state. Never write this field in `meta.view`.                 | -               | [packages/play-view/src/view-types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L66) |
-| <a id="property-viewparts"></a> `viewParts?` | `readonly` | readonly `string`[]               | The ids of the state nodes whose views a composed spec holds, in the order of the composition. `deriveCurrentView` sets it only when a state declares `outlets`. The `viewKey` stays the id of the outermost view, so a change of a substate keeps the store; a new `viewParts` value then seeds the authored state of the new views. Never write this field in `meta.view`. | -               | [packages/play-view/src/view-types.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L74) |
+| <a id="property-viewkey"></a> `viewKey?`     | `readonly` | `string`                          | The identity of the view of this derived spec. `deriveCurrentView` sets it from the meta entry that the derivation selected. A provider uses it as the key of its store lifecycle: a new `viewKey` seeds the store again, and the same `viewKey` refreshes `/context` in place, which keeps the ephemeral view state. Never write this field in `meta.view`.                 | -               | [packages/play-view/src/view-types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L61) |
+| <a id="property-viewparts"></a> `viewParts?` | `readonly` | readonly `string`[]               | The ids of the state nodes whose views a composed spec holds, in the order of the composition. `deriveCurrentView` sets it only when a state declares `outlets`. The `viewKey` stays the id of the outermost view, so a change of a substate keeps the store; a new `viewParts` value then seeds the authored state of the new views. Never write this field in `meta.view`. | -               | [packages/play-view/src/view-types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L69) |

package/api/@xmachines/play-view/index/interfaces/ReportGuard.md

@@ -2,7 +2,7 @@
 
 # Interface: ReportGuard
 
-Defined in: [packages/play-view/src/failure-latch.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L59)
+Defined in: [packages/play-view/src/report-guard.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/report-guard.ts#L23)
 
 A report guard of one provider.
 
@@ -21,7 +21,7 @@ the route that opened it).
 blocked(): boolean;
 ```
 
-Defined in: [packages/play-view/src/failure-latch.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L61)
+Defined in: [packages/play-view/src/report-guard.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/report-guard.ts#L25)
 
 True when a reset that the host starts must do nothing.
 
@@ -37,7 +37,7 @@ True when a reset that the host starts must do nothing.
 dispose(): void;
 ```
 
-Defined in: [packages/play-view/src/failure-latch.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L74)
+Defined in: [packages/play-view/src/report-guard.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/report-guard.ts#L38)
 
 The provider is gone.
 
@@ -53,7 +53,7 @@ The provider is gone.
 disposed(): boolean;
 ```
 
-Defined in: [packages/play-view/src/failure-latch.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L72)
+Defined in: [packages/play-view/src/report-guard.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/report-guard.ts#L36)
 
 True once [ReportGuard.dispose](#dispose) ran, and never for a report that runs.
 
@@ -76,7 +76,7 @@ clear the re-entry flag of a guard that nobody holds.
 report(error, deliver): void;
 ```
 
-Defined in: [packages/play-view/src/failure-latch.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L86)
+Defined in: [packages/play-view/src/report-guard.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/report-guard.ts#L50)
 
 Delivers one report, with the re-entry flag held for the call.
 

package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md

@@ -2,7 +2,7 @@
 
 # Interface: ReportGuardMessages
 
-Defined in: [packages/play-view/src/failure-latch.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L96)
+Defined in: [packages/play-view/src/report-guard.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/report-guard.ts#L60)
 
 What a [ReportGuard](ReportGuard.md) writes to `console.error`, and what it therefore contains.
 
@@ -12,7 +12,7 @@ a handler of the host never defeats the containment.
 
 ## Properties
 
-| Property                                           | Type     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Defined in                                                                                                                                           |
-| -------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-handlerthrew"></a> `handlerThrew?` | `string` | What `console.error` says when the handler of the host THROWS. A guard that carries this message CONTAINS such a throw. All five renderers carry it, so a host learns one rule: a handler of the host never defeats the containment, and a host that must escalate raises the failure from a task of its own — `rethrowLater(error)` of `@xmachines/core/utils`. Omit it only where a throw must reach the caller, which no renderer of this workspace asks for today. A renderer needs the containment when a throw that leaves the report also stops the screen of the fallback: the flag of play-vue schedules a render, the fallback of play-solid is the RETURN of the callback that reports, `componentDidCatch` of play-react can take the complete React root down, and a throw that leaves the `onerror` of Svelte leaves its own `calling_on_error` flag raised, which makes every later reset of the host raise `svelte_boundary_reset_onerror`. | [packages/play-view/src/failure-latch.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L120) |
-| <a id="property-nohandler"></a> `noHandler?`       | `string` | What `console.error` says when the host gave no handler. Omit it where the framework writes such a failure itself: React logs an error that a boundary caught, so play-react would report the same failure two times.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | [packages/play-view/src/failure-latch.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L103) |
+| Property                                           | Type     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Defined in                                                                                                                                       |
+| -------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-handlerthrew"></a> `handlerThrew?` | `string` | What `console.error` says when the handler of the host THROWS. A guard that carries this message CONTAINS such a throw. All five renderers carry it, so a host learns one rule: a handler of the host never defeats the containment, and a host that must escalate raises the failure from a task of its own — `rethrowLater(error)` of `@xmachines/core/utils`. Omit it only where a throw must reach the caller, which no renderer of this workspace asks for today. A renderer needs the containment when a throw that leaves the report also stops the screen of the fallback: the flag of play-vue schedules a render, the fallback of play-solid is the RETURN of the callback that reports, `componentDidCatch` of play-react can take the complete React root down, and a throw that leaves the `onerror` of Svelte leaves its own `calling_on_error` flag raised, which makes every later reset of the host raise `svelte_boundary_reset_onerror`. | [packages/play-view/src/report-guard.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/report-guard.ts#L84) |
+| <a id="property-nohandler"></a> `noHandler?`       | `string` | What `console.error` says when the host gave no handler. Omit it where the framework writes such a failure itself: React logs an error that a boundary caught, so play-react would report the same failure two times.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | [packages/play-view/src/report-guard.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/report-guard.ts#L67) |

package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md

@@ -2,10 +2,10 @@
 
 # Interface: ResolveViewStoreOptions
 
-Defined in: [packages/play-view/src/view-store-lifecycle.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-store-lifecycle.ts#L87)
+Defined in: [packages/play-view/src/view-store-lifecycle.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-store-lifecycle.ts#L91)
 
 ## Properties
 
 | Property                                                           | Type      | Description                                                                                                                                                                                                                                                                    | Defined in                                                                                                                                                       |
 | ------------------------------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-refreshexternalstore"></a> `refreshExternalStore?` | `boolean` | The controlled mode only: refresh the /context subtree of the external store during this resolve. The default is true. Give false where the call site permits no notification of the store subscribers, which is the render path of React, and refresh from an effect instead. | [packages/play-view/src/view-store-lifecycle.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-store-lifecycle.ts#L94) |
+| <a id="property-refreshexternalstore"></a> `refreshExternalStore?` | `boolean` | The controlled mode only: refresh the /context subtree of the external store during this resolve. The default is true. Give false where the call site permits no notification of the store subscribers, which is the render path of React, and refresh from an effect instead. | [packages/play-view/src/view-store-lifecycle.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-store-lifecycle.ts#L98) |

package/api/@xmachines/play-view/index/interfaces/ViewMeta.md

@@ -2,7 +2,7 @@
 
 # Interface: ViewMeta
 
-Defined in: [packages/play-view/src/view-types.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L32)
+Defined in: [packages/play-view/src/view-types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L27)
 
 The view that an author writes in `meta.view`: the `Spec` type of
 `@xmachines/json-render-core`, and the `outlets` of a parent view.
@@ -20,6 +20,6 @@ and it stamps `viewKey`. Validate the derived view, and not this one.
 | Property                                  | Modifier   | Type                                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Inherited from  | Defined in                                                                                                                                   |
 | ----------------------------------------- | ---------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
 | <a id="property-elements"></a> `elements` | `public`   | `Record`\<`string`, `UIElement`\>                                 | Flat map of elements by key                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | `Spec.elements` | -                                                                                                                                            |
-| <a id="property-outlets"></a> `outlets?`  | `readonly` | `Readonly`\<`Record`\<`string`, [`ViewOutlet`](ViewOutlet.md)\>\> | The places where the views of the active substates go. Write this field in the `meta.view` of a PARENT state. The view derivation then renders the parent view and puts the view of each active child into the outlet of that child, so a layout and its page, or the regions of a parallel state, share one screen. Each key is the key of a child state in `states`, or `"*"` for each active child that has no entry of its own. A compound state fills one outlet with its active child. A parallel state fills one outlet for each region. | -               | [packages/play-view/src/view-types.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L43) |
+| <a id="property-outlets"></a> `outlets?`  | `readonly` | `Readonly`\<`Record`\<`string`, [`ViewOutlet`](ViewOutlet.md)\>\> | The places where the views of the active substates go. Write this field in the `meta.view` of a PARENT state. The view derivation then renders the parent view and puts the view of each active child into the outlet of that child, so a layout and its page, or the regions of a parallel state, share one screen. Each key is the key of a child state in `states`, or `"*"` for each active child that has no entry of its own. A compound state fills one outlet with its active child. A parallel state fills one outlet for each region. | -               | [packages/play-view/src/view-types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L38) |
 | <a id="property-root"></a> `root`         | `public`   | `string`                                                          | Root element key                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | `Spec.root`     | -                                                                                                                                            |
 | <a id="property-state"></a> `state?`      | `public`   | `Record`\<`string`, `unknown`\>                                   | Optional initial state to seed the state model. Components using statePath will read from / write to this state.                                                                                                                                                                                                                                                                                                                                                                                                                                | `Spec.state`    | -                                                                                                                                            |

package/api/@xmachines/play-view/index/interfaces/ViewOutlet.md

@@ -2,7 +2,7 @@
 
 # Interface: ViewOutlet
 
-Defined in: [packages/play-view/src/view-types.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L88)
+Defined in: [packages/play-view/src/view-types.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L83)
 
 One outlet of a parent view: the element that receives the view of a child state.
 
@@ -19,5 +19,5 @@ outlets: {
 
 | Property                                | Modifier   | Type     | Description                                                                                                                     | Defined in                                                                                                                                   |
 | --------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-element"></a> `element` | `readonly` | `string` | The key of the element of the parent view that receives the child view.                                                         | [packages/play-view/src/view-types.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L90) |
-| <a id="property-slot"></a> `slot?`      | `readonly` | `string` | A named slot of that element. Omit it to append the child view to the `children` of the element, which every renderer supports. | [packages/play-view/src/view-types.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L95) |
+| <a id="property-element"></a> `element` | `readonly` | `string` | The key of the element of the parent view that receives the child view.                                                         | [packages/play-view/src/view-types.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L85) |
+| <a id="property-slot"></a> `slot?`      | `readonly` | `string` | A named slot of that element. Omit it to append the child view to the `children` of the element, which every renderer supports. | [packages/play-view/src/view-types.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L90) |