@xmachines/docs 5.0.2 → 6.1.0

package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md

@@ -6,7 +6,7 @@
 type URLPatternCtor = (init) => URLPatternLike;
 ```
 
-Defined in: [packages/play-url/src/url-pattern-utils.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L59)
+Defined in: [packages/play-url/src/url-pattern-utils.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/url-pattern-utils.ts#L59)
 
 The constructor type of a URLPatternLike instance.
 

package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md

@@ -6,7 +6,7 @@
 type URLPatternLike = object;
 ```
 
-Defined in: [packages/play-url/src/url-pattern-utils.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L51)
+Defined in: [packages/play-url/src/url-pattern-utils.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/url-pattern-utils.ts#L51)
 
 The minimal structural type of the part of URLPattern that this package uses.
 
@@ -28,7 +28,7 @@ exec(input):
   | null;
 ```
 
-Defined in: [packages/play-url/src/url-pattern-utils.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L52)
+Defined in: [packages/play-url/src/url-pattern-utils.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/url-pattern-utils.ts#L52)
 
 #### Parameters
 
@@ -54,7 +54,7 @@ Defined in: [packages/play-url/src/url-pattern-utils.ts:52](https://gitlab.com/x
 test(input): boolean;
 ```
 
-Defined in: [packages/play-url/src/url-pattern-utils.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L55)
+Defined in: [packages/play-url/src/url-pattern-utils.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/url-pattern-utils.ts#L55)
 
 #### Parameters
 

package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md

@@ -6,7 +6,7 @@
 const NO_BASE_PATH: ResolvedBasePath;
 ```
 
-Defined in: [packages/play-url/src/base-path.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/base-path.ts#L106)
+Defined in: [packages/play-url/src/base-path.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L106)
 
 The base path of a bridge that has no `basePath` option.
 

package/api/@xmachines/play-url/index/variables/URLPattern.md

@@ -6,7 +6,7 @@
 const URLPattern: URLPatternCtor;
 ```
 
-Defined in: [packages/play-url/src/url-pattern-utils.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L74)
+Defined in: [packages/play-url/src/url-pattern-utils.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/url-pattern-utils.ts#L74)
 
 The URLPattern constructor that this library uses: the native API when the runtime
 carries one, and the polyfill when it does not.

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

@@ -4,7 +4,7 @@
 
 The shared view half of every renderer of the XMachines Play Architecture.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-5.0.2-blue)](https://www.npmjs.com/package/@xmachines/play-view)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-6.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-view)
 
 ## Installation
 
@@ -15,10 +15,11 @@ pnpm add @xmachines/play-view
 **Peer dependencies.** Install them with the package:
 
 ```bash
-pnpm add @xmachines/json-render-core @xmachines/play @xmachines/play-atom
+pnpm add @xmachines/core @xmachines/json-render-core @xmachines/play @xmachines/play-atom
 ```
 
-- [`@xmachines/play`](../play/README.md) — the core protocol. This package reads `shallowEqualExcept` from it.
+- [`@xmachines/core`](../core/README.md) — the base package. This package reads the helpers of its `utils` subpath.
+- [`@xmachines/play`](../play/README.md) — the core protocol. This package reads the error classes from its `errors` subpath.
 - [`@xmachines/play-atom`](../play-atom/README.md) — the atom primitives. The view store holds the spec in a `ReadonlyAtom`.
 - `@xmachines/json-render-core` — the spec type that `PlaySpec` extends.
 
@@ -30,21 +31,23 @@ A renderer of a framework is two things: the view lifecycle, and the code that b
 
 It also holds `Viewable` and `PlaySpec`. Every type here names a type of `@xmachines/json-render-core`, and that is the reason they are here and not in [`@xmachines/play-actor`](../play-actor/README.md): an application that routes and renders no view installs this package never, and json-render never.
 
-| Export                                           | Description                                                           |
-| ------------------------------------------------ | --------------------------------------------------------------------- |
-| `Viewable`                                       | The capability of an actor that publishes a `currentView` atom        |
-| `PlaySpec`, `typedSpec`                          | The spec that an actor publishes, and its identity helper             |
-| `BaseActorProviderProps`, `BaseViewContextValue` | The framework-free half of the props and of the context of a provider |
-| `createViewStoreLifecycle`                       | The lifecycle of the state store of one view                          |
-| `createFailureLatch`, `createReportGuard`        | The report of a render failure, one time for each view                |
-| `toAtomState`, `attachRenderErrorHandler`        | The guards that a provider puts around a registry                     |
-| `composePlayState`, `refreshContextSubtree`, …   | The projection of the machine context into the store                  |
+| Export                                           | Description                                                            |
+| ------------------------------------------------ | ---------------------------------------------------------------------- |
+| `Viewable`                                       | The capability of an actor that publishes a `currentView` atom         |
+| `ViewMeta`, `typedSpec`                          | The view that an author writes in `meta.view`, and its identity helper |
+| `PlaySpec`                                       | The spec that an actor publishes, and that a renderer receives         |
+| `ViewOutlet`, `composeViews`                     | The composition of a parent view and the views of its substates        |
+| `BaseActorProviderProps`, `BaseViewContextValue` | The framework-free half of the props and of the context of a provider  |
+| `createViewStoreLifecycle`                       | The lifecycle of the state store of one view                           |
+| `createFailureLatch`, `createReportGuard`        | The report of a render failure, one time for each view                 |
+| `toAtomState`, `attachRenderErrorHandler`        | The guards that a provider puts around a registry                      |
+| `composePlayState`, `refreshContextSubtree`, …   | The projection of the machine context into the store                   |
 
 ## API Summary
 
 ### `typedSpec(spec)`
 
-This identity helper gives a view-spec literal the type `PlaySpec` at the definition site. The
+This identity helper gives a view-spec literal the type `ViewMeta` at the definition site. The
 XState `meta` field has the type `Record<string, unknown>`. Therefore this helper is the place
 where the spec shape receives the compile-time check and the IDE autocomplete. The helper has no
 cost at run time.
@@ -67,9 +70,14 @@ meta: {
 }
 ```
 
-### `PlaySpec`
+### `ViewMeta` and `PlaySpec`
 
-This type extends the `Spec` type of `@xmachines/json-render-core`. Each derived view receives
+`ViewMeta` is the view that you write in `meta.view`: the `Spec` type of
+`@xmachines/json-render-core`, and the `outlets` of a parent view. `PlaySpec` is the view that the
+actor derives from it, and that a renderer receives: it carries `viewKey`, the `/context`
+projection, and `viewParts` for a composed view, and no `outlets`.
+
+`PlaySpec` extends the `Spec` type of `@xmachines/json-render-core`. Each derived view receives
 the complete machine context in its state store, under the read-only **`/context` subtree**. A
 spec therefore reads the context through the ordinary `{ $state: "/context/…" }` grammar: in a
 prop, in a `visible` condition, and in `repeat.statePath`.
@@ -98,9 +106,9 @@ high-frequency ephemeral data, such as a draft for each keystroke or a timer, in
 keystroke does not.
 
 ```ts
-import type { PlaySpec } from "@xmachines/play-view";
+import type { ViewMeta } from "@xmachines/play-view";
 
-const spec: PlaySpec = {
+const spec: ViewMeta = {
 	root: "root",
 	elements: {
 		root: {
@@ -112,16 +120,40 @@ const spec: PlaySpec = {
 };
 ```
 
-> Historical note: an earlier version had a `contextProps` field. At first the field drove an
-> implicit prop-enrichment pass. That pass merged the allowlisted context fields and the URL
-> params into the props of every element. We removed it, because it put values into components
-> that never asked for them, and it let URL data from the user hide machine-owned state. The
-> field was then a projection filter for a short time. We removed that filter too, because a
-> limit on what a view can read added machinery without a real problem to solve. Always
-> validate the **derived** view (`actor.currentView.get()`), not the raw `meta.view`. The
+> Always validate the **derived** view (`actor.currentView.get()`), not the raw `meta.view`. The
 > `state` of the derived spec carries the projection, so a tool such as `validateSpec` sees a
 > spec that is consistent with itself.
 
+### `outlets` and `composeViews(tree)`
+
+A `meta.view` that declares `outlets` shares the screen with the views of its active substates.
+Each outlet is a `ViewOutlet`: the `element` of the parent view that receives the view of a
+child, and an optional named `slot` of that element. Without `slot`, the child view goes into the
+`children` of the element.
+
+```ts
+outlets: {
+	menu: { element: "shell", slot: "sidebar" }, // the child state "menu"
+	"*": { element: "shell" }, //                 every other active child
+}
+```
+
+The view derivation of [`@xmachines/play-xstate`](../play-xstate/README.md) resolves the active
+views into a `ViewTree`, and `composeViews` grafts that tree into one flat spec. The keys of the
+outer view stay as the author wrote them, and each key of a child view gets the id of its state
+as a prefix (`"app.page/root"`). The function returns the same object for the same tree, so the
+emit gate of the actor sees no change on a context assign. An outlet that names an absent element
+throws `InvalidViewOutletError` from `@xmachines/play-view/errors`.
+
+A composed spec carries `viewParts`, the ids of the composed states, and its `viewKey` is the id
+of the outermost view. `createViewStoreLifecycle` therefore keeps the store when a page changes,
+and it writes the authored keys of the new page that the store does not hold yet. In the
+controlled mode, the caller owns the seed, so the lifecycle writes no authored key. It refreshes
+`/context` only.
+
+The [State Machines guide](../../../guides/state-machines.md#a-layout-and-its-pages-outlets)
+shows a complete machine.
+
 ### `Viewable`
 
 Interface for actors that expose a renderable view atom.

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

@@ -4,7 +4,7 @@
 
 The errors of the view half.
 
-Every error of this workspace extends `PlayError` of `@xmachines/play`, and it carries
+Every error of a Play package extends `PlayError` of `@xmachines/play`, and it carries
 a `scope` and a `code` that stay the same across a patch release and a minor release.
 Match on the `code`, or on the class. Match on the `message` never.
 
@@ -14,4 +14,5 @@ Match on the `code`, or on the class. Match on the `message` never.
 
 ## Classes
 
+- [InvalidViewOutletError](classes/InvalidViewOutletError.md)
 - [ReadOnlyContextError](classes/ReadOnlyContextError.md)

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

@@ -0,0 +1,204 @@
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [errors](../README.md) / InvalidViewOutletError
+
+# Class: InvalidViewOutletError
+
+Defined in: [packages/play-view/src/errors.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/errors.ts#L81)
+
+An outlet of a `meta.view` names an element that the view does not hold.
+
+The view derivation puts the view of a child state into the element that the outlet
+names. With no such element, the child view has no place on the screen, so the
+derivation refuses the composition. The actor reports the error through its `onError`
+option and keeps the last good view.
+
+## Example
+
+```typescript
+import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
+import { withView } from "@xmachines/play-xstate/view";
+import { InvalidViewOutletError } from "@xmachines/play-view/errors";
+
+const createPlayer = definePlayer({
+	machine,
+	actor: compose(PlayerActor, withView),
+	options: {
+		onError: (_actor, error) => {
+			if (error instanceof InvalidViewOutletError) {
+				console.error(`Fix meta.view.outlets of "${error.stateId}"`);
+			}
+		},
+	},
+});
+```
+
+## Extends
+
+- [`PlayError`](../../../play/errors/classes/PlayError.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new InvalidViewOutletError(
+   stateId,
+   outlet,
+   element
+): InvalidViewOutletError;
+```
+
+Defined in: [packages/play-view/src/errors.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/errors.ts#L92)
+
+#### Parameters
+
+| Parameter | Type     | Description                                        |
+| --------- | -------- | -------------------------------------------------- |
+| `stateId` | `string` | The id of the state node that declares the outlet. |
+| `outlet`  | `string` | The key of the outlet.                             |
+| `element` | `string` | The element key that the outlet names.             |
+
+#### Returns
+
+`InvalidViewOutletError`
+
+#### 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 `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code 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/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L56)           |
+| <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-outlet"></a> `outlet`                   | `readonly` | `string`  | The key of the outlet: a child state key, or `"*"`.                                                                                                                                                                                                                                                                                                                                                                                               | -                                                                                                                                                | [packages/play-view/src/errors.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/errors.ts#L85) |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L46)           |
+| <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-stateid"></a> `stateId`                 | `readonly` | `string`  | The id of the state node whose `meta.view` declares the outlet.                                                                                                                                                                                                                                                                                                                                                                                   | -                                                                                                                                                | [packages/play-view/src/errors.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/errors.ts#L83) |
+| <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/errors/classes/ReadOnlyContextError.md

@@ -2,7 +2,7 @@
 
 # Class: ReadOnlyContextError
 
-Defined in: [packages/play-view/src/errors.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/errors.ts#L34)
+Defined in: [packages/play-view/src/errors.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/errors.ts#L34)
 
 A write reached the context projection of the view store.
 
@@ -37,7 +37,7 @@ try {
 new ReadOnlyContextError(path, stateKey): ReadOnlyContextError;
 ```
 
-Defined in: [packages/play-view/src/errors.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/errors.ts#L42)
+Defined in: [packages/play-view/src/errors.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/errors.ts#L42)
 
 #### Parameters
 
@@ -59,11 +59,11 @@ Defined in: [packages/play-view/src/errors.ts:42](https://gitlab.com/xmachin-es/
 | 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/v5.0.2/packages/play/src/errors.ts#L76)           |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code 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/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L56)           |
 | <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/v5.0.2/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/v5.0.2/packages/play/src/errors.ts#L66)           |
+| <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/v6.1.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 `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L46)           |
 | <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) | -                                                                                                                                    |
 

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

@@ -22,6 +22,7 @@ package never, and json-render never.
 
 - [BaseActorProviderProps](interfaces/BaseActorProviderProps.md)
 - [BaseViewContextValue](interfaces/BaseViewContextValue.md)
+- [ComposedView](interfaces/ComposedView.md)
 - [FailureLatch](interfaces/FailureLatch.md)
 - [PlaySpec](interfaces/PlaySpec.md)
 - [ReportGuard](interfaces/ReportGuard.md)
@@ -29,8 +30,12 @@ package never, and json-render never.
 - [ResolveViewStoreOptions](interfaces/ResolveViewStoreOptions.md)
 - [Viewable](interfaces/Viewable.md)
 - [ViewInputs](interfaces/ViewInputs.md)
+- [ViewMeta](interfaces/ViewMeta.md)
+- [ViewOutlet](interfaces/ViewOutlet.md)
 - [ViewStoreLifecycle](interfaces/ViewStoreLifecycle.md)
 - [ViewStoreResolution](interfaces/ViewStoreResolution.md)
+- [ViewTree](interfaces/ViewTree.md)
+- [ViewTreeChild](interfaces/ViewTreeChild.md)
 
 ## Type Aliases
 
@@ -44,6 +49,7 @@ package never, and json-render never.
 
 - [attachRenderErrorHandler](functions/attachRenderErrorHandler.md)
 - [composePlayState](functions/composePlayState.md)
+- [composeViews](functions/composeViews.md)
 - [createFailureLatch](functions/createFailureLatch.md)
 - [createReportGuard](functions/createReportGuard.md)
 - [createViewStoreLifecycle](functions/createViewStoreLifecycle.md)

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

@@ -6,7 +6,7 @@
 function attachRenderErrorHandler<TRegistry>(registry, handler): TRegistry;
 ```
 
-Defined in: [packages/play-view/src/provider-guards.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/provider-guards.ts#L68)
+Defined in: [packages/play-view/src/provider-guards.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/provider-guards.ts#L68)
 
 Copies a component registry, and puts an `onRenderError` handler into the copy.
 

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

@@ -6,7 +6,7 @@
 function composePlayState(authoredState, slice): Record<string, unknown> | undefined;
 ```
 
-Defined in: [packages/play-view/src/context-projection.ts:208](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/context-projection.ts#L208)
+Defined in: [packages/play-view/src/context-projection.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/context-projection.ts#L203)
 
 Composes the effective state of a view: the authored `spec.state` and the
 `/context` slice.

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

@@ -0,0 +1,35 @@
+[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / composeViews
+
+# Function: composeViews()
+
+```ts
+function composeViews(tree): ComposedView;
+```
+
+Defined in: [packages/play-view/src/compose-views.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/compose-views.ts#L180)
+
+Grafts the views of a [ViewTree](../interfaces/ViewTree.md) into one flat spec.
+
+Each child view goes into the outlet of its key, or into the `"*"` outlet. A child
+with neither outlet stays off the screen. The child root lands at the END of the
+`children` or of the named slot of the outlet element, after the elements that the
+parent put there itself, and the children of a parallel state land in the order of
+the machine.
+
+The function returns the SAME object for the same tree of the same view objects.
+
+## Parameters
+
+| Parameter | Type                                    | Description                                                        |
+| --------- | --------------------------------------- | ------------------------------------------------------------------ |
+| `tree`    | [`ViewTree`](../interfaces/ViewTree.md) | The resolved views, from the outermost view that declares outlets. |
+
+## Returns
+
+[`ComposedView`](../interfaces/ComposedView.md)
+
+The static half of the composed view.
+
+## Throws
+
+When an outlet names an element that its view does not hold.

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

@@ -6,7 +6,7 @@
 function createFailureLatch(): FailureLatch;
 ```
 
-Defined in: [packages/play-view/src/failure-latch.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/failure-latch.ts#L202)
+Defined in: [packages/play-view/src/failure-latch.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L202)
 
 Makes a [FailureLatch](../interfaces/FailureLatch.md).
 

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/v5.0.2/packages/play-view/src/failure-latch.ts#L134)
+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)
 
 Makes a [ReportGuard](../interfaces/ReportGuard.md).
 

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:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/view-store-lifecycle.ts#L94)
+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)
 
 Creates a coordinator of the lifecycle.
 

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:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/context-projection.ts#L137)
+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)
 
 ## 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:190](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/context-projection.ts#L190)
+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)
 
 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:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-view/src/context-projection.ts#L73)
+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)
 
 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](../../../play/index/functions/shallowEqualExcept.md)), because the XState function `assign` makes a
+field ([shallowEqualExcept](../../../core/utils/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