@xmachines/docs 4.0.0 → 5.0.0

package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md

@@ -0,0 +1,207 @@
+[API](../../../../README.md) / [@xmachines/play-xstate](../../README.md) / [errors](../README.md) / InvalidRouteParamError
+
+# Class: InvalidRouteParamError
+
+Defined in: [packages/play-xstate/src/errors.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/errors.ts#L100)
+
+`buildRouteUrl()` throws this error when a route parameter carries a value that no path
+can hold, so the template matches the built URL back never.
+
+A dot segment is that value. A URL parser resolves `.` and `..` BEFORE it decodes the
+percent escapes, and it counts `%2e` as the dot, so every encoding of them resolves
+away: `/files/..` becomes `/`. The actor would hold the route `/files/..` while the
+address bar shows `/`, and the two stay out of step for the rest of the session.
+
+Give the param a value that names a segment. Machine state that can carry a path from a
+user belongs behind a check of its own, in the same way that a base path checks the
+values of its `:param` segments.
+
+**Error code:** `PLAY_XSTATE_ROUTE_PARAM_INVALID`
+
+## Example
+
+```typescript
+import { buildRouteUrl } from "@xmachines/play-xstate/routing";
+import { InvalidRouteParamError } from "@xmachines/play-xstate/errors";
+
+try {
+	buildRouteUrl("/files/:name", { params: { name: ".." }, query: {} });
+} catch (err) {
+	if (err instanceof InvalidRouteParamError) {
+		console.error(`"${err.value}" cannot stand in "${err.param}"`);
+	}
+}
+```
+
+## Extends
+
+- [`PlayError`](../../../play/errors/classes/PlayError.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new InvalidRouteParamError(
+   param,
+   value,
+   template
+): InvalidRouteParamError;
+```
+
+Defined in: [packages/play-xstate/src/errors.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/errors.ts#L110)
+
+#### Parameters
+
+| Parameter  | Type     |
+| ---------- | -------- |
+| `param`    | `string` |
+| `value`    | `string` |
+| `template` | `string` |
+
+#### Returns
+
+`InvalidRouteParamError`
+
+#### 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/v5.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-param"></a> `param`                     | `readonly` | `string`  | The name of the route parameter that carries the value, for example `"name"`.                                                                                                                                                                                                                                                                                                                                                                     | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/errors.ts#L102) |
+| <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.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-template"></a> `template`               | `readonly` | `string`  | The route template that declares the parameter, for example `"/files/:name"`.                                                                                                                                                                                                                                                                                                                                                                     | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/errors.ts#L108) |
+| <a id="property-value"></a> `value`                     | `readonly` | `string`  | The value that no path can hold, for example `".."`.                                                                                                                                                                                                                                                                                                                                                                                              | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/errors.ts#L105) |
+| <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-xstate/errors/classes/MissingRouteParamError.md

@@ -2,7 +2,7 @@
 
 # Class: MissingRouteParamError
 
-Defined in: [packages/play-xstate/src/errors.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/errors.ts#L52)
+Defined in: [packages/play-xstate/src/errors.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/errors.ts#L52)
 
 `buildRouteUrl()` throws this error when the context of the actor does not hold a
 necessary route parameter.
@@ -43,7 +43,7 @@ try {
 new MissingRouteParamError(param, template): MissingRouteParamError;
 ```
 
-Defined in: [packages/play-xstate/src/errors.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/errors.ts#L59)
+Defined in: [packages/play-xstate/src/errors.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/errors.ts#L59)
 
 #### Parameters
 
@@ -65,13 +65,13 @@ Defined in: [packages/play-xstate/src/errors.ts:59](https://gitlab.com/xmachin-e
 | 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-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.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-param"></a> `param`                     | `readonly` | `string`  | The name of the route parameter that was absent, for example `"userId"`.                                                                                                                                                                                                                                                                                                                                                                          | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/errors.ts#L54) |
-| <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-param"></a> `param`                     | `readonly` | `string`  | The name of the route parameter that was absent, for example `"userId"`.                                                                                                                                                                                                                                                                                                                                                                          | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/errors.ts#L54) |
+| <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.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-template"></a> `template`               | `readonly` | `string`  | The route template that needs the absent parameter, for example `"/profile/:userId"`.                                                                                                                                                                                                                                                                                                                                                             | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/errors.ts#L57) |
+| <a id="property-template"></a> `template`               | `readonly` | `string`  | The route template that needs the absent parameter, for example `"/profile/:userId"`.                                                                                                                                                                                                                                                                                                                                                             | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/errors.ts#L57) |
 | <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

package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md

@@ -2,7 +2,7 @@
 
 # Class: MissingStateIdError
 
-Defined in: [packages/play-xstate/src/errors.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/errors.ts#L102)
+Defined in: [packages/play-xstate/src/errors.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/errors.ts#L154)
 
 `formatPlayRouteTransitions()` throws this error when a state node declares a
 `meta.route` field but no explicit `id` field.
@@ -47,7 +47,7 @@ states: {
 new MissingStateIdError(stateKey, route): MissingStateIdError;
 ```
 
-Defined in: [packages/play-xstate/src/errors.ts:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/errors.ts#L108)
+Defined in: [packages/play-xstate/src/errors.ts:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/errors.ts#L160)
 
 #### Parameters
 
@@ -69,13 +69,13 @@ Defined in: [packages/play-xstate/src/errors.ts:108](https://gitlab.com/xmachin-
 | 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-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.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-route"></a> `route`                     | `readonly` | `string`  | The route template of the state, for example `"/profile/:username"`.                                                                                                                                                                                                                                                                                                                                                                              | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/errors.ts#L106) |
-| <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-route"></a> `route`                     | `readonly` | `string`  | The route template of the state, for example `"/profile/:username"`.                                                                                                                                                                                                                                                                                                                                                                              | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/errors.ts#L158) |
+| <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.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-statekey"></a> `stateKey`               | `readonly` | `string`  | The state key, which is the position in the tree of the states, without an explicit `id` field.                                                                                                                                                                                                                                                                                                                                                   | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/errors.ts#L104) |
+| <a id="property-statekey"></a> `stateKey`               | `readonly` | `string`  | The state key, which is the position in the tree of the states, without an explicit `id` field.                                                                                                                                                                                                                                                                                                                                                   | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/errors.ts#L156) |
 | <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

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

@@ -5,11 +5,11 @@
 @xmachines/play-xstate - the XState v5 adapter of the Play Architecture
 
 This package gives you the definePlayer() API. That function binds an XState state
-machine to the actor base, with the signal lifecycle and the DevTools
+machine to the actor base, with the atom lifecycle and the DevTools
 integration.
 
 The Play RFC gives this package as the adapter of the logic layer. It converts a
-declarative machine definition into a live actor with a signal-driven
+declarative machine definition into a live actor with an atom-driven
 reactivity.
 
 ## Classes

package/api/@xmachines/play-xstate/index/classes/PlayerActor.md

@@ -2,9 +2,9 @@
 
 # Class: PlayerActor\<TMachine\>
 
-Defined in: [packages/play-xstate/src/player-actor.ts:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/player-actor.ts#L160)
+Defined in: [packages/play-xstate/src/player-actor.ts:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/player-actor.ts#L160)
 
-The concrete XState actor. It implements the signal protocol of the Play Architecture
+The concrete XState actor. It implements the atom protocol of the Play Architecture
 
 The class extends the `Actor` class of XState directly, and it implements
 [@xmachines/play-actor!PlayActor](../../../play-actor/interfaces/PlayActor.md). It gives you the XState v5 integration, and it keeps the
@@ -12,7 +12,7 @@ compatibility with the ecosystem, such as the XState inspection and the devtools
 The constructor of the base class receives the machine. Therefore a `PlayerActor`
 **is** the XState actor, and it is no wrapper around one: every member of the
 XState `Actor` class works on the state of this instance, and this class adds the
-reactive state on the TC39 Signals for the observation by the infrastructure.
+reactive state on the atoms for the observation by the infrastructure.
 
 **Capabilities:** the class implements both the
 [@xmachines/play-router!index.Routable](../../../play-router/index/interfaces/Routable.md) interface and the
@@ -21,7 +21,7 @@ routing and the view rendering.
 
 **Architectural context:** the class implements **Actor Authority (INV-01)**,
 because the guards of the XState machine control every decision of the
-navigation. The infrastructure observes the signals of the actor (`state`,
+navigation. The infrastructure observes the atoms of the actor (`state`,
 `currentRoute`, and `currentView`), but it changes no state directly: every
 change goes through the event handlers of the state machine.
 
@@ -53,33 +53,31 @@ const createPlayer = definePlayer({ machine });
 const actor = createPlayer();
 actor.start();
 
-// Observe the signals
+// Observe the atoms
 console.log(actor.currentRoute.get()); // '/'
 console.log(actor.currentView.get()?.root); // 'home'
 ```
 
-The signal lifecycle with a watcher
+The atom lifecycle with a watch
 
 ```typescript
-import { Signal } from "@xmachines/play-signals";
+import { watchAtom } from "@xmachines/play-atom";
 
-const watcher = new Signal.subtle.Watcher(() => {
-	queueMicrotask(() => {
-		const pending = watcher.getPending();
-		console.log("State changed:", actor.state.get());
-	});
+const stop = watchAtom(actor.state, (snapshot) => {
+	console.log("State changed:", snapshot.value);
 });
 
-watcher.watch(actor.state);
 actor.send({ type: "play.route", to: "#about" });
-// The watcher schedules its own notification in a microtask
+// watchAtom delivers the new value from a microtask
+
+stop();
 ```
 
 ## See
 
 - [Play RFC](../../../../../rfc/play.md)
 - [definePlayer](../functions/definePlayer.md) for the creation through a factory
-- [@xmachines/play-actor!PlayActor](../../../play-actor/interfaces/PlayActor.md) for the signal protocol
+- [@xmachines/play-actor!PlayActor](../../../play-actor/interfaces/PlayActor.md) for the atom protocol
 - [@xmachines/play-router!index.Routable](../../../play-router/index/interfaces/Routable.md) for the routing capability
 - [@xmachines/play-view!index.Viewable](../../../play-view/index/interfaces/Viewable.md) for the view rendering capability
 
@@ -90,10 +88,11 @@ also a `play.route` event with parameters. The `deriveRoute()` function reads
 `meta.route`, which is the Stately pattern, for a URL template, and it substitutes
 each parameter.
 
-**The pattern of the view signal:** the `currentView` signal is a direct
-`Signal.State`, and not a `Signal.Computed`. The propagation to a watcher in
-PlayRenderer is therefore correct. The class derives each view at the entry of a
-state and keeps it, and it computes no view on a read.
+**The pattern of the view atom:** `withView` of `@xmachines/play-xstate/view` adds
+`currentView`, and that atom is a COMPUTED atom over `state`. One write for each
+transition — `state.set(snapshot)` — therefore reaches the view and the route in one
+flush, and no subscriber reads the new state beside an old derivation. The atom
+memoizes the result, so a repeated read computes no view again.
 
 ## Extends
 
@@ -122,7 +121,7 @@ new PlayerActor<TMachine>(
 ): PlayerActor<TMachine>;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:258](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/player-actor.ts#L258)
+Defined in: [packages/play-xstate/src/player-actor.ts:258](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/player-actor.ts#L258)
 
 #### Parameters
 
@@ -145,19 +144,19 @@ Actor<TMachine>.constructor
 
 ## Properties
 
-| Property                                    | Modifier | Type                                                                                                                                                                                                                                                                                                                     | Description                                                                                                                                                                                               | Inherited from    | Defined in                                                                                                                                             |
-| ------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-_parent"></a> `_parent?`    | `public` | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef)                                                                                                                                                                                                                                                        | -                                                                                                                                                                                                         | `Actor._parent`   | -                                                                                                                                                      |
-| <a id="property-clock"></a> `clock`         | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock)                                                                                                                                                                                                                                                                    | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions.                                                                                                  | `Actor.clock`     | -                                                                                                                                                      |
-| <a id="property-id"></a> `id`               | `public` | `string`                                                                                                                                                                                                                                                                                                                 | The unique identifier for this actor relative to its parent.                                                                                                                                              | `Actor.id`        | -                                                                                                                                                      |
-| <a id="property-logic"></a> `logic`         | `public` | `TMachine`                                                                                                                                                                                                                                                                                                               | -                                                                                                                                                                                                         | `Actor.logic`     | -                                                                                                                                                      |
-| <a id="property-options"></a> `options`     | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\>                                                                                                                                                                                                                            | -                                                                                                                                                                                                         | `Actor.options`   | -                                                                                                                                                      |
-| <a id="property-ref"></a> `ref`             | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TMachine`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TMachine`\>\> | -                                                                                                                                                                                                         | `Actor.ref`       | -                                                                                                                                                      |
-| <a id="property-sessionid"></a> `sessionId` | `public` | `string`                                                                                                                                                                                                                                                                                                                 | The globally unique process ID for this invocation.                                                                                                                                                       | `Actor.sessionId` | -                                                                                                                                                      |
-| <a id="property-src"></a> `src`             | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)                                                                                                                                                                                                                                     | -                                                                                                                                                                                                         | `Actor.src`       | -                                                                                                                                                      |
-| <a id="property-state"></a> `state`         | `public` | [`State`](../../../play-signals/namespaces/Signal/classes/State.md)\<`ReturnType`\<`TMachine`\[`"transition"`\]\>\>                                                                                                                                                                                                      | The reactive snapshot of the current actor state. The infrastructure observes this signal, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | -                 | [packages/play-xstate/src/player-actor.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/player-actor.ts#L224) |
-| <a id="property-system"></a> `system`       | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem)                                                                                                                                                                                                                                                  | The system to which this actor belongs.                                                                                                                                                                   | `Actor.system`    | -                                                                                                                                                      |
-| <a id="property-systemid"></a> `systemId`   | `public` | `string` \| `undefined`                                                                                                                                                                                                                                                                                                  | -                                                                                                                                                                                                         | `Actor.systemId`  | -                                                                                                                                                      |
+| Property                                    | Modifier | Type                                                                                                                                                                                                                                                                                                                     | Description                                                                                                                                                                                             | Inherited from    | Defined in                                                                                                                                             |
+| ------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-_parent"></a> `_parent?`    | `public` | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef)                                                                                                                                                                                                                                                        | -                                                                                                                                                                                                       | `Actor._parent`   | -                                                                                                                                                      |
+| <a id="property-clock"></a> `clock`         | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock)                                                                                                                                                                                                                                                                    | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions.                                                                                                | `Actor.clock`     | -                                                                                                                                                      |
+| <a id="property-id"></a> `id`               | `public` | `string`                                                                                                                                                                                                                                                                                                                 | The unique identifier for this actor relative to its parent.                                                                                                                                            | `Actor.id`        | -                                                                                                                                                      |
+| <a id="property-logic"></a> `logic`         | `public` | `TMachine`                                                                                                                                                                                                                                                                                                               | -                                                                                                                                                                                                       | `Actor.logic`     | -                                                                                                                                                      |
+| <a id="property-options"></a> `options`     | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\>                                                                                                                                                                                                                            | -                                                                                                                                                                                                       | `Actor.options`   | -                                                                                                                                                      |
+| <a id="property-ref"></a> `ref`             | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TMachine`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TMachine`\>\> | -                                                                                                                                                                                                       | `Actor.ref`       | -                                                                                                                                                      |
+| <a id="property-sessionid"></a> `sessionId` | `public` | `string`                                                                                                                                                                                                                                                                                                                 | The globally unique process ID for this invocation.                                                                                                                                                     | `Actor.sessionId` | -                                                                                                                                                      |
+| <a id="property-src"></a> `src`             | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)                                                                                                                                                                                                                                     | -                                                                                                                                                                                                       | `Actor.src`       | -                                                                                                                                                      |
+| <a id="property-state"></a> `state`         | `public` | [`Atom`](../../../play-atom/interfaces/Atom.md)\<`ReturnType`\<`TMachine`\[`"transition"`\]\>\>                                                                                                                                                                                                                          | The reactive snapshot of the current actor state. The infrastructure observes this atom, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | -                 | [packages/play-xstate/src/player-actor.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/player-actor.ts#L224) |
+| <a id="property-system"></a> `system`       | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem)                                                                                                                                                                                                                                                  | The system to which this actor belongs.                                                                                                                                                                 | `Actor.system`    | -                                                                                                                                                      |
+| <a id="property-systemid"></a> `systemId`   | `public` | `string` \| `undefined`                                                                                                                                                                                                                                                                                                  | -                                                                                                                                                                                                       | `Actor.systemId`  | -                                                                                                                                                      |
 
 ## Methods
 
@@ -167,7 +166,7 @@ Actor<TMachine>.constructor
 dispose: void;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:611](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/player-actor.ts#L611)
+Defined in: [packages/play-xstate/src/player-actor.ts:622](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/player-actor.ts#L622)
 
 Stops the actor when the scope of a `using` declaration ends.
 
@@ -222,12 +221,12 @@ Actor.[observable]
 can(event): boolean;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:237](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/player-actor.ts#L237)
+Defined in: [packages/play-xstate/src/player-actor.ts:237](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/player-actor.ts#L237)
 
 Tells you if the current state of the actor accepts the given event.
 
 The type is the event union of the machine. An unknown event type is therefore a
-compile error. The method evaluates the event against the snapshot signal.
+compile error. The method evaluates the event against the snapshot atom.
 
 #### Parameters
 
@@ -253,7 +252,7 @@ if (actor.can({ type: "auth.logout" })) { ... }
 getPersistedSnapshot(options?): Snapshot<unknown>;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:562](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/player-actor.ts#L562)
+Defined in: [packages/play-xstate/src/player-actor.ts:571](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/player-actor.ts#L571)
 
 Returns the persisted snapshot of this actor.
 
@@ -387,7 +386,7 @@ Actor.select;
 send(event): void;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:439](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/player-actor.ts#L439)
+Defined in: [packages/play-xstate/src/player-actor.ts:448](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/player-actor.ts#L448)
 
 Sends an event to this actor.
 
@@ -439,7 +438,7 @@ Actor.send;
 start(): this;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:365](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/player-actor.ts#L365)
+Defined in: [packages/play-xstate/src/player-actor.ts:374](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/player-actor.ts#L374)
 
 Starts the actor.
 
@@ -467,7 +466,7 @@ Actor.start;
 stop(): this;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:395](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/player-actor.ts#L395)
+Defined in: [packages/play-xstate/src/player-actor.ts:404](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/player-actor.ts#L404)
 
 Stops the actor and cleans up.
 
@@ -498,7 +497,7 @@ Actor.stop;
 subscribe(observer): Subscription;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:500](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/player-actor.ts#L500)
+Defined in: [packages/play-xstate/src/player-actor.ts:509](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/player-actor.ts#L509)
 
 Subscribes to the snapshot updates of this actor.
 
@@ -532,7 +531,7 @@ subscribe(
 ): Subscription;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:511](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-xstate/src/player-actor.ts#L511)
+Defined in: [packages/play-xstate/src/player-actor.ts:520](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-xstate/src/player-actor.ts#L520)
 
 Subscribes to the snapshot updates of this actor.