@xmachines/docs 2.2.0 → 3.0.0

package/api/@xmachines/play-actor/functions/sameViewInputs.md

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

package/api/@xmachines/play-actor/functions/shallowEqualExcept.md

@@ -6,7 +6,7 @@
 function shallowEqualExcept(a, b, except?): boolean;
 ```
 
-Defined in: [packages/play-actor/src/context-projection.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/context-projection.ts#L58)
+Defined in: [packages/play-actor/src/context-projection.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/context-projection.ts#L58)
 
 The shallow equality of the own keys, with `Object.is`. It can ignore one key on
 both sides.

package/api/@xmachines/play-actor/functions/toAtomState.md

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

package/api/@xmachines/play-actor/functions/typedSpec.md

@@ -6,7 +6,7 @@
 function typedSpec(spec): PlaySpec;
 ```
 
-Defined in: [packages/play-actor/src/abstract-actor.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L91)
+Defined in: [packages/play-actor/src/abstract-actor.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L91)
 
 The identity helper gives a view spec literal the type `PlaySpec` at the
 definition site. The compiler therefore checks the spec, and the IDE completes it.

package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md

@@ -2,7 +2,7 @@
 
 # Interface: BaseActorProviderProps\<TRegistry\>
 
-Defined in: [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L159)
+Defined in: [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L159)
 
 The framework-agnostic base props. Every `ActorProvider` implementation shares
 them: React, Vue, Solid, and Svelte. `TRegistry` holds the
@@ -42,7 +42,7 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
 
 | Property                                              | Type                                                                                                                                                                                                                   | Description                                                                                                                                                                                                                                                                       | Defined in                                                                                                                                               |
 | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                   | [`AbstractActor`](../classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](Viewable.md) | The actor instance with the currentView signal. It requires the Viewable capability.                                                                                                                                                                                              | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L163) |
-| <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-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L177) |
-| <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-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.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. | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L172) |
+| <a id="property-actor"></a> `actor`                   | [`AbstractActor`](../classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](Viewable.md) | The actor instance with the currentView signal. It requires the Viewable capability.                                                                                                                                                                                              | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L163) |
+| <a id="property-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-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L177) |
+| <a id="property-registryresult"></a> `registryResult` | `TRegistry`                                                                                                                                                                                                            | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.                                                                                                                                                                  | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L165) |
+| <a id="property-store"></a> `store?`                  | `StateStore`                                                                                                                                                                                                           | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L172) |

package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md

@@ -2,7 +2,7 @@
 
 # Interface: BaseViewContextValue\<TRegistry\>
 
-Defined in: [packages/play-actor/src/abstract-actor.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L123)
+Defined in: [packages/play-actor/src/abstract-actor.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L123)
 
 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-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L127) |
-| <a id="property-registry"></a> `registry` | `TRegistry`                           | The component registry, from registryResult.registry.                                                                  | [packages/play-actor/src/abstract-actor.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L129) |
-| <a id="property-spec"></a> `spec`         | [`PlaySpec`](PlaySpec.md)             | The current PlaySpec to render.                                                                                        | [packages/play-actor/src/abstract-actor.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L125) |
-| <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-actor/src/abstract-actor.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L133) |
+| <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore.                                                             | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L127) |
+| <a id="property-registry"></a> `registry` | `TRegistry`                           | The component registry, from registryResult.registry.                                                                  | [packages/play-actor/src/abstract-actor.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L129) |
+| <a id="property-spec"></a> `spec`         | [`PlaySpec`](PlaySpec.md)             | The current PlaySpec to render.                                                                                        | [packages/play-actor/src/abstract-actor.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L125) |
+| <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-actor/src/abstract-actor.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L133) |

package/api/@xmachines/play-actor/interfaces/FailureLatch.md

@@ -0,0 +1,59 @@
+[API](../../../README.md) / [@xmachines/play-actor](../README.md) / FailureLatch
+
+# Interface: FailureLatch
+
+Defined in: [packages/play-actor/src/failure-latch.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L174)
+
+The record of what a provider reported. See [createFailureLatch](../functions/createFailureLatch.md).
+
+## Methods
+
+### clear()
+
+```ts
+clear(): void;
+```
+
+Defined in: [packages/play-actor/src/failure-latch.ts:191](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L191)
+
+Forgets the record, so the next failure reports again.
+
+A caller clears it on EVERY emission of a view, the null emission included: a view,
+then null, then the same view is a real sequence of an actor, and the second failure
+of that view is a second attempt that the host must hear about. It also clears it on
+a resolution that works, and on a retry that the host starts — the host asked for
+that attempt, so it must hear the result.
+
+#### Returns
+
+`void`
+
+---
+
+### shouldReport()
+
+```ts
+shouldReport(
+   actor,
+   view,
+   store): boolean;
+```
+
+Defined in: [packages/play-actor/src/failure-latch.ts:181](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L181)
+
+Answers whether a failure of these three inputs is new, and records it.
+
+#### Parameters
+
+| Parameter | Type      |
+| --------- | --------- |
+| `actor`   | `unknown` |
+| `view`    | `unknown` |
+| `store`   | `unknown` |
+
+#### Returns
+
+`boolean`
+
+`true` the first time for one set of inputs, and `false` for every repeat
+of the same set. A caller reports only when it returns `true`.

package/api/@xmachines/play-actor/interfaces/PlaySpec.md

@@ -2,7 +2,7 @@
 
 # Interface: PlaySpec
 
-Defined in: [packages/play-actor/src/abstract-actor.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L47)
+Defined in: [packages/play-actor/src/abstract-actor.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L47)
 
 The XMachines extension of the `Spec` type of `@xmachines/json-render-core`.
 
@@ -23,4 +23,4 @@ spec reads only the paths that it needs.
 | <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-actor/src/abstract-actor.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L55) |
+| <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-actor/src/abstract-actor.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L55) |

package/api/@xmachines/play-actor/interfaces/ReportGuard.md

@@ -0,0 +1,92 @@
+[API](../../../README.md) / [@xmachines/play-actor](../README.md) / ReportGuard
+
+# Interface: ReportGuard
+
+Defined in: [packages/play-actor/src/failure-latch.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L59)
+
+A report guard of one provider.
+
+The rule it holds: a provider reports a contained failure to the host, and it must do
+that without letting the host defeat the containment. Two things follow — a reset that
+the host calls from INSIDE the report does nothing, because no input changed between
+the two attempts; and every callback that the provider handed out does nothing once the
+provider is gone, because a host can keep a reset (a "Retry" button of a toast outlives
+the route that opened it).
+
+## Methods
+
+### blocked()
+
+```ts
+blocked(): boolean;
+```
+
+Defined in: [packages/play-actor/src/failure-latch.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L61)
+
+True when a reset that the host starts must do nothing.
+
+#### Returns
+
+`boolean`
+
+---
+
+### dispose()
+
+```ts
+dispose(): void;
+```
+
+Defined in: [packages/play-actor/src/failure-latch.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L74)
+
+The provider is gone.
+
+#### Returns
+
+`void`
+
+---
+
+### disposed()
+
+```ts
+disposed(): boolean;
+```
+
+Defined in: [packages/play-actor/src/failure-latch.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L72)
+
+True once [ReportGuard.dispose](#dispose) ran, and never for a report that runs.
+
+[ReportGuard.blocked](#blocked) answers a different question: it is true for the
+re-entry of a report as well, and it goes back to false when that report ends. A
+caller that asks whether the guard is SPENT — play-react builds one again after the
+cleanup of `<StrictMode>` disposed it — must read this one: `blocked()` there would
+replace a live guard that is reporting, and the `finally` of that report would then
+clear the re-entry flag of a guard that nobody holds.
+
+#### Returns
+
+`boolean`
+
+---
+
+### report()
+
+```ts
+report(error, deliver): void;
+```
+
+Defined in: [packages/play-actor/src/failure-latch.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L86)
+
+Delivers one report, with the re-entry flag held for the call.
+
+#### Parameters
+
+| Parameter | Type                          | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| --------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `error`   | `unknown`                     | The contained failure.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| `deliver` | (() => `void`) \| `undefined` | The call of the handler of the host, or `undefined` when the host gave none. Without a handler the guard writes [ReportGuardMessages.noHandler](ReportGuardMessages.md#property-nohandler) to `console.error`: a contained failure that reaches no handler and no caller is the one result that nobody can debug. A handler that THROWS is contained where the guard carries [ReportGuardMessages.handlerThrew](ReportGuardMessages.md#property-handlerthrew), and it reaches the caller where it does not. |
+
+#### Returns
+
+`void`

package/api/@xmachines/play-actor/interfaces/ReportGuardMessages.md

@@ -0,0 +1,18 @@
+[API](../../../README.md) / [@xmachines/play-actor](../README.md) / ReportGuardMessages
+
+# Interface: ReportGuardMessages
+
+Defined in: [packages/play-actor/src/failure-latch.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L96)
+
+What a [ReportGuard](ReportGuard.md) writes to `console.error`, and what it therefore contains.
+
+Each message is optional, and each one is a DECISION of the renderer that builds the
+guard. The rule that both serve is one rule: a contained failure is never silent, and
+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 — `queueMicrotask(() => { throw error; })`. 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-actor/src/failure-latch.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/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-actor/src/failure-latch.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L103) |

package/api/@xmachines/play-actor/interfaces/ResolveViewStoreOptions.md

@@ -2,10 +2,10 @@
 
 # Interface: ResolveViewStoreOptions
 
-Defined in: [packages/play-actor/src/view-store-lifecycle.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L57)
+Defined in: [packages/play-actor/src/view-store-lifecycle.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L57)
 
 ## 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-actor/src/view-store-lifecycle.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L64) |
+| <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-actor/src/view-store-lifecycle.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L64) |

package/api/@xmachines/play-actor/interfaces/Routable.md

@@ -2,7 +2,7 @@
 
 # Interface: Routable
 
-Defined in: [packages/play-actor/src/abstract-actor.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L33)
+Defined in: [packages/play-actor/src/abstract-actor.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L33)
 
 An optional capability: the routing support
 
@@ -10,5 +10,5 @@ An optional capability: the routing support
 
 | Property                                          | Modifier   | Type                                                                                         | Defined in                                                                                                                                             |
 | ------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | [packages/play-actor/src/abstract-actor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L34) |
-| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                           | [packages/play-actor/src/abstract-actor.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L35) |
+| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | [packages/play-actor/src/abstract-actor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L34) |
+| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                           | [packages/play-actor/src/abstract-actor.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L35) |

package/api/@xmachines/play-actor/interfaces/ViewInputs.md

@@ -0,0 +1,19 @@
+[API](../../../README.md) / [@xmachines/play-actor](../README.md) / ViewInputs
+
+# Interface: ViewInputs
+
+Defined in: [packages/play-actor/src/failure-latch.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L33)
+
+The three inputs that a provider resolves a store from.
+
+`ViewStoreLifecycle.resolve` takes exactly these, and every provider names all three in
+its reset rule. The type gives the rule one name, so the comparison below stands one
+time instead of once for each renderer that needs it.
+
+## Properties
+
+| Property                            | Type      | Defined in                                                                                                                                           |
+| ----------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor` | `unknown` | [packages/play-actor/src/failure-latch.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L34) |
+| <a id="property-store"></a> `store` | `unknown` | [packages/play-actor/src/failure-latch.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L36) |
+| <a id="property-view"></a> `view`   | `unknown` | [packages/play-actor/src/failure-latch.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/failure-latch.ts#L35) |

package/api/@xmachines/play-actor/interfaces/ViewStoreLifecycle.md

@@ -2,7 +2,7 @@
 
 # Interface: ViewStoreLifecycle
 
-Defined in: [packages/play-actor/src/view-store-lifecycle.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L67)
+Defined in: [packages/play-actor/src/view-store-lifecycle.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L67)
 
 ## Methods
 
@@ -12,7 +12,7 @@ Defined in: [packages/play-actor/src/view-store-lifecycle.ts:67](https://gitlab.
 reset(): void;
 ```
 
-Defined in: [packages/play-actor/src/view-store-lifecycle.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L84)
+Defined in: [packages/play-actor/src/view-store-lifecycle.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L84)
 
 Drops everything, on an unmount or a disconnect. The next resolve makes a new seed.
 
@@ -32,7 +32,7 @@ resolve(
    options?): ViewStoreResolution;
 ```
 
-Defined in: [packages/play-actor/src/view-store-lifecycle.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L77)
+Defined in: [packages/play-actor/src/view-store-lifecycle.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L77)
 
 Brings the store in line with an emission, and returns it with its guard.
 

package/api/@xmachines/play-actor/interfaces/ViewStoreResolution.md

@@ -2,7 +2,7 @@
 
 # Interface: ViewStoreResolution
 
-Defined in: [packages/play-actor/src/view-store-lifecycle.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L38)
+Defined in: [packages/play-actor/src/view-store-lifecycle.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L38)
 
 The result of a resolve — see [ViewStoreLifecycle.resolve](ViewStoreLifecycle.md#resolve).
 
@@ -10,6 +10,6 @@ The result of a resolve — see [ViewStoreLifecycle.resolve](ViewStoreLifecycle.
 
 | Property                                          | Type         | Description                                                                                                                                                                                                                                                                       | Defined in                                                                                                                                                         |
 | ------------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-guardedstore"></a> `guardedStore` | `StateStore` | The store to give to the children ($bindState, setState, and a chained set): a write under /context throws. There is one wrapper for each store below it, and the code caches the identity. Therefore a consumer in the style of `useSyncExternalStore` stays stable.             | [packages/play-actor/src/view-store-lifecycle.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L47) |
-| <a id="property-reseeded"></a> `reseeded`         | `boolean`    | It is true when this resolve made a new store: at the first resolve, on a change of the viewKey, in the fallback for each emission, and on a change of the actor. A provider that mounts a subtree again for each store, such as the storeKey of Vue, uses this field as its key. | [packages/play-actor/src/view-store-lifecycle.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L54) |
-| <a id="property-store"></a> `store`               | `StateStore` | The store WITHOUT the guard — the reference of the machinery for its own refresh.                                                                                                                                                                                                 | [packages/play-actor/src/view-store-lifecycle.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L40) |
+| <a id="property-guardedstore"></a> `guardedStore` | `StateStore` | The store to give to the children ($bindState, setState, and a chained set): a write under /context throws. There is one wrapper for each store below it, and the code caches the identity. Therefore a consumer in the style of `useSyncExternalStore` stays stable.             | [packages/play-actor/src/view-store-lifecycle.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L47) |
+| <a id="property-reseeded"></a> `reseeded`         | `boolean`    | It is true when this resolve made a new store: at the first resolve, on a change of the viewKey, in the fallback for each emission, and on a change of the actor. A provider that mounts a subtree again for each store, such as the storeKey of Vue, uses this field as its key. | [packages/play-actor/src/view-store-lifecycle.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L54) |
+| <a id="property-store"></a> `store`               | `StateStore` | The store WITHOUT the guard — the reference of the machinery for its own refresh.                                                                                                                                                                                                 | [packages/play-actor/src/view-store-lifecycle.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/view-store-lifecycle.ts#L40) |

package/api/@xmachines/play-actor/interfaces/Viewable.md

@@ -2,7 +2,7 @@
 
 # Interface: Viewable
 
-Defined in: [packages/play-actor/src/abstract-actor.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L103)
+Defined in: [packages/play-actor/src/abstract-actor.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L103)
 
 The actor capability that exposes a renderable view state.
 
@@ -15,4 +15,4 @@ therefore holds no view logic.
 
 | Property                                        | Modifier   | Type                                                                                                    | Description                                                                                                                                                                                                 | Defined in                                                                                                                                               |
 | ----------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](PlaySpec.md) \| `null`\> | The signal of the current view. It holds the json-render PlaySpec of the current machine state, or null when no view is active. The infrastructure renders the view. This is the Logic-Driven UI invariant. | [packages/play-actor/src/abstract-actor.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L110) |
+| <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](PlaySpec.md) \| `null`\> | The signal of the current view. It holds the json-render PlaySpec of the current machine state, or null when no view is active. The infrastructure renders the view. This is the Logic-Driven UI invariant. | [packages/play-actor/src/abstract-actor.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L110) |

package/api/@xmachines/play-actor/variables/CONTEXT_STATE_KEY.md

@@ -6,7 +6,7 @@
 const CONTEXT_STATE_KEY: "context" = "context";
 ```
 
-Defined in: [packages/play-actor/src/context-projection.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/context-projection.ts#L32)
+Defined in: [packages/play-actor/src/context-projection.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/context-projection.ts#L32)
 
 The reserved top-level state key of the projection.