@xmachines/docs 2.2.0 → 4.0.0

package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md

@@ -0,0 +1,192 @@
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [errors](../README.md) / ReadOnlyContextError
+
+# Class: ReadOnlyContextError
+
+Defined in: [packages/play-view/src/errors.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/errors.ts#L34)
+
+A write reached the context projection of the view store.
+
+The `/context` subtree of a view mirrors the context of the machine, and it is a
+READ of that context. A write there would hold a value that the next snapshot of the
+machine throws away, so the store refuses it. Send the actor an event instead: the
+context changes in the machine, and the projection follows.
+
+## Example
+
+```typescript
+import { ReadOnlyContextError } from "@xmachines/play-view/errors";
+
+try {
+	store.set("/context/user/name", "Alice");
+} catch (error) {
+	if (error instanceof ReadOnlyContextError) {
+		actor.send({ type: "user.rename", name: "Alice" });
+	}
+}
+```
+
+## Extends
+
+- [`PlayError`](../../../play/errors/classes/PlayError.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new ReadOnlyContextError(path, stateKey): ReadOnlyContextError;
+```
+
+Defined in: [packages/play-view/src/errors.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/errors.ts#L42)
+
+#### Parameters
+
+| Parameter  | Type     | Description                                      |
+| ---------- | -------- | ------------------------------------------------ |
+| `path`     | `string` | The path of the refused write.                   |
+| `stateKey` | `string` | The key of the context subtree, for the message. |
+
+#### Returns
+
+`ReadOnlyContextError`
+
+#### Overrides
+
+[`PlayError`](../../../play/errors/classes/PlayError.md).[`constructor`](../../../play/errors/classes/PlayError.md#constructor)
+
+## Properties
+
+| Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                           |
+| ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause)                     | -                                                                                                                                    |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play/src/errors.ts#L76)           |
+| <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message)                 | -                                                                                                                                    |
+| <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name)                       | -                                                                                                                                    |
+| <a id="property-path"></a> `path`                       | `readonly` | `string`  | The JSON pointer of the write that the store refused, as the caller gave it.                                                                                                                                                                                                                                                                                                                                                                      | -                                                                                                                                                | [packages/play-view/src/errors.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/errors.ts#L36) |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play/src/errors.ts#L66)           |
+| <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack)                     | -                                                                                                                                    |
+| <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | -                                                                                                                                    |
+
+## Methods
+
+### captureStackTrace()
+
+```ts
+static captureStackTrace(targetObject, constructorOpt?): void;
+```
+
+Defined in: `@types/node`
+
+Creates a `.stack` property on `targetObject`, which when accessed returns
+a string representing the location in the code at which
+`Error.captureStackTrace()` was called.
+
+```js
+const myObject = {};
+Error.captureStackTrace(myObject);
+myObject.stack; // Similar to `new Error().stack`
+```
+
+The first line of the trace will be prefixed with
+`${myObject.name}: ${myObject.message}`.
+
+The optional `constructorOpt` argument accepts a function. If given, all frames
+above `constructorOpt`, including `constructorOpt`, will be omitted from the
+generated stack trace.
+
+The `constructorOpt` argument is useful for hiding implementation
+details of error generation from the user. For instance:
+
+```js
+function a() {
+	b();
+}
+
+function b() {
+	c();
+}
+
+function c() {
+	// Create an error without stack trace to avoid calculating the stack trace twice.
+	const { stackTraceLimit } = Error;
+	Error.stackTraceLimit = 0;
+	const error = new Error();
+	Error.stackTraceLimit = stackTraceLimit;
+
+	// Capture the stack trace above function b
+	Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
+	throw error;
+}
+
+a();
+```
+
+#### Parameters
+
+| Parameter         | Type       |
+| ----------------- | ---------- |
+| `targetObject`    | `object`   |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`PlayError`](../../../play/errors/classes/PlayError.md).[`captureStackTrace`](../../../play/errors/classes/PlayError.md#capturestacktrace)
+
+---
+
+### isError()
+
+```ts
+static isError(error): error is Error;
+```
+
+Defined in: `typescript`
+
+Indicates whether the argument provided is a built-in Error instance or not.
+
+#### Parameters
+
+| Parameter | Type      |
+| --------- | --------- |
+| `error`   | `unknown` |
+
+#### Returns
+
+`error is Error`
+
+#### Inherited from
+
+[`PlayError`](../../../play/errors/classes/PlayError.md).[`isError`](../../../play/errors/classes/PlayError.md#iserror)
+
+---
+
+### prepareStackTrace()
+
+```ts
+static prepareStackTrace(err, stackTraces): any;
+```
+
+Defined in: `@types/node`
+
+#### Parameters
+
+| Parameter     | Type         |
+| ------------- | ------------ |
+| `err`         | `Error`      |
+| `stackTraces` | `CallSite`[] |
+
+#### Returns
+
+`any`
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+[`PlayError`](../../../play/errors/classes/PlayError.md).[`prepareStackTrace`](../../../play/errors/classes/PlayError.md#preparestacktrace)

package/api/@xmachines/play-view/index/README.md

@@ -0,0 +1,55 @@
+[API](../../../README.md) / [@xmachines/play-view](../README.md) / index
+
+# index
+
+@xmachines/play-view - the shared view half of every renderer of the Play Architecture
+
+A renderer of a framework is two things: the view lifecycle, and the code that binds
+that lifecycle to the effects of the framework. This package holds the first one, and
+`@xmachines/play-react`, `@xmachines/play-vue`, `@xmachines/play-solid`,
+`@xmachines/play-svelte` and `@xmachines/play-dom` hold the second one.
+
+It also holds `Viewable` and `PlaySpec`. Every type here names a type of
+`@xmachines/json-render-core`, and that is why they are here and not in
+`@xmachines/play-actor`: an application that routes and renders no view installs this
+package never, and json-render never.
+
+## See
+
+[Play RFC](../../../../rfc/play.md)
+
+## Interfaces
+
+- [BaseActorProviderProps](interfaces/BaseActorProviderProps.md)
+- [BaseViewContextValue](interfaces/BaseViewContextValue.md)
+- [FailureLatch](interfaces/FailureLatch.md)
+- [PlaySpec](interfaces/PlaySpec.md)
+- [ReportGuard](interfaces/ReportGuard.md)
+- [ReportGuardMessages](interfaces/ReportGuardMessages.md)
+- [ResolveViewStoreOptions](interfaces/ResolveViewStoreOptions.md)
+- [Viewable](interfaces/Viewable.md)
+- [ViewInputs](interfaces/ViewInputs.md)
+- [ViewStoreLifecycle](interfaces/ViewStoreLifecycle.md)
+- [ViewStoreResolution](interfaces/ViewStoreResolution.md)
+
+## Type Aliases
+
+- [ViewActor](type-aliases/ViewActor.md)
+
+## Variables
+
+- [CONTEXT\_STATE\_KEY](variables/CONTEXT_STATE_KEY.md)
+
+## Functions
+
+- [attachRenderErrorHandler](functions/attachRenderErrorHandler.md)
+- [composePlayState](functions/composePlayState.md)
+- [createFailureLatch](functions/createFailureLatch.md)
+- [createReportGuard](functions/createReportGuard.md)
+- [createViewStoreLifecycle](functions/createViewStoreLifecycle.md)
+- [guardContextWrites](functions/guardContextWrites.md)
+- [refreshContextSubtree](functions/refreshContextSubtree.md)
+- [reuseComposedState](functions/reuseComposedState.md)
+- [sameViewInputs](functions/sameViewInputs.md)
+- [toAtomState](functions/toAtomState.md)
+- [typedSpec](functions/typedSpec.md)

package/api/@xmachines/{play-actor → play-view/index}/functions/attachRenderErrorHandler.md

@@ -1,4 +1,4 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / attachRenderErrorHandler
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / attachRenderErrorHandler
 
 # Function: attachRenderErrorHandler()
 
@@ -6,7 +6,7 @@
 function attachRenderErrorHandler<TRegistry>(registry, handler): TRegistry;
 ```
 
-Defined in: [packages/play-actor/src/provider-guards.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/provider-guards.ts#L68)
+Defined in: [packages/play-view/src/provider-guards.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/provider-guards.ts#L68)
 
 Copies a component registry, and puts an `onRenderError` handler into the copy.
 
@@ -29,10 +29,10 @@ between the providers in a safe way.
 
 ## Parameters
 
-| Parameter  | Type                                                                      | Description                                                                                          |
-| ---------- | ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
-| `registry` | `TRegistry`                                                               | The component registry from `defineRegistry().registry`.                                             |
-| `handler`  | [`RenderErrorHandler`](../../play-dom/type-aliases/RenderErrorHandler.md) | The renderer calls it with `(error, componentName)` when a catalog component throws during a render. |
+| Parameter  | Type                                                                         | Description                                                                                          |
+| ---------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| `registry` | `TRegistry`                                                                  | The component registry from `defineRegistry().registry`.                                             |
+| `handler`  | [`RenderErrorHandler`](../../../play-dom/type-aliases/RenderErrorHandler.md) | The renderer calls it with `(error, componentName)` when a catalog component throws during a render. |
 
 ## Returns
 

package/api/@xmachines/{play-actor → play-view/index}/functions/composePlayState.md

@@ -1,4 +1,4 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / composePlayState
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / composePlayState
 
 # Function: composePlayState()
 
@@ -6,7 +6,7 @@
 function composePlayState(authoredState, slice): Record<string, unknown> | undefined;
 ```
 
-Defined in: [packages/play-actor/src/context-projection.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/context-projection.ts#L228)
+Defined in: [packages/play-view/src/context-projection.ts:206](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/context-projection.ts#L206)
 
 Composes the effective state of a view: the authored `spec.state` and the
 `/context` slice.

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

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

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

@@ -0,0 +1,26 @@
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / createReportGuard
+
+# Function: createReportGuard()
+
+```ts
+function createReportGuard(messages): ReportGuard;
+```
+
+Defined in: [packages/play-view/src/failure-latch.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/failure-latch.ts#L134)
+
+Makes a [ReportGuard](../interfaces/ReportGuard.md).
+
+The flag SAVES and restores, and it is no plain `false` at the end: a handler of the
+host can start a second contained failure inside the first — a fallback that throws, a
+write of the store that drives another emission — and a bare reset in the inner
+`finally` would clear the guard while the outer report still runs.
+
+## Parameters
+
+| Parameter  | Type                                                          | Description                                                                                                                                                                       |
+| ---------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `messages` | [`ReportGuardMessages`](../interfaces/ReportGuardMessages.md) | See [ReportGuardMessages](../interfaces/ReportGuardMessages.md). The two messages say what the guard writes to `console.error`, and the absence of one says what it lets through. |
+
+## Returns
+
+[`ReportGuard`](../interfaces/ReportGuard.md)

package/api/@xmachines/{play-actor → play-view/index}/functions/createViewStoreLifecycle.md

@@ -1,4 +1,4 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / createViewStoreLifecycle
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / createViewStoreLifecycle
 
 # Function: createViewStoreLifecycle()
 
@@ -6,7 +6,7 @@
 function createViewStoreLifecycle(createStore): ViewStoreLifecycle;
 ```
 
-Defined in: [packages/play-actor/src/view-store-lifecycle.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L94)
+Defined in: [packages/play-view/src/view-store-lifecycle.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/view-store-lifecycle.ts#L94)
 
 Creates a coordinator of the lifecycle.
 

package/api/@xmachines/{play-actor → play-view/index}/functions/guardContextWrites.md

@@ -1,4 +1,4 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / guardContextWrites
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / guardContextWrites
 
 # Function: guardContextWrites()
 
@@ -6,7 +6,7 @@
 function guardContextWrites(store): StateStore;
 ```
 
-Defined in: [packages/play-actor/src/context-projection.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/context-projection.ts#L151)
+Defined in: [packages/play-view/src/context-projection.ts:132](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/context-projection.ts#L132)
 
 Wraps a StateStore, and the wrapper refuses each write under `/context`.
 

package/api/@xmachines/{play-actor → play-view/index}/functions/refreshContextSubtree.md

@@ -1,4 +1,4 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / refreshContextSubtree
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / refreshContextSubtree
 
 # Function: refreshContextSubtree()
 
@@ -6,7 +6,7 @@
 function refreshContextSubtree(store, view): void;
 ```
 
-Defined in: [packages/play-actor/src/context-projection.ts:210](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/context-projection.ts#L210)
+Defined in: [packages/play-view/src/context-projection.ts:188](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/context-projection.ts#L188)
 
 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-actor → play-view/index}/functions/reuseComposedState.md

@@ -1,4 +1,4 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / reuseComposedState
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / reuseComposedState
 
 # Function: reuseComposedState()
 
@@ -6,7 +6,7 @@
 function reuseComposedState(prev, next): PlaySpec | null;
 ```
 
-Defined in: [packages/play-actor/src/context-projection.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/context-projection.ts#L92)
+Defined in: [packages/play-view/src/context-projection.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/context-projection.ts#L73)
 
 Reuses the composed `state` of the previous emission, or the complete previous
 spec, when the value of the projection did not change.
@@ -16,7 +16,7 @@ on each call, and the XState function `assign` makes a new context object on
 every event. Without this reuse, every event therefore presents a new `state`
 reference, and the `Object.is` test of each field in the emit gate emits the view
 again and remounts it, without an end. The function compares the slices field by
-field ([shallowEqualExcept](shallowEqualExcept.md)), because the XState function `assign` makes a
+field ([shallowEqualExcept](../../../play/index/functions/shallowEqualExcept.md)), because the XState function `assign` makes a
 new context object for each event, and a test of the identity of the whole object
 therefore reports a change every time. The authored fields come from the static
 `meta.view.state` through a spread. Therefore their references are stable for an

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

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

package/api/@xmachines/{play-actor → play-view/index}/functions/toAtomState.md

@@ -1,4 +1,4 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / toAtomState
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / toAtomState
 
 # Function: toAtomState()
 
@@ -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-view/src/provider-guards.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/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 → play-view/index}/functions/typedSpec.md

@@ -1,4 +1,4 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / typedSpec
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / typedSpec
 
 # Function: typedSpec()
 
@@ -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-view/src/view-types.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/view-types.ts#L76)
 
 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-view/index/interfaces/BaseActorProviderProps.md

@@ -0,0 +1,49 @@
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / BaseActorProviderProps
+
+# Interface: BaseActorProviderProps\<TRegistry, TActor\>
+
+Defined in: [packages/play-view/src/view-types.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/view-types.ts#L164)
+
+The framework-agnostic base props. Every `ActorProvider` implementation shares
+them: React, Vue, Solid, and Svelte. `TRegistry` holds the
+`DefineRegistryResult` type of the framework. `RenderErrorHandler` comes from
+`@xmachines/json-render-core`, and a second generic parameter is therefore not
+necessary.
+
+Each framework package extends this interface with its `fallback` field, its
+`onError` field, and its `children` field.
+
+## Example
+
+```ts
+import type { BaseActorProviderProps, ViewActor } from "@xmachines/play-view";
+import type { DefineRegistryResult } from "@xmachines/json-render-react";
+
+interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult> {
+	fallback?: React.ReactNode;
+	children: React.ReactNode;
+}
+```
+
+## Extended by
+
+- [`ActorProviderProps`](../../../play-react/interfaces/ActorProviderProps.md)
+- [`ActorProviderProps`](../../../play-solid/interfaces/ActorProviderProps.md)
+- [`ActorProviderProps`](../../../play-svelte/interfaces/ActorProviderProps.md)
+- [`ActorProviderProps`](../../../play-vue/interfaces/ActorProviderProps.md)
+
+## Type Parameters
+
+| Type Parameter                                                 | Default type                                | Description                                       |
+| -------------------------------------------------------------- | ------------------------------------------- | ------------------------------------------------- |
+| `TRegistry` _extends_ `object`                                 | -                                           | The `DefineRegistryResult` type of the framework. |
+| `TActor` _extends_ [`ViewActor`](../type-aliases/ViewActor.md) | [`ViewActor`](../type-aliases/ViewActor.md) | -                                                 |
+
+## Properties
+
+| Property                                              | Type                                                                         | Description                                                                                                                                                                                                                                                                       | Defined in                                                                                                                                     |
+| ----------------------------------------------------- | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`                   | `TActor`                                                                     | The actor instance with the currentView signal. It requires the Viewable capability.                                                                                                                                                                                              | [packages/play-view/src/view-types.ts:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/view-types.ts#L169) |
+| <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:183](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/view-types.ts#L183) |
+| <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:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/view-types.ts#L171) |
+| <a id="property-store"></a> `store?`                  | `StateStore`                                                                 | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [packages/play-view/src/view-types.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/view-types.ts#L178) |

package/api/@xmachines/{play-actor → play-view/index}/interfaces/BaseViewContextValue.md

@@ -1,8 +1,8 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / BaseViewContextValue
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / BaseViewContextValue
 
 # 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-view/src/view-types.ts:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/view-types.ts#L108)
 
 The framework-agnostic base of the `ViewContextValue` type in each framework.
 
@@ -13,10 +13,10 @@ same generic parameter as in `BaseActorProviderProps`.
 
 ## Extended by
 
-- [`ViewContextValue`](../../play-react/interfaces/ViewContextValue.md)
-- [`ViewContextValue`](../../play-solid/interfaces/ViewContextValue.md)
-- [`ViewContextValue`](../../play-svelte/interfaces/ViewContextValue.md)
-- [`ViewContextValue`](../../play-vue/interfaces/ViewContextValue.md)
+- [`ViewContextValue`](../../../play-react/interfaces/ViewContextValue.md)
+- [`ViewContextValue`](../../../play-solid/interfaces/ViewContextValue.md)
+- [`ViewContextValue`](../../../play-svelte/interfaces/ViewContextValue.md)
+- [`ViewContextValue`](../../../play-vue/interfaces/ViewContextValue.md)
 
 ## Type Parameters
 
@@ -26,9 +26,9 @@ same generic parameter as in `BaseActorProviderProps`.
 
 ## Properties
 
-| 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) |
+| 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:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/view-types.ts#L112) |
+| <a id="property-registry"></a> `registry` | `TRegistry`                           | The component registry, from registryResult.registry.                                                                  | [packages/play-view/src/view-types.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/view-types.ts#L114) |
+| <a id="property-spec"></a> `spec`         | [`PlaySpec`](PlaySpec.md)             | The current PlaySpec to render.                                                                                        | [packages/play-view/src/view-types.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/view-types.ts#L110) |
+| <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:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-view/src/view-types.ts#L118) |