@xmachines/docs 1.0.0-beta.45 → 1.0.0-beta.48

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

@@ -1,38 +1,49 @@
 [API](../../README.md) / @xmachines/play-dom-router
 
-# @xmachines/play-dom-router
-
-**Vanilla DOM router integration for XMachines**
+<!-- generated-by: gsd-doc-writer -->
 
-Browser History API wrapper, framework-agnostic router, and bidirectional actor ↔ URL synchronization for XState v5 machines — no JSX or framework dependency.
-
-## Overview
-
-`@xmachines/play-dom-router` provides the **concrete browser implementations** intentionally separated from the environment-agnostic core:
+# @xmachines/play-dom-router
 
-| Export                          | Description                                                                                             |
-| ------------------------------- | ------------------------------------------------------------------------------------------------------- |
-| `createBrowserHistory(options)` | Wraps `window.history` with patch-based `pushState`/`replaceState` interception and a `subscribe()` API |
-| `createRouter(options)`         | Lightweight router binding a `BrowserHistory` to a route tree                                           |
-| `connectRouter(options)`        | Bidirectional actor ↔ URL sync — history changes → `play.route`, `currentRoute` → `history.push`        |
-| `createRouteMap(machine)`       | Build a `RouteMap` from a machine's `meta.route` declarations                                           |
+**Vanilla DOM router (Browser History API) for XMachines Play Architecture.**
 
-By keeping these in a dedicated package, server-side and non-browser environments can depend on without pulling in any DOM APIs.
+Framework-agnostic router integration that synchronizes a Play actor's `currentRoute` TC39 Signal with the browser's `window.history` API — no framework required. Implements the same [`RouterBridgeBase`](../play-router/README.md) pattern as all other router adapters in the XMachines ecosystem.
 
-For JSX frameworks, use the framework adapters instead:
+## Installation
 
--
--
--
--
+```bash
+npm install @xmachines/play-dom-router @xmachines/play-router @xmachines/play-actor
+```
 
-## Installation
+Peer dependency:
 
 ```bash
-npm install @xmachines/play-dom-router @xmachines/play-router
+npm install xstate@^5.30.0
 ```
 
-Peer dependencies: `xstate ^5.0.0`
+## Overview
+
+[`@xmachines/play-dom-router`](README.md) connects a Play actor to the browser URL through the `DomRouterBridge` (extends `RouterBridgeBase` from [`@xmachines/play-router`](../play-router/README.md)):
+
+- Actor route signal (`actor.currentRoute`) drives `history.push()` — actor is authoritative.
+- Browser navigation events (`popstate`, `pushState`, `replaceState`) send `play.route` intents back to the actor.
+- Guarded state transitions remain actor-owned (Actor Authority).
+- Circular update prevention via `isProcessingNavigation` flag — inherited from `RouterBridgeBase`.
+
+## Key Exports
+
+| Export                           | Description                                                                                |
+| -------------------------------- | ------------------------------------------------------------------------------------------ |
+| `createBrowserHistory(options)`  | Wraps `window.history` with a subscribable `BrowserHistory` interface                      |
+| `createRouter(options)`          | Creates a `VanillaRouter` combining `BrowserHistory` and `RouteTree`                       |
+| `connectRouter(options)`         | Connects a `VanillaRouter` to a `Routable` actor — returns a `disconnect` cleanup function |
+| `createRouteMap`                 | Re-exported from `@xmachines/play-router` — builds bidirectional path ↔ state ID map       |
+| `BrowserHistory`                 | Interface for the history wrapper                                                          |
+| `BrowserWindow`                  | Structural window interface (accepts `Window`, JSDOM, or any test double)                  |
+| `VanillaRouter`                  | Interface for the router wrapper                                                           |
+| `ConnectRouterOptions`           | Options type for `connectRouter`                                                           |
+| `RouteLookupContract`            | Structural interface for bidirectional route lookup                                        |
+| `RoutableActor`                  | `AbstractActor & Routable & Viewable` convenience type                                     |
+| `RouterBridge`, `PlayRouteEvent` | Types re-exported from `@xmachines/play-router`                                            |
 
 ## Quick Start
 
@@ -43,42 +54,28 @@ import {
 	connectRouter,
 	createRouteMap,
 } from "@xmachines/play-dom-router";
-import { definePlayer, formatPlayRouteTransitions } from "@xmachines/play-xstate";
-import { setup } from "xstate";
-import type { PlayRouteEvent } from "@xmachines/play-router";
-
-const machine = setup({
-	types: {
-		events: {} as PlayRouteEvent,
-		context: {} as { params: Record<string, string>; query: Record<string, string> },
-	},
-}).createMachine(
-	formatPlayRouteTransitions({
-		id: "app",
-		initial: "home",
-		context: { params: {}, query: {} },
-		states: {
-			home: { id: "home", meta: { route: "/" } },
-			about: { id: "about", meta: { route: "/about" } },
-		},
-	}),
-);
+import { extractMachineRoutes } from "@xmachines/play-router";
 
+// 1. Extract route tree and build route map from your XState machine
+const routeTree = extractMachineRoutes(machine);
 const routeMap = createRouteMap(machine);
+
+// 2. Create browser history wrapper (accepts window or any BrowserWindow-compatible object)
 const history = createBrowserHistory({ window });
-const router = createRouter({ routeTree: machine, history });
 
-const actor = definePlayer({ machine })();
+// 3. Create router
+const router = createRouter({ routeTree, history });
+
+// 4. Start actor and connect
+const actor = definePlayer({ machine, catalog })();
 actor.start();
 
-// Bidirectional sync: actor ↔ browser URL
 const disconnect = connectRouter({ actor, router, routeMap });
 
-// Cleanup on unload
+// Cleanup (e.g. on page unload)
 window.addEventListener("beforeunload", () => {
 	disconnect();
 	router.destroy();
-	actor.stop();
 });
 ```
 
@@ -86,165 +83,170 @@ window.addEventListener("beforeunload", () => {
 
 ### `createBrowserHistory(options)`
 
-Wraps `window.history` with patch-based `pushState`/`replaceState` interception and popstate subscription.
+Wraps `window.history` to provide a subscribable history interface. Patches `pushState`/`replaceState` to detect programmatic navigations in addition to `popstate` events for back/forward.
 
 ```typescript
 const history = createBrowserHistory({ window });
 
+// Subscribe to URL changes
 const unsubscribe = history.subscribe((location) => {
-	console.log("URL changed:", location.pathname, location.search, location.hash);
+	console.log("URL changed:", location.pathname, location.search);
 });
 
+// Programmatic navigation
 history.push("/dashboard");
 history.replace("/login");
-history.back(); // async — popstate fires on next tick
-history.forward();
-history.go(-2);
+history.back();
 
-// Cleanup — idempotent, safe to call multiple times
+// Cleanup — safe to call more than once; cooperates with other wrappers on the same window
 unsubscribe();
-history.destroy(); // restores original pushState/replaceState
+history.destroy();
 ```
 
-**Architecture:** `createBrowserHistory` patches `window.history.pushState` and `window.history.replaceState` to intercept programmatic navigation. Browser back/forward fires a `popstate` event which the history object listens to via `addEventListener`. Multiple wrappers on the same `window` share one patch via a ref-counted `WeakMap` — the original methods are restored only when the last wrapper is destroyed.
+**`BrowserHistory` interface:**
 
-`createBrowserHistory` accepts a `BrowserWindow` structural interface, so JSDOM and custom test doubles work without casting:
+| Method                  | Description                                                                |
+| ----------------------- | -------------------------------------------------------------------------- |
+| `location`              | Read-only `{ pathname, search, hash, state }`                              |
+| `push(path, state?)`    | Push a new entry to history                                                |
+| `replace(path, state?)` | Replace the current history entry                                          |
+| `go(delta)`             | Navigate relative to current position                                      |
+| `back()`                | Navigate backward                                                          |
+| `forward()`             | Navigate forward                                                           |
+| `subscribe(listener)`   | Subscribe to location changes — returns unsubscribe function               |
+| `createHref(path)`      | Create an href from a path                                                 |
+| `destroy()`             | Cleanup — removes listeners and restores patched methods when last wrapper |
 
-```typescript
-// In tests — no casting needed
-const history = createBrowserHistory({ window: jsdomWindow });
-```
+**`BrowserWindow` interface:**
+
+Accepts `window`, a JSDOM window, or any object implementing the structural interface. Covers only properties actually used — avoids coupling to `Window & typeof globalThis`.
 
 ### `createRouter(options)`
 
-Creates a lightweight router that binds a `BrowserHistory` to a route tree extracted from your machine.
+Creates a `VanillaRouter` wrapping `history` and `routeTree`. Designed for parity with TanStack Router's setup flow.
 
 ```typescript
-const router = createRouter({ routeTree: machine, history });
-
-// Returns a VanillaRouter:
-// { history: BrowserHistory, destroy(): void }
-router.destroy(); // removes event listeners, destroys the BrowserHistory
+const router = createRouter({ routeTree, history });
+// router.history — the BrowserHistory instance
+// router.routeTree — for structure reference
+// router.destroy() — calls history.destroy()
 ```
 
 ### `connectRouter(options)`
 
-Establishes bidirectional synchronization between an actor and a `VanillaRouter`:
+Connects a `VanillaRouter` to a `Routable` actor. Handles all bidirectional synchronization:
 
-- `actor.currentRoute` signal → `history.push(url)` (actor-driven URL updates)
-- Browser URL change → `actor.send({ type: "play.route", to: "#stateId" })` (URL-driven state)
-- Single `isProcessingNavigation` guard prevents circular updates
+- On connect: syncs initial URL → actor or actor route → browser (restore vs. deep-link detection).
+- While connected: actor route changes push to history; browser navigations send `play.route` events.
+- Returns a cleanup function that disconnects the bridge.
 
 ```typescript
-const disconnect = connectRouter({ actor, router, routeMap });
+const disconnect = connectRouter({
+	actor, // AbstractActor & Routable
+	router, // VanillaRouter from createRouter()
+	routeMap, // RouteLookupContract — any object with getStateIdByPath / getPathByStateId
+});
 
-// Later — stop all sync and remove listeners
+// Later:
 disconnect();
 ```
 
-### `createRouteMap(machine)`
+**`ConnectRouterOptions`:**
+
+| Option     | Type                       | Description                               |
+| ---------- | -------------------------- | ----------------------------------------- |
+| `actor`    | `AbstractActor & Routable` | Actor to synchronize with the browser URL |
+| `router`   | `VanillaRouter`            | Router from `createRouter()`              |
+| `routeMap` | `RouteLookupContract`      | Bidirectional path ↔ state ID lookup      |
 
-Builds a `RouteMap` from a machine's `meta.route` declarations. Re-exported from for convenience.
+**`RouteLookupContract`:**
 
 ```typescript
-const routeMap = createRouteMap(machine);
-// routeMap maps state IDs ↔ URL patterns
-// Used by connectRouter to translate between actor state and browser URLs
+interface RouteLookupContract {
+	getStateIdByPath(path: string): string | null | undefined;
+	getPathByStateId(id: string): string | null | undefined;
+}
 ```
 
-## Pairing with (rendering)
+Any object satisfying this structural interface is accepted — including `RouteMap` instances from `@xmachines/play-router`, subclasses, or test doubles.
+
+### `createRouteMap` (re-export)
 
-Add declarative JSON-render view rendering on top of the routing layer:
+Re-exported from `@xmachines/play-router`. Builds a bidirectional `RouteMap` from an XState machine:
 
 ```typescript
-import {
-	createBrowserHistory,
-	createRouter,
-	connectRouter,
-	createRouteMap,
-} from "@xmachines/play-dom-router";
-import { createRenderer, schema } from "@xmachines/play-dom";
-import { defineCatalog } from "@json-render/core";
-import { z } from "zod";
-import type { ComponentFn } from "@xmachines/play-dom";
-
-// 1. Define catalog + components
-const catalog = defineCatalog(schema, {
-	components: {
-		Home: { props: z.object({ title: z.string() }) },
-		About: { props: z.object({ title: z.string() }) },
-	},
-	actions: {
-		route: { params: z.object({ to: z.string() }) },
-	},
-});
+import { createRouteMap } from "@xmachines/play-dom-router";
 
-const Home: ComponentFn<typeof catalog, "Home"> = ({ props }) => {
-	const el = document.createElement("section");
-	el.textContent = props.title;
-	return el;
-};
-const About: ComponentFn<typeof catalog, "About"> = ({ props }) => {
-	const el = document.createElement("section");
-	el.textContent = props.title;
-	return el;
-};
-
-// 2. Create renderer factory
-const mount = createRenderer(catalog, { Home, About });
-
-// 3. Wire router + renderer
 const routeMap = createRouteMap(machine);
-const history = createBrowserHistory({ window });
-const router = createRouter({ routeTree: machine, history });
-const actor = definePlayer({ machine })();
-actor.start();
+routeMap.getStateIdByPath("/dashboard"); // "dashboard"
+routeMap.getPathByStateId("dashboard"); // "/dashboard"
+```
 
-const disconnectRouter = connectRouter({ actor, router, routeMap });
-const disconnectRenderer = mount(actor, document.getElementById("app")!);
+## URLPattern Support
 
-// Cleanup
-window.addEventListener("beforeunload", () => {
-	disconnectRenderer();
-	disconnectRouter();
-	router.destroy();
-	actor.stop();
-});
+This package uses the [URLPattern API](https://developer.mozilla.org/en-US/docs/Web/API/URLPattern) for route pattern matching via [`@xmachines/play-router`](../play-router/README.md). URLPattern is available natively on Node.js 24+ and modern browsers (Chrome 95+, Firefox 117+, Safari 16.4+). On older environments, load a polyfill **before** importing this package — see [`@xmachines/play-router`](../play-router/README.md) for details.
+
+## Testing
+
+Run tests in isolation:
+
+```bash
+npm test
+# or from monorepo root:
+npm test -w @xmachines/play-dom-router
 ```
 
-## `BrowserHistory` interface
+Tests run in Node.js environment with `URLPattern` polyfill setup. Browser-specific tests are in `test/browser/` and run separately via `vitest.browser.config.ts`.
 
-```typescript
-interface BrowserHistory {
-	readonly location: {
-		pathname: string;
-		search: string;
-		hash: string;
-		state: unknown;
-	};
-	push(path: string, state?: unknown): void;
-	replace(path: string, state?: unknown): void;
-	go(delta: number): void;
-	back(): void;
-	forward(): void;
-	subscribe(listener: (location: BrowserHistory["location"]) => void): () => void;
-	createHref(path: string): string;
-	/**
-	 * Restore original pushState/replaceState. Idempotent. Cooperates with
-	 * other wrappers sharing the same window — originals restored only after
-	 * the last wrapper is destroyed.
-	 */
-	destroy(): void;
-}
+Coverage thresholds:
+
+| Type       | Threshold |
+| ---------- | --------- |
+| Lines      | 80%       |
+| Functions  | 80%       |
+| Branches   | 75%       |
+| Statements | 80%       |
+
+## Architecture
+
+The bridge-first data flow:
+
+1. `connectRouter` instantiates `DomRouterBridge` (extends `RouterBridgeBase`) and calls `bridge.connect()`.
+2. On connect, `RouterBridgeBase` performs initial sync: if browser URL differs from actor route, a `play.route` event is sent; if actor route differs and browser is at the machine's initial route (restore scenario), the actor wins and history is updated.
+3. Actor route changes (via `currentRoute` Signal) trigger `history.push(path)`.
+4. Browser URL changes (popstate, patched pushState/replaceState) call `syncActorFromRouter(pathname, search)`, which sends a `play.route` event.
+5. Circular updates are prevented by the `isProcessingNavigation` flag in `RouterBridgeBase`.
+
+```
+Browser URL
+    │  popstate / pushState / replaceState
+    ▼
+DomRouterBridge
+    │  play.route event
+    ▼
+Actor (XState machine)
+    │  currentRoute Signal change
+    ▼
+DomRouterBridge
+    │  history.push(path)
+    ▼
+Browser URL
 ```
 
-## Learn More
+## Related Packages
+
+- [@xmachines/play-router](../play-router/README.md) — `RouterBridgeBase`, `createRouteMap`, `extractMachineRoutes`
+- [@xmachines/play-actor](../play-actor/README.md) — `AbstractActor`, `Routable`, `Viewable`
+- [@xmachines/play-dom](../play-dom/README.md) — Vanilla DOM renderer for view rendering alongside routing
+- [@xmachines/play-xstate](../play-xstate/README.md) — `definePlayer`, `PlayerActor`
+
+## Part of the XMachines monorepo
+
+This package is part of the [xmachines-js](../../README.md) monorepo.
+
+## License
 
-- [Demo](../../../examples/@xmachines/play-dom-router-demo/README.md)
-- [Vanilla DOM renderer](../play-dom/README.md)
-- [Router core](../play-router/README.md)
-- [Routing Patterns guide](../../packages/docs/examples/routing-patterns.md)
-- [Play RFC](../../packages/docs/rfc/play.md)
+MIT — see [LICENSE](LICENSE).
 
 ## Interfaces
 

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

@@ -6,7 +6,7 @@
 function connectRouter(options): () => void;
 ```
 
-Defined in: [play-dom-router/src/connect-router.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/connect-router.ts#L48)
+Defined in: [play-dom-router/src/connect-router.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/connect-router.ts#L48)
 
 Connect vanilla router to actor (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:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L120)
+Defined in: [play-dom-router/src/create-browser-history.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L120)
 
 Create browser history that wraps window.history
 

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

@@ -6,7 +6,7 @@
 function createRouteMap(machine, options?): RouteMap;
 ```
 
-Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map.ts#L45)
+Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/create-route-map.ts#L45)
 
 Create a `RouteMap` from an XState state machine.
 

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:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-router.ts#L52)
+Defined in: [play-dom-router/src/create-router.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-router.ts#L52)
 
 Create vanilla router for framework-agnostic routing.
 

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/v1.0.0-beta.45/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/v1.0.0-beta.48/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`  | Get current location state | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/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/v1.0.0-beta.45/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/v1.0.0-beta.45/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/v1.0.0-beta.45/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/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L9) |
+| <a id="property-location"></a> `location` | `readonly` | `object`  | Get current location state | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/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/v1.0.0-beta.48/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/v1.0.0-beta.48/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/v1.0.0-beta.48/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/v1.0.0-beta.48/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/v1.0.0-beta.45/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/v1.0.0-beta.48/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:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L38)
+Defined in: [play-dom-router/src/create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L38)
 
 Create href from path
 
@@ -58,7 +58,7 @@ Create href from path
 destroy(): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L47)
+Defined in: [play-dom-router/src/create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L47)
 
 Cleanup.
 
@@ -78,7 +78,7 @@ wrapper is destroyed.
 forward(): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/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/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L27)
 
 #### Returns
 
@@ -92,7 +92,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/v1.0.0-beta.45/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/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L25)
 
 Go back/forward
 
@@ -114,7 +114,7 @@ Go back/forward
 push(path, state?): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/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/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L15)
 
 Push new URL to history
 
@@ -137,7 +137,7 @@ Push new URL to history
 replace(path, state?): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/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/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L20)
 
 Replace current URL in history
 
@@ -160,7 +160,7 @@ Replace current URL in history
 subscribe(listener): () => void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L33)
+Defined in: [play-dom-router/src/create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L33)
 
 Subscribe to history changes
 Returns unsubscribe function

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:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L59)
+Defined in: [play-dom-router/src/create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L59)
 
 Minimal window interface for createBrowserHistory
 
@@ -14,17 +14,17 @@ Avoids coupling to `Window & typeof globalThis` which varies across environments
 
 | Property                                  | Modifier   | Type      | Defined in                                                                                                                                                                      |
 | ----------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-history"></a> `history`   | `public`   | `object`  | [play-dom-router/src/create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L60) |
-| `history.state`                           | `readonly` | `unknown` | [play-dom-router/src/create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L61) |
-| `history.back`                            | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L65) |
-| `history.forward`                         | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L66) |
-| `history.go`                              | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L64) |
-| `history.pushState`                       | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L62) |
-| `history.replaceState`                    | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L63) |
-| <a id="property-location"></a> `location` | `public`   | `object`  | [play-dom-router/src/create-browser-history.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L68) |
-| `location.hash`                           | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L71) |
-| `location.pathname`                       | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L69) |
-| `location.search`                         | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L70) |
+| <a id="property-history"></a> `history`   | `public`   | `object`  | [play-dom-router/src/create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L60) |
+| `history.state`                           | `readonly` | `unknown` | [play-dom-router/src/create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L61) |
+| `history.back`                            | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L65) |
+| `history.forward`                         | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L66) |
+| `history.go`                              | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L64) |
+| `history.pushState`                       | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L62) |
+| `history.replaceState`                    | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L63) |
+| <a id="property-location"></a> `location` | `public`   | `object`  | [play-dom-router/src/create-browser-history.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L68) |
+| `location.hash`                           | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L71) |
+| `location.pathname`                       | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L69) |
+| `location.search`                         | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L70) |
 
 ## Methods
 
@@ -34,7 +34,7 @@ Avoids coupling to `Window & typeof globalThis` which varies across environments
 addEventListener(type, listener): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L73)
+Defined in: [play-dom-router/src/create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L73)
 
 #### Parameters
 
@@ -55,7 +55,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:73](https://gitlab.co
 removeEventListener(type, listener): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-dom-router/src/create-browser-history.ts#L74)
+Defined in: [play-dom-router/src/create-browser-history.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom-router/src/create-browser-history.ts#L74)
 
 #### Parameters