@xmachines/docs 2.2.0 → 4.0.0

package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md

@@ -2,7 +2,7 @@
 
 # Interface: RouterBridge
 
-Defined in: [play-router/src/types.ts:359](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L359)
+Defined in: [play-router/src/types.ts:438](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L438)
 
 The RouterBridge interface of a runtime infrastructure adapter
 
@@ -56,7 +56,7 @@ class MyRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:376](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L376)
+Defined in: [play-router/src/types.ts:455](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L455)
 
 Connects the router bridge to the Actor
 
@@ -86,7 +86,7 @@ await bridge.connect();
 disconnect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L392)
+Defined in: [play-router/src/types.ts:471](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L471)
 
 Disconnects the router bridge from the Actor
 

package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md

@@ -2,13 +2,13 @@
 
 # Interface: RouterConnection()
 
-Defined in: [play-router/src/provider-lifecycle.ts:263](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/provider-lifecycle.ts#L263)
+Defined in: [play-router/src/provider-lifecycle.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L275)
 
 What `connectRouter` of an adapter returns.
 
 The value is CALLABLE, so `const disconnect = connectRouter(…); disconnect();` keeps
 working exactly as it did. It also carries the mount API, because a host that gives a
-`basePath` needs the two things [MountableRouterBridge](../../play-router/interfaces/MountableRouterBridge.md) promises: the resolved
+`basePath` needs the two things [MountableRouterBridge](../../play-router/index/interfaces/MountableRouterBridge.md) promises: the resolved
 mount to read back, and a way to move it. The bridge itself lives inside
 `connectRouter`, so without this handle a host had to rebuild the actor and the bridge
 to move a mount — which throws away the LRU cache of the route map, the very thing
@@ -21,7 +21,7 @@ stale.
 RouterConnection(): void;
 ```
 
-Defined in: [play-router/src/provider-lifecycle.ts:265](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/provider-lifecycle.ts#L265)
+Defined in: [play-router/src/provider-lifecycle.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L277)
 
 Stops the synchronization. The same call as [RouterConnection.disconnect](#disconnect).
 
@@ -33,18 +33,47 @@ Stops the synchronization. The same call as [RouterConnection.disconnect](#disco
 
 | Property                                              | Modifier   | Type                                         | Description                                                                       | Defined in                                                                                                                                                |
 | ----------------------------------------------------- | ---------- | -------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-basepath"></a> `basePath`             | `readonly` | `string`                                     | The resolved prefix of the mount, or `""` when the machine owns the whole router. | [play-router/src/provider-lifecycle.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/provider-lifecycle.ts#L269) |
-| <a id="property-basepathparams"></a> `basePathParams` | `readonly` | `Readonly`\<`Record`\<`string`, `string`\>\> | The values of the `:param` segments of the mount. They travel in no event.        | [play-router/src/provider-lifecycle.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/provider-lifecycle.ts#L271) |
+| <a id="property-basepath"></a> `basePath`             | `readonly` | `string`                                     | The resolved prefix of the mount, or `""` when the machine owns the whole router. | [play-router/src/provider-lifecycle.ts:298](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L298) |
+| <a id="property-basepathparams"></a> `basePathParams` | `readonly` | `Readonly`\<`Record`\<`string`, `string`\>\> | The values of the `:param` segments of the mount. They travel in no event.        | [play-router/src/provider-lifecycle.ts:300](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L300) |
 
 ## Methods
 
+### \[dispose\]()
+
+```ts
+dispose: void;
+```
+
+Defined in: [play-router/src/provider-lifecycle.ts:296](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L296)
+
+Stops the synchronization when the scope of a `using` declaration ends.
+
+This value IS the release of `connectRouter`, and all eight router adapters return
+it, so it carries the protocol of `@xmachines/play` like every other release of the
+ecosystem:
+
+```ts
+{
+	using connection = connectRouter({ actor, router, routeMap });
+	// disconnect() runs at the end of the scope, and after an exception too
+}
+```
+
+The release is [RouterConnection.disconnect](#disconnect), which is idempotent.
+
+#### Returns
+
+`void`
+
+---
+
 ### disconnect()
 
 ```ts
 disconnect(): void;
 ```
 
-Defined in: [play-router/src/provider-lifecycle.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/provider-lifecycle.ts#L267)
+Defined in: [play-router/src/provider-lifecycle.ts:279](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L279)
 
 Stops the synchronization.
 
@@ -60,7 +89,7 @@ Stops the synchronization.
 setBasePath(basePath?, basePathParams?): void;
 ```
 
-Defined in: [play-router/src/provider-lifecycle.ts:273](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/provider-lifecycle.ts#L273)
+Defined in: [play-router/src/provider-lifecycle.ts:302](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L302)
 
 Moves the mount of the live bridge, with no teardown.
 

package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md

@@ -2,7 +2,7 @@
 
 # Interface: WindowLike
 
-Defined in: [play-router/src/types.ts:460](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L460)
+Defined in: [play-router/src/types.ts:539](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L539)
 
 The minimal window interface of an adapter that subscribes to a DOM event, for
 example to `hashchange`. You can inject it for SSR and for a test: give a mock in
@@ -30,7 +30,7 @@ connectRouter({ actor, routeMap, window: mockWin });
 addEventListener(type, listener): void;
 ```
 
-Defined in: [play-router/src/types.ts:461](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L461)
+Defined in: [play-router/src/types.ts:540](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L540)
 
 #### Parameters
 
@@ -51,7 +51,7 @@ Defined in: [play-router/src/types.ts:461](https://gitlab.com/xmachin-es/xmachin
 removeEventListener(type, listener): void;
 ```
 
-Defined in: [play-router/src/types.ts:462](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L462)
+Defined in: [play-router/src/types.ts:541](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L541)
 
 #### Parameters
 

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

@@ -4,36 +4,37 @@
 
 SvelteKit router adapter for the XMachines Universal Player Architecture. It keeps the state machine routes of a `RoutableActor` and the browser URL in step, in both directions, through the `$app/navigation` module of SvelteKit.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-2.2.0-blue)](https://www.npmjs.com/package/@xmachines/play-sveltekit-router)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-4.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-sveltekit-router)
 
 ## Installation
 
 ```bash
-pnpm add @xmachines/play-sveltekit-router
+pnpm add @xmachines/play-sveltekit-router @xmachines/play-router
 ```
 
 **Peer dependencies.** Install them separately:
 
 ```bash
-pnpm add @sveltejs/kit svelte xstate
+pnpm add @sveltejs/kit svelte
 ```
 
 | Peer dependency | Required version |
 | --------------- | ---------------- |
 | `@sveltejs/kit` | `^2.0.0`         |
 | `svelte`        | `^5.0.0`         |
-| `xstate`        | `^5.31.0`        |
 
 ## Quick Start
 
 ```typescript
 import { onDestroy } from "svelte";
-import { connectRouter, createRouteMap } from "@xmachines/play-sveltekit-router";
-import { definePlayer } from "@xmachines/play-xstate";
+import { connectRouter } from "@xmachines/play-sveltekit-router";
+import { createRouteMap } from "@xmachines/play-router/xstate";
+import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
+import { withRouting } from "@xmachines/play-xstate/routing";
 import { myMachine } from "./machine.js";
 
-// 1. Create the actor
-const createPlayer = definePlayer({ machine: myMachine });
+// 1. Create the actor — `connectRouter` needs the routing capability
+const createPlayer = definePlayer({ machine: myMachine, actor: compose(PlayerActor, withRouting) });
 const actor = createPlayer();
 actor.start();
 
@@ -60,8 +61,8 @@ This function is the primary integration point. It creates a `SvelteKitRouterBri
 
 ```typescript
 import { onDestroy } from "svelte";
-import { connectRouter, createRouteMap } from "@xmachines/play-sveltekit-router";
-
+import { connectRouter } from "@xmachines/play-sveltekit-router";
+import { createRouteMap } from "@xmachines/play-router/xstate";
 // machine and actor as in the Quick Start above
 const routeMap = createRouteMap(machine);
 
@@ -92,8 +93,8 @@ onDestroy(() => disconnect());
 This class extends `RouterBridgeBase` from `@xmachines/play-router`. Use it directly when you need more control over the connection lifecycle.
 
 ```typescript
-import { SvelteKitRouterBridge, createRouteMap } from "@xmachines/play-sveltekit-router";
-
+import { SvelteKitRouterBridge } from "@xmachines/play-sveltekit-router";
+import { createRouteMap } from "@xmachines/play-router/xstate";
 // machine and actor as in the Quick Start above
 const routeMap = createRouteMap(machine);
 const bridge = new SvelteKitRouterBridge(actor, routeMap, location);
@@ -109,12 +110,12 @@ bridge.disconnect();
 - `watchRouterChanges` → registers an `afterNavigate` callback through an indirection cell, which prevents a direct capture of `this`
 - `unwatchRouterChanges` → sets the indirection cell to null, which releases the bridge reference before the component unmounts (SvelteKit has no API to cancel `afterNavigate`)
 
-### `createRouteMap(machine)`
+### `createRouteMap(machine)` — from `@xmachines/play-router/xstate`
 
-This factory builds a `RouteMap` from an XState machine definition. It reads each route pattern from `state.meta.route`.
+This factory builds a `RouteMap` from an XState machine definition. It reads each route pattern from `state.meta.route`. This package re-exports it never: the barrel names no state machine, so import the function from `@xmachines/play-router/xstate`.
 
 ```typescript
-import { createRouteMap } from "@xmachines/play-sveltekit-router";
+import { createRouteMap } from "@xmachines/play-router/xstate";
 import { createMachine } from "xstate";
 
 const machine = createMachine({
@@ -153,7 +154,6 @@ const routeMap = new RouteMap([
 | `connectRouter`         | function | High-level factory — connects the SvelteKit router to an actor, returns a cleanup function                     |
 | `SvelteKitRouterBridge` | class    | The low-level bridge class. It extends `RouterBridgeBase`. Use it directly for full lifecycle control          |
 | `ConnectRouterOptions`  | type     | The options object for `connectRouter`                                                                         |
-| `createRouteMap`        | function | Builds a `RouteMap` from an XState machine definition                                                          |
 | `RouteMap`              | class    | Bidirectional state ID ↔ URL path mapping (re-exported from `@xmachines/play-router`)                          |
 | `RouteMapping`          | type     | Single `{ stateId, path }` entry for `RouteMap` construction                                                   |
 | `RouteMapOptions`       | type     | Options for `RouteMap` construction                                                                            |
@@ -173,20 +173,6 @@ pnpm --filter @xmachines/play-sveltekit-router-demo run dev
 
 Then open `http://localhost:5173`.
 
-## Testing
-
-Run tests for this package in isolation:
-
-```bash
-# From the monorepo root
-pnpm --filter @xmachines/play-sveltekit-router test
-
-# Or from this package directory
-pnpm test
-```
-
-Coverage thresholds: **80%** lines, functions, branches, and statements.
-
 ## License
 
 MIT — see [LICENSE](LICENSE).
@@ -202,16 +188,12 @@ MIT — see [LICENSE](LICENSE).
 - [ConnectRouterOptions](interfaces/ConnectRouterOptions.md)
 - [LocationLike](interfaces/LocationLike.md)
 - [PlayRouteEvent](interfaces/PlayRouteEvent.md)
+- [RoutableActor](interfaces/RoutableActor.md)
 - [RouteMapOptions](interfaces/RouteMapOptions.md)
 - [RouteMapping](interfaces/RouteMapping.md)
 - [RouterBridge](interfaces/RouterBridge.md)
 - [RouterConnection](interfaces/RouterConnection.md)
 
-## Type Aliases
-
-- [RoutableActor](type-aliases/RoutableActor.md)
-
 ## Functions
 
 - [connectRouter](functions/connectRouter.md)
-- [createRouteMap](functions/createRouteMap.md)

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

@@ -2,7 +2,7 @@
 
 # Class: RouteMap
 
-Defined in: [play-router/src/base-route-map.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L105)
+Defined in: [play-router/src/base-route-map.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/base-route-map.ts#L111)
 
 The shared base class of the route map for both directions.
 
@@ -17,12 +17,18 @@ of its own, and it inherits the complete public API from here.
 - The class keeps each result of a first match in an LRU cache. The default size
   is 500 entries, and the `cacheSize` constructor option changes it
 
-**The syntax of a pattern** (`:param`, `:param?`, and `*`):
+**The syntax of a pattern:** the whole URLPattern pathname grammar. The forms used most
+often are:
 
 - `:param` — a necessary segment. It matches exactly one segment without a `/`
 - `:param?` — an optional segment. It matches zero segments or one segment without a `/`
 - `*` — a wildcard. It matches each number of segments, as URLPattern defines
 
+A `{…}` group, a `:param(\d+)` constraint, a `+` modifier and a `\:` escape are read
+too. The [routing guide](../../../../guides/routing.md) states every form, the prefix
+rule, and the one divergence from the standard: a param name of this library can hold a
+hyphen.
+
 **The forms of a stateId:** you can register a stateId, and you can look one up,
 in the form `"#stateId"` or in the form `"stateId"`. `RouteMap` makes the
 canonical form itself. `getStateIdByPath` returns the stateId exactly as you
@@ -58,7 +64,7 @@ map.getPathByStateId("missing"); // null
 new RouteMap(mappings, options?): RouteMap;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L133)
+Defined in: [play-router/src/base-route-map.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/base-route-map.ts#L139)
 
 Builds a route map from an array of the mappings between a state ID and a path.
 
@@ -87,7 +93,7 @@ candidates is therefore efficient.
 getPathByStateId(stateId): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L229)
+Defined in: [play-router/src/base-route-map.ts:242](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/base-route-map.ts#L242)
 
 Returns the path pattern of a state ID.
 
@@ -123,7 +129,7 @@ map.getPathByStateId("missing"); // null
 getStateIdByPath(path): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:189](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L189)
+Defined in: [play-router/src/base-route-map.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/base-route-map.ts#L197)
 
 Resolves a URL path to its state ID.
 

package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md

@@ -2,7 +2,7 @@
 
 # Class: SvelteKitRouterBridge
 
-Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L41)
+Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L41)
 
 The SvelteKit router bridge — it connects the SvelteKit navigation to RouterBridgeBase.
 
@@ -43,7 +43,7 @@ environment.
 
 ## Extends
 
-- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md)
+- [`RouterBridgeBase`](../../play-router/index/classes/RouterBridgeBase.md)
 
 ## Constructors
 
@@ -54,19 +54,20 @@ new SvelteKitRouterBridge(
    actor,
    routeMap,
    loc?,
-   options?): SvelteKitRouterBridge;
+   options?
+): SvelteKitRouterBridge;
 ```
 
-Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L58)
+Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L58)
 
 #### Parameters
 
-| Parameter  | Type                                                                 |
-| ---------- | -------------------------------------------------------------------- |
-| `actor`    | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) |
-| `routeMap` | [`RouteMap`](RouteMap.md)                                            |
-| `loc`      | [`LocationLike`](../interfaces/LocationLike.md) \| `null`            |
-| `options?` | [`BasePathOptions`](../interfaces/BasePathOptions.md)                |
+| Parameter  | Type                                                      |
+| ---------- | --------------------------------------------------------- |
+| `actor`    | [`RoutableActor`](../interfaces/RoutableActor.md)         |
+| `routeMap` | [`RouteMap`](RouteMap.md)                                 |
+| `loc`      | [`LocationLike`](../interfaces/LocationLike.md) \| `null` |
+| `options?` | [`BasePathOptions`](../interfaces/BasePathOptions.md)     |
 
 #### Returns
 
@@ -74,7 +75,7 @@ Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:58](https://gi
 
 #### Overrides
 
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`constructor`](../../play-router/classes/RouterBridgeBase.md#constructor)
+[`RouterBridgeBase`](../../play-router/index/classes/RouterBridgeBase.md).[`constructor`](../../play-router/index/classes/RouterBridgeBase.md#constructor)
 
 ## Accessors
 
@@ -86,7 +87,7 @@ Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:58](https://gi
 get basePath(): string;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:255](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/router-bridge-base.ts#L255)
+Defined in: [play-router/src/router-bridge-base.ts:256](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/router-bridge-base.ts#L256)
 
 The resolved URL prefix that the machine of this bridge is mounted under, or `""`
 when the machine owns the complete router.
@@ -99,7 +100,7 @@ The resolved URL prefix of the mount, or `""` when the machine owns the complete
 
 #### Inherited from
 
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`basePath`](../../play-router/classes/RouterBridgeBase.md#basepath)
+[`RouterBridgeBase`](../../play-router/index/classes/RouterBridgeBase.md).[`basePath`](../../play-router/index/classes/RouterBridgeBase.md#basepath)
 
 ---
 
@@ -111,7 +112,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:284](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/router-bridge-base.ts#L284)
+Defined in: [play-router/src/router-bridge-base.ts:285](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/router-bridge-base.ts#L285)
 
 The resolved values of the `:param` segments of the mount, or `{}` for a prefix
 without a param.
@@ -152,7 +153,7 @@ mount while the machine stays on the same route, and no event goes out.
 
 #### Inherited from
 
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`basePathParams`](../../play-router/classes/RouterBridgeBase.md#basepathparams)
+[`RouterBridgeBase`](../../play-router/index/classes/RouterBridgeBase.md).[`basePathParams`](../../play-router/index/classes/RouterBridgeBase.md#basepathparams)
 
 ## Methods
 
@@ -162,7 +163,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:506](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/router-bridge-base.ts#L506)
+Defined in: [play-router/src/router-bridge-base.ts:507](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/router-bridge-base.ts#L507)
 
 Connects the router bridge to the Actor.
 
@@ -186,7 +187,7 @@ An adapter that needs a different behavior of the first synchronization override
 
 #### Inherited from
 
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`connect`](../../play-router/classes/RouterBridgeBase.md#connect)
+[`RouterBridgeBase`](../../play-router/index/classes/RouterBridgeBase.md).[`connect`](../../play-router/index/classes/RouterBridgeBase.md#connect)
 
 ---
 
@@ -196,7 +197,7 @@ An adapter that needs a different behavior of the first synchronization override
 disconnect(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:728](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/router-bridge-base.ts#L728)
+Defined in: [play-router/src/router-bridge-base.ts:765](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/router-bridge-base.ts#L765)
 
 Disconnects the router bridge from the Actor.
 
@@ -209,7 +210,7 @@ framework.
 
 #### Inherited from
 
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`disconnect`](../../play-router/classes/RouterBridgeBase.md#disconnect)
+[`RouterBridgeBase`](../../play-router/index/classes/RouterBridgeBase.md).[`disconnect`](../../play-router/index/classes/RouterBridgeBase.md#disconnect)
 
 ---
 
@@ -219,7 +220,7 @@ framework.
 setBasePath(basePath?, basePathParams?): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/router-bridge-base.ts#L324)
+Defined in: [play-router/src/router-bridge-base.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/router-bridge-base.ts#L325)
 
 Moves the machine to a different mount point, while it stays connected.
 
@@ -271,4 +272,4 @@ bridge.setBasePath("/:region/:machineId/play", { region: "us", machineId });
 
 #### Inherited from
 
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`setBasePath`](../../play-router/classes/RouterBridgeBase.md#setbasepath)
+[`RouterBridgeBase`](../../play-router/index/classes/RouterBridgeBase.md).[`setBasePath`](../../play-router/index/classes/RouterBridgeBase.md#setbasepath)

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

@@ -6,7 +6,7 @@
 function connectRouter(options): RouterConnection;
 ```
 
-Defined in: [play-sveltekit-router/src/connect-router.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-sveltekit-router/src/connect-router.ts#L34)
+Defined in: [play-sveltekit-router/src/connect-router.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-sveltekit-router/src/connect-router.ts#L35)
 
 Connects the SvelteKit router to an actor.
 
@@ -25,7 +25,8 @@ It returns a cleanup function. The public API surface stays as it was (D-14).
 ## Example
 
 ```typescript
-import { connectRouter, createRouteMap } from "@xmachines/play-sveltekit-router";
+import { connectRouter } from "@xmachines/play-sveltekit-router";
+import { createRouteMap } from "@xmachines/play-router/xstate";
 const routeMap = createRouteMap(machine);
 const disconnect = connectRouter({ actor, routeMap });
 onDestroy(() => disconnect());

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

@@ -2,7 +2,7 @@
 
 # Interface: BasePathOptions
 
-Defined in: [play-router/src/base-path.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-path.ts#L44)
+Defined in: [play-url/src/base-path.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-url/src/base-path.ts#L44)
 
 The base-path options that every router bridge, `connectRouter` function, and
 `PlayRouterProvider` component accepts.
@@ -26,7 +26,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](#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", which is the behaviour of every release before this option existed.                                                 | [play-router/src/base-path.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-path.ts#L58) |
-| <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\> | The values of the `:param` segments of [BasePathOptions.basePath](#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-router/src/base-path.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-path.ts#L72) |
+| 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](#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", which is the behaviour of every release before this option existed.                                                 | [play-url/src/base-path.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-url/src/base-path.ts#L58) |
+| <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\> | The values of the `:param` segments of [BasePathOptions.basePath](#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:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-url/src/base-path.ts#L72) |

package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md

@@ -2,7 +2,7 @@
 
 # Interface: ConnectRouterOptions
 
-Defined in: [play-sveltekit-router/src/connect-router.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-sveltekit-router/src/connect-router.ts#L10)
+Defined in: [play-sveltekit-router/src/connect-router.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-sveltekit-router/src/connect-router.ts#L10)
 
 The base-path options that every router bridge, `connectRouter` function, and
 `PlayRouterProvider` component accepts.
@@ -26,10 +26,10 @@ connectRouter({
 
 ## Properties
 
-| Property                                               | Modifier   | Type                                                                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Inherited from                                                                                         | Defined in                                                                                                                                                          |
-| ------------------------------------------------------ | ---------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                    | `readonly` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                      | [play-sveltekit-router/src/connect-router.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-sveltekit-router/src/connect-router.ts#L11) |
-| <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](BasePathOptions.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", which is the behaviour of every release before this option existed.                                                 | [`BasePathOptions`](BasePathOptions.md).[`basePath`](BasePathOptions.md#property-basepath)             | [play-router/src/base-path.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-path.ts#L58)                               |
-| <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\>                           | The values of the `:param` segments of [BasePathOptions.basePath](BasePathOptions.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. | [`BasePathOptions`](BasePathOptions.md).[`basePathParams`](BasePathOptions.md#property-basepathparams) | [play-router/src/base-path.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-path.ts#L72)                               |
-| <a id="property-location"></a> `location?`             | `readonly` | [`LocationLike`](LocationLike.md) \| `null`                          | The location-like object for the initial URL reads. The default is `globalThis.location`. Give a mock in a test, or a stub in an SSR environment.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                      | [play-sveltekit-router/src/connect-router.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-sveltekit-router/src/connect-router.ts#L18) |
-| <a id="property-routemap"></a> `routeMap`              | `readonly` | [`RouteMap`](../classes/RouteMap.md)                                 | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                      | [play-sveltekit-router/src/connect-router.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-sveltekit-router/src/connect-router.ts#L12) |
+| Property                                               | Modifier   | Type                                        | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Inherited from                                                                                         | Defined in                                                                                                                                                          |
+| ------------------------------------------------------ | ---------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`                    | `readonly` | [`RoutableActor`](RoutableActor.md)         | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                      | [play-sveltekit-router/src/connect-router.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-sveltekit-router/src/connect-router.ts#L11) |
+| <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](BasePathOptions.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", which is the behaviour of every release before this option existed.                                                 | [`BasePathOptions`](BasePathOptions.md).[`basePath`](BasePathOptions.md#property-basepath)             | [play-url/src/base-path.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-url/src/base-path.ts#L58)                                     |
+| <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\>  | The values of the `:param` segments of [BasePathOptions.basePath](BasePathOptions.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. | [`BasePathOptions`](BasePathOptions.md).[`basePathParams`](BasePathOptions.md#property-basepathparams) | [play-url/src/base-path.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-url/src/base-path.ts#L72)                                     |
+| <a id="property-location"></a> `location?`             | `readonly` | [`LocationLike`](LocationLike.md) \| `null` | The location-like object for the initial URL reads. The default is `globalThis.location`. Give a mock in a test, or a stub in an SSR environment.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                      | [play-sveltekit-router/src/connect-router.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-sveltekit-router/src/connect-router.ts#L18) |
+| <a id="property-routemap"></a> `routeMap`              | `readonly` | [`RouteMap`](../classes/RouteMap.md)        | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                      | [play-sveltekit-router/src/connect-router.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-sveltekit-router/src/connect-router.ts#L12) |

package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md

@@ -2,7 +2,7 @@
 
 # Interface: LocationLike
 
-Defined in: [play-router/src/types.ts:480](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L480)
+Defined in: [play-router/src/types.ts:559](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L559)
 
 The minimal location interface of an adapter that reads the current URL at the
 moment of `connect()`. You can inject it for SSR and for a test: give a mock in
@@ -23,5 +23,5 @@ connectRouter({ actor, routeMap, location: mockLoc });
 
 | Property                                  | Modifier   | Type     | Defined in                                                                                                                      |
 | ----------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:481](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L481) |
-| <a id="property-search"></a> `search`     | `readonly` | `string` | [play-router/src/types.ts:482](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L482) |
+| <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:560](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L560) |
+| <a id="property-search"></a> `search`     | `readonly` | `string` | [play-router/src/types.ts:561](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L561) |