@xmachines/docs 2.0.0-alpha.1 → 2.1.0

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

@@ -1,15 +1,10 @@
 [API](../../README.md) / @xmachines/play-svelte-spa-router
 
-<!-- generated-by: gsd-doc-writer -->
-
 # @xmachines/play-svelte-spa-router
 
-> Svelte SPA Router adapter for the XMachines Play architecture — connects hash-based routing to a `Routable` actor so state machines own navigation.
-
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![npm](https://img.shields.io/npm/v/@xmachines/play-svelte-spa-router)](https://www.npmjs.com/package/@xmachines/play-svelte-spa-router)
+> Svelte SPA Router adapter for the XMachines Play architecture. It connects hash-based routing to a `Routable` actor, so the state machine owns the navigation.
 
-Part of the [XMachines Play monorepo](../../README.md).
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-2.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-svelte-spa-router)
 
 ---
 
@@ -19,10 +14,10 @@ Part of the [XMachines Play monorepo](../../README.md).
 pnpm add @xmachines/play-svelte-spa-router
 ```
 
-**Peer dependencies** — install alongside the adapter:
+**Peer dependencies.** Install them with the adapter:
 
 ```bash
-pnpm add svelte@^5.0.0 svelte-spa-router@^5.0.0 xstate@^6.0.0-alpha.19
+pnpm add svelte@^5.0.0 svelte-spa-router@^5.0.0 xstate@^5.31.0
 ```
 
 ---
@@ -31,63 +26,56 @@ pnpm add svelte@^5.0.0 svelte-spa-router@^5.0.0 xstate@^6.0.0-alpha.19
 
 ### 1. Define a routable XState machine
 
-Declare routes in each state's `meta.route` field:
+Declare the route of each state in its `meta.route` field:
 
 ```typescript
-import { setup, types } from "xstate";
-import { createRoutedMachine, playMetaSchema, playRouteEventSchema } from "@xmachines/play-xstate";
-
-const appSetup = setup({
-	schemas: {
-		// params and query are patched into context on every play.route transition
-		context: types<{ params: Record<string, string>; query: Record<string, string> }>(),
-		events: { "play.route": playRouteEventSchema },
-		meta: playMetaSchema,
-	},
-});
-
-// createRoutedMachine(appSetup) has the same signature as appSetup.createMachine
-const machine = createRoutedMachine(appSetup)({
-	id: "app",
-	initial: "home",
-	context: { params: {}, query: {} },
-	states: {
-		home: { id: "home", meta: { route: "/home" } },
-		dashboard: { id: "dashboard", meta: { route: "/dashboard" } },
-		settings: { id: "settings", meta: { route: "/settings/:section?" } },
-	},
-});
+import { setup } from "xstate";
+import { formatPlayRouteTransitions } from "@xmachines/play-xstate";
+import type { PlayRouteEvent } from "@xmachines/play-svelte-spa-router";
+
+const machine = setup({
+	types: { events: {} as PlayRouteEvent },
+}).createMachine(
+	formatPlayRouteTransitions({
+		id: "app",
+		initial: "home",
+		states: {
+			home: { meta: { route: "/home" } },
+			dashboard: { meta: { route: "/dashboard" } },
+			settings: { meta: { route: "/settings/:section?" } },
+		},
+	}),
+);
 ```
 
 ### 2. Create a player and connect the router
 
-Use `createRouteMap` to build a bidirectional route map from the machine, then call `connectRouter` once — typically in your root Svelte component or a dedicated runtime module:
+Use `createRouteMap` to build a bidirectional route map from the machine. Then call `connectRouter` one time, usually in your root Svelte component or in a dedicated runtime module:
 
 ```typescript
+// runtime.ts
 import { definePlayer } from "@xmachines/play-xstate";
 import { connectRouter, createRouteMap } from "@xmachines/play-svelte-spa-router";
+import { machine } from "./machine.js"; // defined in the previous example
 
 const createPlayer = definePlayer({ machine });
 export const actor = createPlayer();
 actor.start();
 
 const routeMap = createRouteMap(machine);
-const disconnectRouter = connectRouter({ actor, routeMap });
+export const disconnectRouter = connectRouter({ actor, routeMap });
 ```
 
 ### 3. Clean up on destroy
 
-Return the cleanup function from `connectRouter` to `onDestroy` (or your lifecycle equivalent):
+Give the cleanup function of `connectRouter` to `onDestroy`, or to the equivalent lifecycle hook:
 
 ```svelte
 <script lang="ts">
-  import { onDestroy } from "svelte";
-  import { connectRouter, createRouteMap } from "@xmachines/play-svelte-spa-router";
+	import { onDestroy } from "svelte";
+	import { disconnectRouter } from "./runtime.js"; // the module from the previous example
 
-  const routeMap = createRouteMap(machine);
-  const disconnect = connectRouter({ actor, routeMap });
-
-  onDestroy(() => disconnect());
+	onDestroy(() => disconnectRouter());
 </script>
 ```
 
@@ -112,20 +100,20 @@ interface ConnectRouterOptions {
 }
 ```
 
-**Behaviour:**
+**Behavior:**
 
-- On `connect`: reads the current hash URL via `router.loc.location`, syncs the actor via a `play.route` event, and starts watching for `hashchange` events.
-- On actor `currentRoute` change: calls `push(path)` (svelte-spa-router) to update the URL.
-- On `hashchange`: parses the new location from `router.loc` and sends `play.route` to the actor.
-- On disconnect: removes the `hashchange` listener and unsubscribes from actor signals.
+- On `connect`: it reads the current hash URL from `router.loc.location`, sets the actor state with a `play.route` event, and then listens for a `hashchange` event.
+- On a change of the actor `currentRoute`: it calls `push(path)` from svelte-spa-router to update the URL.
+- On `hashchange`: it reads the new location from `router.loc` and sends `play.route` to the actor.
+- On disconnect: it removes the `hashchange` listener and cancels the subscriptions to the actor signals.
 
 ### `createRouteMap(machine): RouteMap`
 
-Re-exported from `@xmachines/play-router`. Extracts all `meta.route` entries from an XState machine and builds a bidirectional route map supporting `URLPattern` matching (including parameterised and optional segments).
+This function comes from `@xmachines/play-router`. It reads every `meta.route` entry of an XState machine. Then it builds a bidirectional route map with `URLPattern` matching, which includes a parameter segment and an optional segment.
 
 ### `RouteMap`
 
-Re-exported from `@xmachines/play-router`. Bidirectional map between state IDs and URL paths.
+This type comes from `@xmachines/play-router`. It is the bidirectional map between the state IDs and the URL paths.
 
 | Method                      | Description                                    |
 | --------------------------- | ---------------------------------------------- |
@@ -136,9 +124,9 @@ Re-exported from `@xmachines/play-router`. Bidirectional map between state IDs a
 
 | Type                   | Description                                                                                               |
 | ---------------------- | --------------------------------------------------------------------------------------------------------- |
-| `ConnectRouterOptions` | Options accepted by `connectRouter`                                                                       |
+| `ConnectRouterOptions` | The options that `connectRouter` accepts                                                                  |
 | `RoutableActor`        | Minimal actor interface — `AbstractActor` from `@xmachines/play-actor` combined with the `Routable` mixin |
-| `PlayRouteEvent`       | The `play.route` event type sent to the actor                                                             |
+| `PlayRouteEvent`       | The `play.route` event type that the bridge sends to the actor                                            |
 | `RouterBridge`         | Interface that all router bridges must satisfy                                                            |
 | `RouteMapping`         | Route-entry shape within a `RouteMap`                                                                     |
 | `RouteMapOptions`      | Options for `createRouteMap`                                                                              |
@@ -156,7 +144,9 @@ Re-exported from `@xmachines/play-router`. Bidirectional map between state IDs a
 | `watchRouterChanges()`   | `win.addEventListener("hashchange", …)`    |
 | `unwatchRouterChanges()` | `win.removeEventListener("hashchange", …)` |
 
-Initial path is read from `router.loc.location` and initial search from `router.loc.querystring`. Restore-vs-deeplink detection, guard-redirect flows, and `isProcessingNavigation` debouncing are inherited from `RouterBridgeBase`.
+The bridge reads the initial path from `router.loc.location`, and the initial search string from `router.loc.querystring`. It inherits the restore-or-deeplink detection, the guard-redirect flow, and the `isProcessingNavigation` debounce from `RouterBridgeBase`.
+
+`SvelteSpaRouterBridge` is exported from the package — prefer `connectRouter` for the common case, and instantiate the bridge directly (`new SvelteSpaRouterBridge(actor, routeMap)` followed by `connect()`/`disconnect()`) when you need fine-grained control over the connection lifecycle.
 
 ---
 
@@ -185,6 +175,7 @@ MIT © XMachines Contributors. See [LICENSE](./LICENSE).
 ## Classes
 
 - [RouteMap](classes/RouteMap.md)
+- [SvelteSpaRouterBridge](classes/SvelteSpaRouterBridge.md)
 
 ## Interfaces
 

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

@@ -2,32 +2,33 @@
 
 # Class: RouteMap
 
-Defined in: [play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-router/src/base-route-map.ts#L101)
+Defined in: [play-router/src/base-route-map.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L105)
 
-Shared bidirectional route map base class.
+The shared base class of the route map for both directions.
 
-All framework adapters use this class as their route map — they add no logic of their
-own and inherit the full public API from here.
+Every framework adapter uses this class as its route map. An adapter adds no logic
+of its own, and it inherits the complete public API from here.
 
-**Lookup strategy:**
+**The strategy of a lookup:**
 
-- Static paths (no `:param`) → O(1) `Map` lookup
-- Dynamic paths → O(k) bucket-indexed scan using `URLPattern`, where `k` is the number
-  of routes sharing the same first path segment
-- Results are cached after the first match in an LRU cache (default 500 entries,
-  configurable via the `cacheSize` constructor option)
+- A static path, without a `:param` → a `Map` lookup in O(1)
+- A dynamic path → a scan of the bucket index in O(k), with `URLPattern`, where
+  `k` is the number of the routes with the same first path segment
+- 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
 
-**Pattern syntax** (`:param` / `:param?` / `*`):
+**The syntax of a pattern** (`:param`, `:param?`, and `*`):
 
-- `:param` — required segment, matches exactly one non-`/` segment
-- `:param?` — optional segment, matches zero or one non-`/` segment
-- `*` — wildcard, matches any number of segments (URLPattern semantics)
+- `: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
 
-**StateId forms:** stateIds may be registered and looked up in either
-`"#stateId"` or `"stateId"` form — `RouteMap` canonicalizes internally.
-`getStateIdByPath` returns the stateId exactly as registered;
-`getPathByStateId` accepts both forms. Registering the same stateId in both
-forms refers to one entry (the later registration wins for reverse lookup).
+**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
+registered it, and `getPathByStateId` accepts both forms. A registration of the
+same stateId in both forms gives one entry, and the later registration wins for
+the lookup in the other direction.
 
 ## Example
 
@@ -57,21 +58,22 @@ map.getPathByStateId("missing"); // null
 new RouteMap(mappings, options?): RouteMap;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-router/src/base-route-map.ts#L127)
+Defined in: [play-router/src/base-route-map.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L133)
 
-Build a route map from an array of state ID ↔ path mappings.
+Builds a route map from an array of the mappings between a state ID and a path.
 
-Static paths (no `:param`) are indexed in an O(1) `Map`.
-Parameterized paths are compiled to `URLPattern` and grouped into first-segment
-buckets for efficient candidate selection.
+The constructor puts each static path, which holds no `:param`, into a `Map` for a
+lookup in O(1). It compiles each parameterized path to a `URLPattern`, and it
+groups the patterns into the buckets of the first segment. The selection of the
+candidates is therefore efficient.
 
 #### Parameters
 
-| Parameter            | Type                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                  |
-| -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `mappings`           | [`RouteMapping`](../interfaces/RouteMapping.md)[] | Array of `{ stateId, path }` entries. Order determines priority when multiple patterns could match the same path.                                                                                                                                                                                                                                                                                            |
-| `options`            | \{ `cacheSize?`: `number`; \}                     | Optional configuration. `options.cacheSize`: Maximum number of resolved parameterized path lookups to cache. Defaults to `500`. Increase for applications with many unique parameterized URL values (e.g. user profile pages with thousands of distinct IDs). After eviction the path falls back to the O(k) bucket pattern scan — correct but slower. Minimum effective value is `1` (QuickLRU constraint). |
-| `options.cacheSize?` | `number`                                          | -                                                                                                                                                                                                                                                                                                                                                                                                            |
+| 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`            | \{ `cacheSize?`: `number`; \}                     | The optional configuration. `options.cacheSize`: the maximum number of the resolved parameterized path lookups in the cache. The default is `500`. Raise it for an application with many different values in a parameterized URL, for example a page of a user profile with thousands of different IDs. After an eviction, the path goes to the bucket pattern scan in O(k) again, which is correct but slower. The smallest effective value is `1`, because QuickLRU requires it. |
+| `options.cacheSize?` | `number`                                          | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
 
 #### Returns
 
@@ -85,31 +87,31 @@ buckets for efficient candidate selection.
 getPathByStateId(stateId): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-router/src/base-route-map.ts#L218)
+Defined in: [play-router/src/base-route-map.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L225)
 
-Look up the path pattern registered for a state ID.
+Returns the path pattern of a state ID.
 
-Accepts the stateId in either `"#stateId"` or `"stateId"` form regardless of
-which form was used at registration — lookups are canonicalized internally,
-so consumers never need to try both forms.
+The method accepts the stateId in the form `"#stateId"` and in the form
+`"stateId"`, and the form of the registration has no effect. The method makes the
+canonical form itself. Therefore a consumer tries never both forms.
 
 #### Parameters
 
-| Parameter | Type     | Description                                               |
-| --------- | -------- | --------------------------------------------------------- |
-| `stateId` | `string` | State machine state ID (e.g., `"profile"`, `"#settings"`) |
+| Parameter | Type     | Description                                                                 |
+| --------- | -------- | --------------------------------------------------------------------------- |
+| `stateId` | `string` | The state ID of the state machine, for example `"profile"` or `"#settings"` |
 
 #### Returns
 
 `string` \| `null`
 
-The registered path pattern, or `null` if the state ID is unknown
+The registered path pattern, or `null` when the state ID is unknown
 
 #### Example
 
 ```typescript
 map.getPathByStateId("profile"); // "/profile/:userId"
-map.getPathByStateId("#profile"); // "/profile/:userId" (same entry)
+map.getPathByStateId("#profile"); // "/profile/:userId" — the same entry
 map.getPathByStateId("missing"); // null
 ```
 
@@ -121,25 +123,25 @@ map.getPathByStateId("missing"); // null
 getStateIdByPath(path): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-router/src/base-route-map.ts#L178)
+Defined in: [play-router/src/base-route-map.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L185)
 
-Resolve a URL path to its mapped state ID.
+Resolves a URL path to its state ID.
 
-Strips query strings and hash fragments before matching. Tries an O(1) exact
-lookup first, then falls back to bucket-indexed pattern matching. Results are
-cached after the first pattern match.
+The method removes the query string and the hash fragment before the match. It
+tries an exact lookup in O(1) first, then it uses the pattern match on the bucket
+index. It keeps each result of a first pattern match in the cache.
 
 #### Parameters
 
-| Parameter | Type     | Description                                                                    |
-| --------- | -------- | ------------------------------------------------------------------------------ |
-| `path`    | `string` | URL pathname, optionally including query/hash (e.g., `"/profile/123?ref=nav"`) |
+| Parameter | Type     | Description                                                                            |
+| --------- | -------- | -------------------------------------------------------------------------------------- |
+| `path`    | `string` | The URL pathname. It can hold a query and a hash, for example `"/profile/123?ref=nav"` |
 
 #### Returns
 
 `string` \| `null`
 
-The mapped state ID, or `null` if no route matches
+The state ID of the path, or `null` when no route matches
 
 #### Example
 

package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md

@@ -0,0 +1,133 @@
+[API](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / SvelteSpaRouterBridge
+
+# Class: SvelteSpaRouterBridge
+
+Defined in: [play-svelte-spa-router/src/svelte-spa-router-bridge.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte-spa-router/src/svelte-spa-router-bridge.ts#L29)
+
+The Svelte SPA router bridge — it connects svelte-spa-router to RouterBridgeBase.
+
+It implements the three abstract methods:
+
+- `navigateRouter` → `push(path)` from svelte-spa-router
+- `watchRouterChanges` → `win.addEventListener("hashchange", ...)`
+- `unwatchRouterChanges` → `win.removeEventListener("hashchange", ...)`
+
+It overrides two optional hooks:
+
+- `getInitialRouterPath` → `router.loc.location`
+- `getInitialRouterSearch` → the querystring of `router.loc`
+
+The bridge inherits the restore-or-deeplink detection, `isProcessingNavigation`,
+and `lastSyncedPath` from `RouterBridgeBase`.
+
+## Param
+
+**actor**
+
+A `Routable` actor.
+
+## Param
+
+**routeMap**
+
+The bidirectional route map.
+
+## Param
+
+**win**
+
+The window-like object for the `hashchange` subscription. The
+default is the global `window`, when one exists. In an environment without a
+window, such as SSR or Node, the bridge skips the `hashchange` subscription.
+The constructor and `connect()` are then safe, as the documented behavior "it
+does nothing in an SSR environment" says. Give a mock in a test.
+
+## Extends
+
+- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new SvelteSpaRouterBridge(
+   actor,
+   routeMap,
+   win?): SvelteSpaRouterBridge;
+```
+
+Defined in: [play-svelte-spa-router/src/svelte-spa-router-bridge.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte-spa-router/src/svelte-spa-router-bridge.ts#L32)
+
+#### Parameters
+
+| Parameter  | Type                                                                 |
+| ---------- | -------------------------------------------------------------------- |
+| `actor`    | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) |
+| `routeMap` | [`RouteMap`](RouteMap.md)                                            |
+| `win`      | [`WindowLike`](../interfaces/WindowLike.md) \| `undefined`           |
+
+#### Returns
+
+`SvelteSpaRouterBridge`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`constructor`](../../play-router/classes/RouterBridgeBase.md#constructor)
+
+## Methods
+
+### connect()
+
+```ts
+connect(): void;
+```
+
+Defined in: [play-router/src/router-bridge-base.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/router-bridge-base.ts#L158)
+
+Connects the router bridge to the Actor.
+
+The method installs the TC39 Signal watcher of the direction from the actor to the
+router. It then starts the watch of the router changes, which each framework does
+in its own way.
+
+The order of these steps is part of the contract of the bridge:
+
+- The constructor seeds `lastSyncedPath` from `actor.currentRoute`
+- The method installs the actor watcher before the router subscriptions of the adapter
+- The first synchronization then separates a deep link from a restore, with `actor.initialRoute`
+
+An adapter that needs a different behavior of the first synchronization overrides
+`getInitialRouterPath()`. It does not change the order of the steps of
+`connect()`.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`connect`](../../play-router/classes/RouterBridgeBase.md#connect)
+
+---
+
+### disconnect()
+
+```ts
+disconnect(): void;
+```
+
+Defined in: [play-router/src/router-bridge-base.ts:270](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/router-bridge-base.ts#L270)
+
+Disconnects the router bridge from the Actor.
+
+The method stops the watch of the signal, and it removes the router listener of the
+framework.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`disconnect`](../../play-router/classes/RouterBridgeBase.md#disconnect)

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

@@ -6,11 +6,11 @@
 function connectRouter(options): () => void;
 ```
 
-Defined in: [play-svelte-spa-router/src/connect-router.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-svelte-spa-router/src/connect-router.ts#L29)
+Defined in: [play-svelte-spa-router/src/connect-router.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte-spa-router/src/connect-router.ts#L30)
 
-Connect svelte-spa-router to actor.
+Connects svelte-spa-router to an actor.
 
-Returns a cleanup function. The public API surface is unchanged (D-14).
+It returns a cleanup function. The public API surface stays as it was (D-14).
 
 ## Parameters
 

package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md

@@ -6,27 +6,28 @@
 function createRouteMap(machine, options?): RouteMap;
 ```
 
-Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-router/src/create-route-map.ts#L45)
+Defined in: [play-router/src/create-route-map.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/create-route-map.ts#L47)
 
-Create a `RouteMap` from an XState state machine.
+Creates a `RouteMap` from an XState state machine.
 
-Extracts all routable states (those with `meta.route`) and builds a bidirectional
-path ↔ stateId lookup structure. The returned map is used by `RouterBridgeBase`
-subclasses to translate browser URL changes into `play.route` actor events and
-vice-versa.
+The function reads every state with a route, which means each state with a
+`meta.route` field. It then builds the lookup structure between a path and a
+stateId, for both directions. A subclass of `RouterBridgeBase` uses the map: it
+converts each change of the browser URL into a `play.route` actor event, and each
+actor route into a URL.
 
 ## Parameters
 
-| Parameter  | Type                                                                      | Description                                                                                                         |
-| ---------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
-| `machine`  | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | XState v6 state machine with `meta.route` annotations on states.                                                    |
-| `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md)                     | Optional configuration. Pass `{ cacheSize }` to override the default LRU cache size for parameterized path lookups. |
+| Parameter  | Type                                                                      | Description                                                                                                                     |
+| ---------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| `machine`  | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The XState v5 state machine, with a `meta.route` annotation on each state with a route.                                         |
+| `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md)                     | The optional configuration. Give `{ cacheSize }` to change the default size of the LRU cache of the parameterized path lookups. |
 
 ## Returns
 
 [`RouteMap`](../classes/RouteMap.md)
 
-A `RouteMap` for passing to any `RouterBridgeBase`-based adapter.
+A `RouteMap` for each adapter on `RouterBridgeBase`.
 
 ## Example
 

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

@@ -2,16 +2,16 @@
 
 # Interface: ConnectRouterOptions
 
-Defined in: [play-svelte-spa-router/src/connect-router.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-svelte-spa-router/src/connect-router.ts#L5)
+Defined in: [play-svelte-spa-router/src/connect-router.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte-spa-router/src/connect-router.ts#L5)
 
 @xmachines/play-svelte-spa-router
 
-Svelte SPA router adapter for XMachines Play architecture.
+Svelte SPA router adapter for the XMachines Play architecture.
 
 ## Properties
 
-| Property                                  | Modifier   | Type                                                                 | Description                                                                                                                                                                                                     | Defined in                                                                                                                                                                    |
-| ----------------------------------------- | ---------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`       | `readonly` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | -                                                                                                                                                                                                               | [play-svelte-spa-router/src/connect-router.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-svelte-spa-router/src/connect-router.ts#L6)   |
-| <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md)                                 | -                                                                                                                                                                                                               | [play-svelte-spa-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-svelte-spa-router/src/connect-router.ts#L7)   |
-| <a id="property-window"></a> `window?`    | `readonly` | [`WindowLike`](WindowLike.md)                                        | Window-like object for `hashchange` subscriptions. Defaults to the global `window` when one exists; in environments without a window (SSR/Node) the `hashchange` subscription is skipped. Pass a mock in tests. | [play-svelte-spa-router/src/connect-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-svelte-spa-router/src/connect-router.ts#L13) |
+| Property                                  | Modifier   | Type                                                                 | Description                                                                                                                                                                                                                                    | Defined in                                                                                                                                                            |
+| ----------------------------------------- | ---------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`       | `readonly` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | -                                                                                                                                                                                                                                              | [play-svelte-spa-router/src/connect-router.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte-spa-router/src/connect-router.ts#L6)   |
+| <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md)                                 | -                                                                                                                                                                                                                                              | [play-svelte-spa-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte-spa-router/src/connect-router.ts#L7)   |
+| <a id="property-window"></a> `window?`    | `readonly` | [`WindowLike`](WindowLike.md)                                        | The window-like object for the `hashchange` subscription. The default is the global `window`, when one exists. In an environment without a window, such as SSR or Node, the bridge skips the `hashchange` subscription. Give a mock in a test. | [play-svelte-spa-router/src/connect-router.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-svelte-spa-router/src/connect-router.ts#L14) |