@xmachines/docs 6.1.0 → 7.1.0

package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md

@@ -10,16 +10,15 @@ Defined in: `@xmachines/json-render-dom`
 
 Hook consulted before executing an action binding that declares `confirm`.
 
-The DOM renderer is headless, so instead of the framework adapters'
-`pendingConfirmation` state (which a dialog component resolves via
-`confirmAction()` / `cancelAction()`), @xmachines/json-render-dom exposes a single async
-callback: return (or resolve) `true` to execute the action, `false` to
-skip it. The confirmation flow — `window.confirm`, a custom dialog, or a
-test stub — is entirely the host's responsibility.
-
-If no `ConfirmHandler` is configured, confirm-gated actions do NOT execute;
-a `console.warn` is emitted instead. This matches the framework adapters,
-where a pending confirmation that is never resolved never runs the handler.
+With this hook, the host owns the confirmation flow — `window.confirm`, a
+custom dialog, or a test stub: return (or resolve) `true` to execute the
+action, `false` to skip it.
+
+Without it, the renderer works as the framework renderers do: the binding
+waits as the pending confirmation of the tree, which a component reads and
+answers through `ctx.confirmation`, and the default confirm dialog shows it
+(`createConfirmDialog`; turn it off with the `confirmDialog: false`
+option). A cancel runs nothing and throws nothing.
 
 ## Parameters
 

package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md

@@ -3,7 +3,7 @@
 # Type Alias: DefineRegistryOptions\<C\>
 
 ```ts
-type DefineRegistryOptions<C> = object & CatalogHasActions<C> extends true ? object : object;
+type DefineRegistryOptions<C> = object & (CatalogHasActions<C> extends true ? object : object);
 ```
 
 Defined in: `@xmachines/json-render-dom`
@@ -14,17 +14,18 @@ Mirrors `DefineRegistryOptions<C>` from @xmachines/json-render-react, /solid, /s
 `actions` accepts catalog-typed async handler functions — params, setState, and state are
 fully typed. When the catalog declares actions, `actions` is required; otherwise optional.
 
-## Type Declaration
+## Type Parameters
 
-| Name          | Type                                               | Description                                                                                                                                                             | Defined in |
-| ------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
-| `components?` | [`ComponentRegistry`](ComponentRegistry.md)\<`C`\> | Catalog-typed component implementations. If omitted, all elements fall through to the `fallback` renderer (if provided) or return `null` — the container will be empty. | -          |
+| Type Parameter                                        |
+| ----------------------------------------------------- |
+| <a id="type-parameter-c"></a> `C` _extends_ `Catalog` |
 
-## Type Parameters
+## Type Declaration
 
-| Type Parameter          |
-| ----------------------- |
-| `C` _extends_ `Catalog` |
+| Name             | Type                                               | Description                                                                                                                                                                                                                                  | Defined in |
+| ---------------- | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
+| `components?`    | [`ComponentRegistry`](ComponentRegistry.md)\<`C`\> | Catalog-typed component implementations. If omitted, all elements fall through to the `fallback` renderer (if provided) or return `null` — the container will be empty.                                                                      | -          |
+| `onRenderError?` | [`OnRenderError`](OnRenderError.md)                | The error handler of the registry, as in the framework renderers. `defineRegistry` puts it on the registry as a property that is not enumerable. The `onRenderError` option of `renderSpec` and of the incremental renderer takes its place. | -          |
 
 ## Example
 

package/api/@xmachines/play-dom/type-aliases/MountFn.md

@@ -6,7 +6,7 @@
 type MountFn = (actor, container, options?) => () => void;
 ```
 
-Defined in: [packages/play-dom/src/create-play-ui.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom/src/create-play-ui.ts#L82)
+Defined in: [packages/play-dom/src/create-play-ui.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom/src/create-play-ui.ts#L82)
 
 The mount function that `createPlayUI` returns.
 

package/api/@xmachines/play-dom/type-aliases/OnRenderError.md

@@ -0,0 +1,27 @@
+[API](../../../README.md) / [@xmachines/play-dom](../README.md) / OnRenderError
+
+# Type Alias: OnRenderError
+
+```ts
+type OnRenderError = (error, name, info) => void;
+```
+
+Defined in: `@xmachines/json-render-core`
+
+The `onRenderError` handler of a renderer.
+
+The second argument stays as it was: the element type for a failure of an
+element, or the action name for a failed chain. `info` tells them apart. A
+handler with two parameters is still a valid handler.
+
+## Parameters
+
+| Parameter | Type                                                  |
+| --------- | ----------------------------------------------------- |
+| `error`   | `unknown`                                             |
+| `name`    | `string`                                              |
+| `info`    | [`RenderErrorInfo`](../interfaces/RenderErrorInfo.md) |
+
+## Returns
+
+`void`

package/api/@xmachines/play-dom/type-aliases/RenderErrorKind.md

@@ -0,0 +1,21 @@
+[API](../../../README.md) / [@xmachines/play-dom](../README.md) / RenderErrorKind
+
+# Type Alias: RenderErrorKind
+
+```ts
+type RenderErrorKind = "element" | "props" | "visible" | "action" | "watch" | "root";
+```
+
+Defined in: `@xmachines/json-render-core`
+
+The place where a failure occurred.
+
+- `element`: the component threw while it rendered, in an effect or a
+  lifecycle hook, or in a callback that it calls in those phases.
+- `props`: a prop expression of an element threw (`$computed`, a directive).
+- `visible`: the `visible` condition of an element threw.
+- `action`: an `on` chain failed: a handler that throws or rejects, a
+  built-in action, a store that refuses a write, or `validateForm`.
+- `watch`: a `watch` chain failed.
+- `root`: the root (its component, props or `visible`) failed, so the
+  renderer shows nothing.

package/api/@xmachines/play-dom-router/README.md

@@ -4,7 +4,7 @@
 
 **Vanilla DOM router (Browser History API) for 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-6.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-dom-router)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-7.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-dom-router)
 
 This framework-agnostic router integration keeps the `currentRoute` atom of a Play actor and the `window.history` API of the browser in step. It needs no framework. It implements the same [`RouterBridgeBase`](../play-router/README.md) pattern as every other router adapter in the XMachines ecosystem.
 
@@ -50,7 +50,7 @@ reach [`@xmachines/play-router/xstate`](../play-router/README.md), which holds `
 
 A history that you inject for a test or for SSR is a plain object. `subscribe` returns a plain function:
 
-```typescript
+```typescript fragment
 import type { BrowserHistory } from "@xmachines/play-dom-router";
 
 const history: BrowserHistory = {
@@ -124,6 +124,8 @@ function teardown(): void {
 This function wraps `window.history`, and it gives you a history interface with a subscription. It patches `pushState` and `replaceState`. Therefore the wrapper also detects a navigation from the code, not only a `popstate` event from the BACK or FORWARD button.
 
 ```typescript
+import { createBrowserHistory } from "@xmachines/play-dom-router";
+
 const history = createBrowserHistory({ window });
 
 // Subscribe to URL changes
@@ -164,7 +166,14 @@ The interface accepts `window`, a JSDOM window, or every other object that imple
 This function creates a `VanillaRouter` around a `history` and a `routeTree`. Its setup flow is the same as the setup flow of TanStack Router.
 
 ```typescript
-// routeTree and history from the Quick Start above
+import { createBrowserHistory, createRouter } from "@xmachines/play-dom-router";
+import { extractMachineRoutes } from "@xmachines/play-router/xstate";
+import type { AnyStateMachine } from "xstate";
+
+declare const machine: AnyStateMachine; // the machine of the Quick Start above
+
+const routeTree = extractMachineRoutes(machine);
+const history = createBrowserHistory({ window });
 const router = createRouter({ routeTree, history });
 // router.history — the BrowserHistory instance
 // router.routeTree — for structure reference
@@ -175,7 +184,14 @@ Or let a scope release it, which also releases the history on an exception. Publ
 
 ```typescript
 import { asDisposable } from "@xmachines/core/utils";
+import { createBrowserHistory, createRouter } from "@xmachines/play-dom-router";
+import { extractMachineRoutes } from "@xmachines/play-router/xstate";
+import type { AnyStateMachine } from "xstate";
+
+declare const machine: AnyStateMachine; // the machine of the Quick Start above
 
+const routeTree = extractMachineRoutes(machine);
+const history = createBrowserHistory({ window });
 const plain = createRouter({ routeTree, history });
 using router = asDisposable(plain, () => plain.destroy());
 ```
@@ -195,6 +211,17 @@ This function connects a history to a `Routable` actor. It does all the work in
 - Returns a cleanup function that disconnects the bridge.
 
 ```typescript
+import {
+	connectRouter,
+	type RoutableActor,
+	type RouteLookupContract,
+	type VanillaRouter,
+} from "@xmachines/play-dom-router";
+
+declare const actor: RoutableActor;
+declare const router: VanillaRouter;
+declare const routeMap: RouteLookupContract;
+
 const disconnect = connectRouter({
 	actor, // RoutableActor — an actor of the `PlayActor` contract that adds `Routable` satisfies this structurally
 	router, // the router from createRouter(), or any { history }
@@ -229,8 +256,17 @@ The bridge accepts every object that implements this structural interface. A `Ro
 This package re-exports it never: the barrel names no state machine. The function builds a bidirectional `RouteMap` from an XState machine:
 
 ```typescript
+import { createMachine } from "xstate";
 import { createRouteMap } from "@xmachines/play-router/xstate";
-// machine from the Quick Start above (states carry meta.route)
+
+// A machine whose states carry meta.route, as in the Quick Start above
+const machine = createMachine({
+	id: "app",
+	initial: "dashboard",
+	states: {
+		dashboard: { id: "dashboard", meta: { route: "/dashboard" } },
+	},
+});
 const routeMap = createRouteMap(machine);
 routeMap.getStateIdByPath("/dashboard"); // "dashboard"
 routeMap.getPathByStateId("dashboard"); // "/dashboard"
@@ -241,7 +277,7 @@ routeMap.getPathByStateId("dashboard"); // "/dashboard"
 The bridge-first data flow:
 
 1. `connectRouter` creates a `DomRouterBridge`, which extends `RouterBridgeBase`, and calls `bridge.connect()`.
-2. On connect, `RouterBridgeBase` does the first synchronization. If the browser URL is different from the actor route, the bridge sends a `play.route` event. If the actor route is different and the browser is at the initial route of the machine (a restore), the actor wins, and the bridge updates the history.
+2. On connect, `RouterBridgeBase` does the first synchronization. If the browser URL is different from the actor route, the bridge sends a `play.route` event. If the actor route is different and the browser is at the initial URL of the machine, with the same path and the same query (a restore), the actor wins, and the bridge updates the history. A query of the browser at the initial path makes a deep link, and the router wins.
 3. Each actor route change, through the `currentRoute` Atom, calls `history.push(path)`.
 4. Each browser URL change (a `popstate` event, or a patched `pushState` or `replaceState` call) calls `syncActorFromRouter(pathname, search)`, which sends a `play.route` event.
 5. The `isProcessingNavigation` flag in `RouterBridgeBase` stops a circular update.

package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md

@@ -2,7 +2,7 @@
 
 # Class: DomRouterBridge
 
-Defined in: [play-dom-router/src/dom-router-bridge.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/dom-router-bridge.ts#L27)
+Defined in: [play-dom-router/src/dom-router-bridge.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/dom-router-bridge.ts#L27)
 
 The DOM router bridge — it puts a BrowserHistory from `createBrowserHistory`
 behind the `RouterBridgeBase` protocol.
@@ -42,7 +42,7 @@ new DomRouterBridge(
 ): DomRouterBridge;
 ```
 
-Defined in: [play-dom-router/src/dom-router-bridge.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/dom-router-bridge.ts#L40)
+Defined in: [play-dom-router/src/dom-router-bridge.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/dom-router-bridge.ts#L40)
 
 #### Parameters
 
@@ -71,7 +71,7 @@ Defined in: [play-dom-router/src/dom-router-bridge.ts:40](https://gitlab.com/xma
 get basePath(): string;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L282)
+Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L282)
 
 The resolved URL prefix that the machine of this bridge is mounted under, or `""`
 when the machine owns the complete router.
@@ -96,7 +96,7 @@ The resolved URL prefix of the mount, or `""` when the machine owns the complete
 get basePathParams(): Readonly<Record<string, string>>;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L311)
+Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L311)
 
 The resolved values of the `:param` segments of the mount, or `{}` for a prefix
 without a param.
@@ -147,7 +147,7 @@ mount while the machine stays on the same route, and no event goes out.
 connect(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L533)
+Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L533)
 
 Connects the router bridge to the Actor.
 
@@ -181,7 +181,7 @@ An adapter that needs a different behavior of the first synchronization override
 disconnect(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:791](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L791)
+Defined in: [play-router/src/router-bridge-base.ts:795](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L795)
 
 Disconnects the router bridge from the Actor.
 
@@ -204,7 +204,7 @@ framework.
 setBasePath(basePath?, basePathParams?): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L351)
+Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L351)
 
 Moves the machine to a different mount point, while it stays connected.
 

package/api/@xmachines/play-dom-router/classes/RouteMap.md

@@ -2,7 +2,7 @@
 
 # Class: RouteMap
 
-Defined in: [play-router/src/base-route-map.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L176)
+Defined in: [play-router/src/base-route-map.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L176)
 
 The shared base class of the route map for both directions.
 
@@ -64,7 +64,7 @@ map.getPathByStateId("missing"); // null
 new RouteMap(mappings, options?): RouteMap;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L209)
+Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L209)
 
 Builds a route map from an array of the mappings between a state ID and a path.
 
@@ -78,7 +78,7 @@ candidates is therefore efficient.
 | Parameter  | Type                                                  | Description                                                                                                                                               |
 | ---------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `mappings` | [`RouteMapping`](../interfaces/RouteMapping.md)[]     | The array of the `{ stateId, path }` entries. The order gives the priority when more than one pattern can match the same path.                            |
-| `options`  | [`RouteMapOptions`](../interfaces/RouteMapOptions.md) | See [RouteMapOptions](../interfaces/RouteMapOptions.md). A map holds TWO caches, so no option is named `cache`: each one names the cache that it carries. |
+| `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md) | See [RouteMapOptions](../interfaces/RouteMapOptions.md). A map holds TWO caches, so no option is named `cache`: each one names the cache that it carries. |
 
 #### Returns
 
@@ -92,7 +92,7 @@ candidates is therefore efficient.
 getPathByStateId(stateId): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L322)
+Defined in: [play-router/src/base-route-map.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L322)
 
 Returns the path pattern of a state ID.
 
@@ -128,7 +128,7 @@ map.getPathByStateId("missing"); // null
 getStateIdByPath(path): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L277)
+Defined in: [play-router/src/base-route-map.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L277)
 
 Resolves a URL path to its state ID.
 

package/api/@xmachines/play-dom-router/functions/connectRouter.md

@@ -6,7 +6,7 @@
 function connectRouter(options): RouterConnection;
 ```
 
-Defined in: [play-dom-router/src/connect-router.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/connect-router.ts#L64)
+Defined in: [play-dom-router/src/connect-router.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/connect-router.ts#L64)
 
 Connects the vanilla router to an actor. This is a pure browser integration.
 

package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md

@@ -6,7 +6,7 @@
 function createBrowserHistory(options): BrowserHistory;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L137)
+Defined in: [play-dom-router/src/create-browser-history.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L137)
 
 Creates a browser history that wraps window.history
 

package/api/@xmachines/play-dom-router/functions/createRouter.md

@@ -6,7 +6,7 @@
 function createRouter(options): VanillaRouter;
 ```
 
-Defined in: [play-dom-router/src/create-router.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-router.ts#L79)
+Defined in: [play-dom-router/src/create-router.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-router.ts#L79)
 
 Creates the vanilla router for a framework-agnostic routing.
 

package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md

@@ -2,7 +2,7 @@
 
 # Interface: BasePathOptions
 
-Defined in: [play-url/src/base-path.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L49)
+Defined in: [play-url/src/base-path.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-url/src/base-path.ts#L49)
 
 The base-path options that every router bridge, `connectRouter` function, and
 `PlayRouterProvider` component accepts.
@@ -22,7 +22,7 @@ connectRouter({
 
 ## Properties
 
-| Property                                               | Modifier   | Type                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Defined in                                                                                                                      |
-| ------------------------------------------------------ | ---------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-basepath"></a> `basePath?`             | `readonly` | `string`                                   | The URL prefix that the routes of the machine hang off, for example `"/admin"` or `"/:machineId/play"`. A `:param` segment is a declarative convenience, so that a host keeps ONE string that mirrors its own route config. Every `:param` must have a value in [BasePathOptions.basePathParams](ConnectRouterOptions.md#property-basepathparams), because the bridge writes a real URL. An optional segment (`:param?`) and a wildcard (`*`) are therefore refused: neither of them resolves to one concrete prefix. An absent value, `""`, and `"/"` all mean "no prefix".                                                                                                                     | [play-url/src/base-path.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L62) |
-| <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\> | The values of the `:param` segments of [BasePathOptions.basePath](ConnectRouterOptions.md#property-basepath). These values belong to the HOST, which wrote the prefix and resolved them, so they travel in NO `play.route` event: the machine is authoritative over its own params, and `event.params` holds what the pattern of the machine declares, and nothing else. A param of the host that shares a name with one of the machine can therefore shadow it never. A host reads them back from `bridge.basePathParams`, where they cannot go stale. A machine that needs the identity of its host takes it through the `input` of the actor, where that identity decides WHICH machine runs. | [play-url/src/base-path.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L76) |
+| Property                                               | Modifier   | Type                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Defined in                                                                                                                           |
+| ------------------------------------------------------ | ---------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-basepath"></a> `basePath?`             | `readonly` | `string`                                   | The URL prefix that the routes of the machine hang off, for example `"/admin"` or `"/:machineId/play"`. A `:param` segment is a declarative convenience, so that a host keeps ONE string that mirrors its own route config. Every `:param` must have a value in [BasePathOptions.basePathParams](ConnectRouterOptions.md#property-basepathparams), because the bridge writes a real URL. An optional segment (`:param?`) and a wildcard (`*`) are therefore refused: neither of them resolves to one concrete prefix. An absent value, `""`, and `"/"` all mean "no prefix".                                                                                                                     | [play-url/src/base-path.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-url/src/base-path.ts#L62) |
+| <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\> | The values of the `:param` segments of [BasePathOptions.basePath](ConnectRouterOptions.md#property-basepath). These values belong to the HOST, which wrote the prefix and resolved them, so they travel in NO `play.route` event: the machine is authoritative over its own params, and `event.params` holds what the pattern of the machine declares, and nothing else. A param of the host that shares a name with one of the machine can therefore shadow it never. A host reads them back from `bridge.basePathParams`, where they cannot go stale. A machine that needs the identity of its host takes it through the `input` of the actor, where that identity decides WHICH machine runs. | [play-url/src/base-path.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-url/src/base-path.ts#L76) |

package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md

@@ -2,17 +2,17 @@
 
 # Interface: BrowserHistory
 
-Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L1)
+Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L1)
 
 ## Properties
 
-| Property                                  | Modifier   | Type      | Description                               | Defined in                                                                                                                                                            |
-| ----------------------------------------- | ---------- | --------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-location"></a> `location` | `readonly` | `object`  | Returns the state of the current location | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L5) |
-| `location.hash`                           | `public`   | `string`  | -                                         | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L8) |
-| `location.pathname`                       | `public`   | `string`  | -                                         | [play-dom-router/src/create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L6) |
-| `location.search`                         | `public`   | `string`  | -                                         | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L7) |
-| `location.state`                          | `public`   | `unknown` | -                                         | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L9) |
+| Property                                  | Modifier   | Type      | Description                               | Defined in                                                                                                                                                                 |
+| ----------------------------------------- | ---------- | --------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-location"></a> `location` | `readonly` | `object`  | Returns the state of the current location | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L5) |
+| `location.hash`                           | `public`   | `string`  | -                                         | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L8) |
+| `location.pathname`                       | `public`   | `string`  | -                                         | [play-dom-router/src/create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L6) |
+| `location.search`                         | `public`   | `string`  | -                                         | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L7) |
+| `location.state`                          | `public`   | `unknown` | -                                         | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L9) |
 
 ## Methods
 
@@ -22,7 +22,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com
 back(): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L26)
+Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L26)
 
 #### Returns
 
@@ -36,7 +36,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.co
 createHref(path): string;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L46)
+Defined in: [play-dom-router/src/create-browser-history.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L46)
 
 Creates an href from a path
 
@@ -58,7 +58,7 @@ Creates an href from a path
 destroy(): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L54)
+Defined in: [play-dom-router/src/create-browser-history.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L54)
 
 Cleans up.
 
@@ -77,7 +77,7 @@ A second call is safe. When more than one wrapper shares the same
 forward(): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L27)
+Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L27)
 
 #### Returns
 
@@ -91,7 +91,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.co
 go(delta): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L25)
+Defined in: [play-dom-router/src/create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L25)
 
 Moves back or forward in the history
 
@@ -113,7 +113,7 @@ Moves back or forward in the history
 push(path, state?): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L15)
+Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L15)
 
 Pushes a new URL to the history
 
@@ -136,7 +136,7 @@ Pushes a new URL to the history
 replace(path, state?): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L20)
+Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L20)
 
 Replaces the current URL in the history
 
@@ -159,7 +159,7 @@ Replaces the current URL in the history
 subscribe(listener): () => void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L41)
+Defined in: [play-dom-router/src/create-browser-history.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L41)
 
 Subscribes to the history changes.
 It returns the release of the subscription.

package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md

@@ -2,7 +2,7 @@
 
 # Interface: BrowserWindow
 
-Defined in: [play-dom-router/src/create-browser-history.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L67)
+Defined in: [play-dom-router/src/create-browser-history.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L67)
 
 The minimal window interface of createBrowserHistory
 
@@ -13,19 +13,19 @@ different in each environment.
 
 ## Properties
 
-| Property                                  | Modifier   | Type      | Defined in                                                                                                                                                              |
-| ----------------------------------------- | ---------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-history"></a> `history`   | `public`   | `object`  | [play-dom-router/src/create-browser-history.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L68) |
-| `history.state`                           | `readonly` | `unknown` | [play-dom-router/src/create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L69) |
-| `history.back`                            | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L73) |
-| `history.forward`                         | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L74) |
-| `history.go`                              | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L72) |
-| `history.pushState`                       | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L70) |
-| `history.replaceState`                    | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L71) |
-| <a id="property-location"></a> `location` | `public`   | `object`  | [play-dom-router/src/create-browser-history.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L76) |
-| `location.hash`                           | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L79) |
-| `location.pathname`                       | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L77) |
-| `location.search`                         | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L78) |
+| Property                                  | Modifier   | Type                                 | Defined in                                                                                                                                                                   |
+| ----------------------------------------- | ---------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-history"></a> `history`   | `public`   | `object`                             | [play-dom-router/src/create-browser-history.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L68) |
+| `history.state`                           | `readonly` | `unknown`                            | [play-dom-router/src/create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L69) |
+| `history.back`                            | `public`   | () => `void`                         | [play-dom-router/src/create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L73) |
+| `history.forward`                         | `public`   | () => `void`                         | [play-dom-router/src/create-browser-history.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L74) |
+| `history.go`                              | `public`   | (`delta`) => `void`                  | [play-dom-router/src/create-browser-history.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L72) |
+| `history.pushState`                       | `public`   | (`state`, `title`, `url?`) => `void` | [play-dom-router/src/create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L70) |
+| `history.replaceState`                    | `public`   | (`state`, `title`, `url?`) => `void` | [play-dom-router/src/create-browser-history.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L71) |
+| <a id="property-location"></a> `location` | `public`   | `object`                             | [play-dom-router/src/create-browser-history.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L76) |
+| `location.hash`                           | `readonly` | `string`                             | [play-dom-router/src/create-browser-history.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L79) |
+| `location.pathname`                       | `readonly` | `string`                             | [play-dom-router/src/create-browser-history.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L77) |
+| `location.search`                         | `readonly` | `string`                             | [play-dom-router/src/create-browser-history.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L78) |
 
 ## Methods
 
@@ -35,7 +35,7 @@ different in each environment.
 addEventListener(type, listener): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L81)
+Defined in: [play-dom-router/src/create-browser-history.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L81)
 
 #### Parameters
 
@@ -56,7 +56,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:81](https://gitlab.co
 removeEventListener(type, listener): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-dom-router/src/create-browser-history.ts#L82)
+Defined in: [play-dom-router/src/create-browser-history.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-dom-router/src/create-browser-history.ts#L82)
 
 #### Parameters