@xmachines/docs 1.0.0-beta.31 → 1.0.0-beta.33

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

@@ -6,4 +6,4 @@
 type DomSchema = typeof schema;
 ```
 
-Defined in: [json-render/schema.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/schema.ts#L60)
+Defined in: [json-render/schema.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-dom/src/json-render/schema.ts#L60)

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

@@ -0,0 +1,30 @@
+[Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / SetState
+
+# Type Alias: SetState
+
+```ts
+type SetState = (updater) => void;
+```
+
+Defined in: [json-render/types.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-dom/src/json-render/types.ts#L45)
+
+Function to update the local state store.
+
+Mirrors `SetState` from @json-render/react, /solid, /vue, /svelte.
+In the DOM renderer, this writes through to the @xstate/store-backed StateStore.
+
+## Parameters
+
+| Parameter | Type                                        |
+| --------- | ------------------------------------------- |
+| `updater` | (`prev`) => `Record`\<`string`, `unknown`\> |
+
+## Returns
+
+`void`
+
+## Example
+
+```ts
+setState((prev) => ({ ...prev, username: "alice" }));
+```

package/api/@xmachines/play-dom/variables/schema.md

@@ -46,7 +46,7 @@ const schema: Schema<{
 }>;
 ```
 
-Defined in: [json-render/schema.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/schema.ts#L20)
+Defined in: [json-render/schema.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-dom/src/json-render/schema.ts#L20)
 
 The schema for @xmachines/play-dom
 

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

@@ -4,17 +4,18 @@
 
 **Vanilla DOM router integration for XMachines**
 
-Browser History API wrapper, framework-agnostic router, and bidirectional actor ↔ URL synchronization for XState v5 machines — without any JSX or framework dependency.
+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` contains the **concrete browser implementations** that were intentionally separated from the environment-agnostic `@xmachines/play-router` core:
+`@xmachines/play-dom-router` provides the **concrete browser implementations** intentionally separated from the environment-agnostic `@xmachines/play-router` core:
 
-| Export                 | Description                                                                                                                 |
-| ---------------------- | --------------------------------------------------------------------------------------------------------------------------- |
-| `createBrowserHistory` | Wraps `window.history` with a subscriber API compatible with TanStack Router's history interface                            |
-| `createRouter`         | Lightweight router that binds a `BrowserHistory` to a route tree — no JSX required                                          |
-| `connectRouter`        | Bidirectional actor ↔ URL synchronization using a single navigation-processing guard (matches `RouterBridgeBase` semantics) |
+| 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                                           |
 
 By keeping these in a dedicated package, server-side and non-browser environments can depend on `@xmachines/play-router` without pulling in any DOM APIs.
 
@@ -23,6 +24,7 @@ For JSX frameworks, use the framework adapters instead:
 - `@xmachines/play-react` + `@xmachines/play-react-router`
 - `@xmachines/play-vue` + `@xmachines/play-vue-router`
 - `@xmachines/play-solid` + `@xmachines/play-solid-router`
+- `@xmachines/play-svelte` + `@xmachines/play-sveltekit-router`
 
 ## Installation
 
@@ -30,114 +32,219 @@ For JSX frameworks, use the framework adapters instead:
 npm install @xmachines/play-dom-router @xmachines/play-router
 ```
 
-**Peer dependencies:**
-
-- `xstate` ^5.0.0 — State machine runtime
+Peer dependencies: `xstate ^5.0.0`
 
 ## Quick Start
 
 ```typescript
-import { createBrowserHistory, createRouter, connectRouter } from "@xmachines/play-dom-router";
-import { extractMachineRoutes, createRouteMap } from "@xmachines/play-router";
-import { createActor } from "xstate";
-
-// Extract route tree from your machine
-const routeTree = extractMachineRoutes(machine);
-const routeMap = createRouteMap(routeTree);
-
-// Set up browser history and router
+import {
+	createBrowserHistory,
+	createRouter,
+	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" } },
+		},
+	}),
+);
+
+const routeMap = createRouteMap(machine);
 const history = createBrowserHistory({ window });
-const router = createRouter({ routeTree, history });
+const router = createRouter({ routeTree: machine, history });
 
-// Create and start actor
-const actor = createActor(machine);
+const actor = definePlayer({ machine })();
 actor.start();
 
-// Connect router ↔ actor (bidirectional URL sync)
+// Bidirectional sync: actor ↔ browser URL
 const disconnect = connectRouter({ actor, router, routeMap });
 
-// Handle rendering manually (vanilla JS, Alpine, HTMX, etc.)
-const watcher = new Signal.subtle.Watcher(() => {
-	queueMicrotask(() => {
-		const view = actor.currentView.get();
-		document.getElementById("app").innerHTML = render(view);
-	});
+// Cleanup on unload
+window.addEventListener("beforeunload", () => {
+	disconnect();
+	router.destroy();
+	actor.stop();
 });
-watcher.watch(actor.currentView);
-
-// Later: cleanup
-disconnect();
-router.destroy();
-watcher.unwatch(actor.currentView);
 ```
 
 ## API
 
 ### `createBrowserHistory(options)`
 
-Wraps `window.history` with patch-based pushState/replaceState interception and a `subscribe()` API.
+Wraps `window.history` with patch-based `pushState`/`replaceState` interception and popstate subscription.
 
 ```typescript
 const history = createBrowserHistory({ window });
 
 const unsubscribe = history.subscribe((location) => {
-	console.log("URL changed:", location.pathname);
+	console.log("URL changed:", location.pathname, location.search, location.hash);
 });
 
 history.push("/dashboard");
 history.replace("/login");
-history.back();
+history.back(); // async — popstate fires on next tick
+history.forward();
+history.go(-2);
 
-// Cleanup (idempotent — safe to call multiple times)
+// Cleanup — idempotent, safe to call multiple times
 unsubscribe();
-history.destroy();
+history.destroy(); // restores original pushState/replaceState
 ```
 
-`createBrowserHistory` accepts a `BrowserWindow` structural interface (not the full `Window` type), so JSDOM and custom test doubles work without casting.
+**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.
+
+`createBrowserHistory` accepts a `BrowserWindow` structural interface, so JSDOM and custom test doubles work without casting:
+
+```typescript
+// In tests — no casting needed
+const history = createBrowserHistory({ window: jsdomWindow });
+```
 
 ### `createRouter(options)`
 
-Creates a lightweight router that binds a `BrowserHistory` to a `RouteTree`.
+Creates a lightweight router that binds a `BrowserHistory` to a route tree extracted from your machine.
 
 ```typescript
-const router = createRouter({ routeTree, history });
+const router = createRouter({ routeTree: machine, history });
 
-// Returns: { history, destroy() }
-router.destroy();
+// Returns a VanillaRouter:
+// { history: BrowserHistory, destroy(): void }
+router.destroy(); // removes event listeners, destroys the BrowserHistory
 ```
 
 ### `connectRouter(options)`
 
-Connects a `VanillaRouter` to an `AbstractActor & Routable`, establishing bidirectional synchronization:
+Establishes bidirectional synchronization between an actor and a `VanillaRouter`:
 
-- History changes → `play.route` sent to actor
-- Actor `currentRoute` signal changes → browser URL updated via `history.push`
+- `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
 
 ```typescript
 const disconnect = connectRouter({ actor, router, routeMap });
 
-// Later:
+// Later — stop all sync and remove listeners
 disconnect();
 ```
 
-## Use with `play-dom` (rendering)
+### `createRouteMap(machine)`
 
-Pair this package with `@xmachines/play-dom` to add declarative rendering on top of the routing layer:
+Builds a `RouteMap` from a machine's `meta.route` declarations. Re-exported from `@xmachines/play-router` for convenience.
 
 ```typescript
-import { connectRouter } from "@xmachines/play-dom-router";
-import { PlayRenderer } from "@xmachines/play-dom";
+const routeMap = createRouteMap(machine);
+// routeMap maps state IDs ↔ URL patterns
+// Used by connectRouter to translate between actor state and browser URLs
+```
 
-const disconnect = connectRouter({ actor, router, routeMap });
-const stopRenderer = PlayRenderer.connect(actor, registry, document.getElementById("app"));
+## Pairing with `@xmachines/play-dom` (rendering)
 
-// Later:
-disconnect();
-stopRenderer();
-router.destroy();
+Add declarative JSON-render view rendering on top of the routing layer:
+
+```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() }) },
+	},
+});
+
+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();
+
+const disconnectRouter = connectRouter({ actor, router, routeMap });
+const disconnectRenderer = mount(actor, document.getElementById("app")!);
+
+// Cleanup
+window.addEventListener("beforeunload", () => {
+	disconnectRenderer();
+	disconnectRouter();
+	router.destroy();
+	actor.stop();
+});
 ```
 
+## `BrowserHistory` interface
+
+```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;
+}
+```
+
+## Learn More
+
+- [Vanilla DOM renderer `@xmachines/play-dom`](../play-dom/README.md)
+- [Router core `@xmachines/play-router`](../play-router/README.md)
+- [Routing Patterns guide](../../packages/docs/examples/routing-patterns.md)
+- [Play RFC](../../packages/docs/rfc/play.md)
+
 ## Interfaces
 
 - [BrowserHistory](interfaces/BrowserHistory.md)

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.31/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.33/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.31/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.33/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): RouteMap;
 ```
 
-Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/create-route-map-from-machine.ts#L26)
+Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/create-route-map-from-machine.ts#L26)
 
 Create a `BaseRouteMap` 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.31/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.33/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.31/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.33/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.31/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.31/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.31/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.31/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.31/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.33/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.33/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.33/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.33/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.33/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.31/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.33/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.31/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.33/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.31/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.33/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.31/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.33/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.31/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.33/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.31/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.33/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.31/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.33/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.31/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.33/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.31/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.33/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.31/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.31/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.31/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.31/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.31/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.31/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.31/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.31/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.31/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.31/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.31/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.33/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.33/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.33/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.33/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.33/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.33/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.33/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.33/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.33/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.33/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.33/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.31/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.33/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.31/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.33/packages/play-dom-router/src/create-browser-history.ts#L74)
 
 #### Parameters
 

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

@@ -2,7 +2,7 @@
 
 # Interface: ConnectRouterOptions
 
-Defined in: [play-dom-router/src/connect-router.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/connect-router.ts#L20)
+Defined in: [play-dom-router/src/connect-router.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-dom-router/src/connect-router.ts#L20)
 
 Options for [connectRouter](../functions/connectRouter.md).
 
@@ -10,6 +10,6 @@ Options for [connectRouter](../functions/connectRouter.md).
 
 | Property                                  | Modifier   | Type                                                                                                                                                                                                                                                             | Description                                                                 | Defined in                                                                                                                                                      |
 | ----------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`       | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | The actor to synchronize with the browser URL. Must implement `Routable`.   | [play-dom-router/src/connect-router.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/connect-router.ts#L22) |
-| <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMapLike`](RouteMapLike.md)                                                                                                                                                                                                                                | Route map used to resolve URL pathnames to machine state IDs.               | [play-dom-router/src/connect-router.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/connect-router.ts#L26) |
-| <a id="property-router"></a> `router`     | `readonly` | [`VanillaRouter`](VanillaRouter.md)                                                                                                                                                                                                                              | The vanilla router created by [createRouter](../functions/createRouter.md). | [play-dom-router/src/connect-router.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/connect-router.ts#L24) |
+| <a id="property-actor"></a> `actor`       | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | The actor to synchronize with the browser URL. Must implement `Routable`.   | [play-dom-router/src/connect-router.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-dom-router/src/connect-router.ts#L22) |
+| <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMapLike`](RouteMapLike.md)                                                                                                                                                                                                                                | Route map used to resolve URL pathnames to machine state IDs.               | [play-dom-router/src/connect-router.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-dom-router/src/connect-router.ts#L26) |
+| <a id="property-router"></a> `router`     | `readonly` | [`VanillaRouter`](VanillaRouter.md)                                                                                                                                                                                                                              | The vanilla router created by [createRouter](../functions/createRouter.md). | [play-dom-router/src/connect-router.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-dom-router/src/connect-router.ts#L24) |

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

@@ -2,7 +2,7 @@
 
 # Interface: PlayRouteEvent
 
-Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L223)
+Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L223)
 
 Enhanced routing event with parameter and query support
 
@@ -112,8 +112,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
 
 | Property                               | Modifier   | Type                           | Defined in                                                                                                                              |
 | -------------------------------------- | ---------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                      | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L228) |
-| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L226) |
-| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L227) |
-| <a id="property-to"></a> `to`          | `readonly` | `string`                       | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L225) |
-| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                 | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L224) |
+| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                      | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L228) |
+| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L226) |
+| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L227) |
+| <a id="property-to"></a> `to`          | `readonly` | `string`                       | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L225) |
+| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                 | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L224) |