@xmachines/docs 1.0.0-beta.18 → 1.0.0-beta.20

package/api/@xmachines/play-router/functions/findRouteById.md

@@ -6,7 +6,7 @@
 function findRouteById(tree, id): RouteNode | undefined;
 ```
 
-Defined in: [index.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/index.ts#L70)
+Defined in: [find-route.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/find-route.ts#L91)
 
 Find route node by state ID
 

package/api/@xmachines/play-router/functions/findRouteByPath.md

@@ -6,7 +6,7 @@
 function findRouteByPath(tree, path): RouteNode | undefined;
 ```
 
-Defined in: [index.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/index.ts#L162)
+Defined in: [find-route.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/find-route.ts#L116)
 
 Find route node by URL path
 

package/api/@xmachines/play-router/functions/getNavigableRoutes.md

@@ -6,7 +6,7 @@
 function getNavigableRoutes(tree, stateId): RouteNode[];
 ```
 
-Defined in: [query.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/query.ts#L20)
+Defined in: [query.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/query.ts#L22)
 
 Get all routes navigable from given state
 

package/api/@xmachines/play-router/functions/getRoutableRoutes.md

@@ -6,7 +6,7 @@
 function getRoutableRoutes(tree): RouteNode[];
 ```
 
-Defined in: [query.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/query.ts#L50)
+Defined in: [query.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/query.ts#L67)
 
 Get all routable routes from tree as flat array
 

package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md

@@ -0,0 +1,38 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / getTransitionReachableRoutes
+
+# Function: getTransitionReachableRoutes()
+
+```ts
+function getTransitionReachableRoutes(graph, stateId): string[];
+```
+
+Defined in: [query.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/query.ts#L113)
+
+Get routes reachable via transitions from current state
+
+Uses the @statelyai/graph successor algorithm to find all states
+directly reachable via transition edges from the given state,
+then filters to those with defined routes.
+
+## Parameters
+
+| Parameter | Type                                                                                                                    | Description                          |
+| --------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
+| `graph`   | `Graph`\<[`MachineNodeData`](../interfaces/MachineNodeData.md), [`MachineEdgeData`](../interfaces/MachineEdgeData.md)\> | Machine graph from RouteTree.graph   |
+| `stateId` | `string`                                                                                                                | Current state ID (e.g., "test.home") |
+
+## Returns
+
+`string`[]
+
+Array of route paths reachable via transitions
+
+## Example
+
+```typescript
+const tree = extractMachineRoutes(machine);
+if (tree.graph) {
+	const reachable = getTransitionReachableRoutes(tree.graph, "auth.loggedIn");
+	// ['/dashboard', '/settings'] — routes reachable via transitions
+}
+```

package/api/@xmachines/play-router/functions/isRouteReachable.md

@@ -0,0 +1,38 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / isRouteReachable
+
+# Function: isRouteReachable()
+
+```ts
+function isRouteReachable(graph, fromStateId, toStateId): boolean;
+```
+
+Defined in: [query.ts:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/query.ts#L149)
+
+Check if a route is reachable from current state via transitions
+
+Uses @statelyai/graph path-finding to determine if there exists
+a chain of transition edges from the source state to the target state.
+
+## Parameters
+
+| Parameter     | Type                                                                                                                    | Description                        |
+| ------------- | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
+| `graph`       | `Graph`\<[`MachineNodeData`](../interfaces/MachineNodeData.md), [`MachineEdgeData`](../interfaces/MachineEdgeData.md)\> | Machine graph from RouteTree.graph |
+| `fromStateId` | `string`                                                                                                                | Source state ID                    |
+| `toStateId`   | `string`                                                                                                                | Target state ID                    |
+
+## Returns
+
+`boolean`
+
+true if a transition path exists, false otherwise
+
+## Example
+
+```typescript
+const tree = extractMachineRoutes(machine);
+if (tree.graph) {
+	const canReach = isRouteReachable(tree.graph, "auth.login", "auth.dashboard");
+	// true if login → dashboard transition path exists
+}
+```

package/api/@xmachines/play-router/functions/machineToGraph.md

@@ -0,0 +1,19 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / machineToGraph
+
+# Function: machineToGraph()
+
+```ts
+function machineToGraph(machine): MachineGraph;
+```
+
+Defined in: [machine-to-graph.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/machine-to-graph.ts#L70)
+
+## Parameters
+
+| Parameter | Type                                                                      |
+| --------- | ------------------------------------------------------------------------- |
+| `machine` | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
+
+## Returns
+
+[`MachineGraph`](../type-aliases/MachineGraph.md)

package/api/@xmachines/play-router/functions/routeExists.md

@@ -6,7 +6,7 @@
 function routeExists(tree, path): boolean;
 ```
 
-Defined in: [query.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/query.ts#L72)
+Defined in: [query.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/query.ts#L89)
 
 Validate route path exists in tree
 

package/api/@xmachines/play-router/functions/sanitizePathname.md

@@ -0,0 +1,40 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / sanitizePathname
+
+# Function: sanitizePathname()
+
+```ts
+function sanitizePathname(pathname): string | null;
+```
+
+Defined in: [router-sync.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-sync.ts#L63)
+
+Normalize a pathname before route-map lookup.
+
+This strips query/hash fragments, collapses duplicate slashes, and rejects
+implausibly long paths that should never enter route resolution.
+
+Returns `null` for paths exceeding 2048 characters (malformed/adversarial input).
+Adapters that bypass `RouterBridgeBase.syncActorFromRouter()` (e.g. `VueRouterBridge`)
+must call this function directly and return early on `null` to apply the same
+defense-in-depth security guarantee as the shared base class.
+
+## Parameters
+
+| Parameter  | Type     | Description                                   |
+| ---------- | -------- | --------------------------------------------- |
+| `pathname` | `string` | Raw path string from router navigation event. |
+
+## Returns
+
+`string` \| `null`
+
+Normalized path string, or `null` if the path is malformed/too long.
+
+## Example
+
+```typescript
+import { sanitizePathname } from "@xmachines/play-router";
+
+const clean = sanitizePathname(to.path);
+if (clean === null) return; // reject malformed path
+```

package/api/@xmachines/play-router/functions/validateRouteFormat.md

@@ -6,19 +6,20 @@
 function validateRouteFormat(routePath, stateId): void;
 ```
 
-Defined in: [validate-routes.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/validate-routes.ts#L14)
+Defined in: [validate-routes.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/validate-routes.ts#L14)
 
 Validate route path format
 
-Ensures route paths start with "/" (absolute or relative).
-Per Route Protocol spec, all routes must have explicit path structure.
+Ensures route paths are non-empty strings. Both absolute paths ("/foo")
+and relative paths ("foo", "child/nested") are accepted. Relative routes
+inherit their parent state's path prefix when the tree is built.
 
 ## Parameters
 
-| Parameter   | Type     | Description                         |
-| ----------- | -------- | ----------------------------------- |
-| `routePath` | `string` | Route path to validate              |
-| `stateId`   | `string` | State identifier for error messages |
+| Parameter   | Type     | Description                                   |
+| ----------- | -------- | --------------------------------------------- |
+| `routePath` | `string` | Route path to validate (absolute or relative) |
+| `stateId`   | `string` | State identifier for error messages           |
 
 ## Returns
 
@@ -26,4 +27,4 @@ Per Route Protocol spec, all routes must have explicit path structure.
 
 ## Throws
 
-If route path doesn't start with /
+If route path is empty

package/api/@xmachines/play-router/functions/validateStateExists.md

@@ -3,22 +3,22 @@
 # Function: validateStateExists()
 
 ```ts
-function validateStateExists(stateId, stateMap): void;
+function validateStateExists(stateId, stateIds): void;
 ```
 
-Defined in: [validate-routes.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/validate-routes.ts#L32)
+Defined in: [validate-routes.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/validate-routes.ts#L32)
 
-Validate state exists in state map
+Validate state exists in state ID set
 
 Ensures referenced state IDs exist in the machine graph.
 Build-time validation prevents broken route references.
 
 ## Parameters
 
-| Parameter  | Type                                                                                                                                                                                                                           | Description                        |
-| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------- |
-| `stateId`  | `string`                                                                                                                                                                                                                       | State identifier to validate       |
-| `stateMap` | `Map`\<`string`, [`StateNode`](https://www.jsdocs.io/package/xstate#StateNode)\<[`MachineContext`](https://www.jsdocs.io/package/xstate#MachineContext), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\>\> | Map of all state IDs to StateNodes |
+| Parameter  | Type              | Description                                       |
+| ---------- | ----------------- | ------------------------------------------------- |
+| `stateId`  | `string`          | State identifier to validate                      |
+| `stateIds` | `Set`\<`string`\> | Set of all known state IDs from the machine graph |
 
 ## Returns
 
@@ -26,4 +26,4 @@ Build-time validation prevents broken route references.
 
 ## Throws
 
-If state ID doesn't exist in map
+If state ID doesn't exist in set

package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md

@@ -2,7 +2,7 @@
 
 # Interface: BaseRouteMapping
 
-Defined in: [base-route-map.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/base-route-map.ts#L64)
+Defined in: [base-route-map.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/base-route-map.ts#L64)
 
 A single state ID ↔ path mapping entry.
 
@@ -23,5 +23,5 @@ const optionalMapping: BaseRouteMapping = { stateId: "settings", path: "/setting
 
 | Property                                | Modifier   | Type     | Description                                                                   | Defined in                                                                                                                              |
 | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-path"></a> `path`       | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [base-route-map.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/base-route-map.ts#L68) |
-| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`)                         | [base-route-map.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/base-route-map.ts#L66) |
+| <a id="property-path"></a> `path`       | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [base-route-map.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/base-route-map.ts#L68) |
+| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`)                         | [base-route-map.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/base-route-map.ts#L66) |

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

@@ -2,17 +2,17 @@
 
 # Interface: BrowserHistory
 
-Defined in: [create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L1)
+Defined in: [create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-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 | [create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L5) |
-| `location.hash`                           | `public`   | `string`  | -                          | [create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L8) |
-| `location.pathname`                       | `public`   | `string`  | -                          | [create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L6) |
-| `location.search`                         | `public`   | `string`  | -                          | [create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L7) |
-| `location.state`                          | `public`   | `unknown` | -                          | [create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L9) |
+| <a id="property-location"></a> `location` | `readonly` | `object`  | Get current location state | [create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L5) |
+| `location.hash`                           | `public`   | `string`  | -                          | [create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L8) |
+| `location.pathname`                       | `public`   | `string`  | -                          | [create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L6) |
+| `location.search`                         | `public`   | `string`  | -                          | [create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L7) |
+| `location.state`                          | `public`   | `unknown` | -                          | [create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L9) |
 
 ## Methods
 
@@ -22,7 +22,7 @@ Defined in: [create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachine
 back(): void;
 ```
 
-Defined in: [create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L26)
+Defined in: [create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L26)
 
 #### Returns
 
@@ -36,7 +36,7 @@ Defined in: [create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachin
 createHref(path): string;
 ```
 
-Defined in: [create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L38)
+Defined in: [create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L38)
 
 Create href from path
 
@@ -58,7 +58,7 @@ Create href from path
 destroy(): void;
 ```
 
-Defined in: [create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L47)
+Defined in: [create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L47)
 
 Cleanup.
 
@@ -78,7 +78,7 @@ wrapper is destroyed.
 forward(): void;
 ```
 
-Defined in: [create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L27)
+Defined in: [create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L27)
 
 #### Returns
 
@@ -92,7 +92,7 @@ Defined in: [create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachin
 go(delta): void;
 ```
 
-Defined in: [create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L25)
+Defined in: [create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L25)
 
 Go back/forward
 
@@ -114,7 +114,7 @@ Go back/forward
 push(path, state?): void;
 ```
 
-Defined in: [create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L15)
+Defined in: [create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-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: [create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L20)
+Defined in: [create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-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: [create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L33)
+Defined in: [create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L33)
 
 Subscribe to history changes
 Returns unsubscribe function

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

@@ -2,7 +2,7 @@
 
 # Interface: BrowserWindow
 
-Defined in: [create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L59)
+Defined in: [create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-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`  | [create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L60) |
-| `history.state`                           | `readonly` | `unknown` | [create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L61) |
-| `history.back`                            | `public`   | `void`    | [create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L65) |
-| `history.forward`                         | `public`   | `void`    | [create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L66) |
-| `history.go`                              | `public`   | `void`    | [create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L64) |
-| `history.pushState`                       | `public`   | `void`    | [create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L62) |
-| `history.replaceState`                    | `public`   | `void`    | [create-browser-history.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L63) |
-| <a id="property-location"></a> `location` | `public`   | `object`  | [create-browser-history.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L68) |
-| `location.hash`                           | `readonly` | `string`  | [create-browser-history.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L71) |
-| `location.pathname`                       | `readonly` | `string`  | [create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L69) |
-| `location.search`                         | `readonly` | `string`  | [create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L70) |
+| <a id="property-history"></a> `history`   | `public`   | `object`  | [create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L60) |
+| `history.state`                           | `readonly` | `unknown` | [create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L61) |
+| `history.back`                            | `public`   | `void`    | [create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L65) |
+| `history.forward`                         | `public`   | `void`    | [create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L66) |
+| `history.go`                              | `public`   | `void`    | [create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L64) |
+| `history.pushState`                       | `public`   | `void`    | [create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L62) |
+| `history.replaceState`                    | `public`   | `void`    | [create-browser-history.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L63) |
+| <a id="property-location"></a> `location` | `public`   | `object`  | [create-browser-history.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L68) |
+| `location.hash`                           | `readonly` | `string`  | [create-browser-history.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L71) |
+| `location.pathname`                       | `readonly` | `string`  | [create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L69) |
+| `location.search`                         | `readonly` | `string`  | [create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-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: [create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L73)
+Defined in: [create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L73)
 
 #### Parameters
 
@@ -55,7 +55,7 @@ Defined in: [create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachin
 removeEventListener(type, listener): void;
 ```
 
-Defined in: [create-browser-history.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-browser-history.ts#L74)
+Defined in: [create-browser-history.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-browser-history.ts#L74)
 
 #### Parameters
 

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

@@ -2,12 +2,12 @@
 
 # Interface: ConnectRouterOptions
 
-Defined in: [connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/connect-router.ts#L8)
+Defined in: [connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/connect-router.ts#L8)
 
 ## Properties
 
 | Property                                  | Type                                                                                                                                                                                                                                                             | Defined in                                                                                                                              |
 | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`       | [`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) | [connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/connect-router.ts#L9)   |
-| <a id="property-routemap"></a> `routeMap` | [`RouteMap`](RouteMap.md)                                                                                                                                                                                                                                        | [connect-router.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/connect-router.ts#L11) |
-| <a id="property-router"></a> `router`     | [`VanillaRouter`](VanillaRouter.md)                                                                                                                                                                                                                              | [connect-router.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/connect-router.ts#L10) |
+| <a id="property-actor"></a> `actor`       | [`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) | [connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/connect-router.ts#L9)   |
+| <a id="property-routemap"></a> `routeMap` | [`RouteMap`](RouteMap.md)                                                                                                                                                                                                                                        | [connect-router.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/connect-router.ts#L11) |
+| <a id="property-router"></a> `router`     | [`VanillaRouter`](VanillaRouter.md)                                                                                                                                                                                                                              | [connect-router.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/connect-router.ts#L10) |

package/api/@xmachines/play-router/interfaces/MachineEdgeData.md

@@ -0,0 +1,15 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / MachineEdgeData
+
+# Interface: MachineEdgeData
+
+Defined in: [types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L22)
+
+Data attached to each edge in the machine graph representation.
+Captures transition event and guard information.
+
+## Properties
+
+| Property                                     | Type     | Description                                  | Defined in                                                                                                            |
+| -------------------------------------------- | -------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-eventtype"></a> `eventType`  | `string` | The event type that triggers this transition | [types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L24) |
+| <a id="property-guardtype"></a> `guardType?` | `string` | String representation of guard (if any)      | [types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L26) |

package/api/@xmachines/play-router/interfaces/MachineNodeData.md

@@ -0,0 +1,17 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / MachineNodeData
+
+# Interface: MachineNodeData
+
+Defined in: [types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L7)
+
+Data attached to each node in the machine graph representation.
+Captures the essential state metadata needed for route extraction and queries.
+
+## Properties
+
+| Property                                | Type                                                                   | Description                                        | Defined in                                                                                                            |
+| --------------------------------------- | ---------------------------------------------------------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-meta"></a> `meta?`      | `Record`\<`string`, `unknown`\>                                        | Original state meta object                         | [types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L13) |
+| <a id="property-route"></a> `route?`    | `string`                                                               | Extracted route path from meta.route (string form) | [types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L15) |
+| <a id="property-stateid"></a> `stateId` | `string`                                                               | XState state ID (e.g., "test.dashboard.overview")  | [types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L9)   |
+| <a id="property-type"></a> `type`       | `"atomic"` \| `"compound"` \| `"parallel"` \| `"final"` \| `"history"` | State type from XState                             | [types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L11) |

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

@@ -2,7 +2,7 @@
 
 # Interface: PlayRouteEvent
 
-Defined in: [types.ts:190](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/types.ts#L190)
+Defined in: [types.ts:216](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L216)
 
 Enhanced routing event with parameter and query support
 
@@ -94,7 +94,7 @@ actor.send(event);
 
 ## See
 
-[RFC Play v1](https://gitlab.com/xmachin-es/rfc/-/blob/main/src/play-v1.md)
+[Play RFC](../../../_media/play.md)
 
 ## Remarks
 
@@ -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`                      | [types.ts:195](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/types.ts#L195) |
-| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [types.ts:193](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/types.ts#L193) |
-| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\> | [types.ts:194](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/types.ts#L194) |
-| <a id="property-to"></a> `to`          | `readonly` | `string`                       | [types.ts:192](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/types.ts#L192) |
-| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                 | [types.ts:191](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/types.ts#L191) |
+| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                      | [types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L221) |
+| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L219) |
+| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\> | [types.ts:220](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L220) |
+| <a id="property-to"></a> `to`          | `readonly` | `string`                       | [types.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L218) |
+| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                 | [types.ts:217](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L217) |

package/api/@xmachines/play-router/interfaces/RouteInfo.md

@@ -2,7 +2,7 @@
 
 # Interface: RouteInfo
 
-Defined in: [types.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/types.ts#L40)
+Defined in: [types.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L54)
 
 Extracted route information from a state node
 
@@ -10,10 +10,10 @@ Extracted route information from a state node
 
 | Property                                      | Type                                                | Description                                                                                          | Defined in                                                                                                            |
 | --------------------------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-isabsolute"></a> `isAbsolute` | `boolean`                                           | Whether route path is absolute (starts with /)                                                       | [types.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/types.ts#L50) |
-| <a id="property-metadata"></a> `metadata`     | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | Original route metadata                                                                              | [types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/types.ts#L57) |
-| <a id="property-pattern"></a> `pattern?`      | `string`                                            | Route pattern with parameters (e.g., /profile/:userId) if routePath contains params                  | [types.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/types.ts#L48) |
-| <a id="property-routable"></a> `routable`     | `boolean`                                           | Whether this state is routable (has meta.route) true = has meta.route, can receive play.route events | [types.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/types.ts#L55) |
-| <a id="property-routepath"></a> `routePath`   | `string`                                            | Route path extracted from meta.route                                                                 | [types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/types.ts#L46) |
-| <a id="property-stateid"></a> `stateId`       | `string`                                            | State identifier (node.id or path.join('.'))                                                         | [types.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/types.ts#L42) |
-| <a id="property-statepath"></a> `statePath`   | `string`[]                                          | State path segments from root                                                                        | [types.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/types.ts#L44) |
+| <a id="property-isabsolute"></a> `isAbsolute` | `boolean`                                           | Whether route path is absolute (starts with /)                                                       | [types.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L64) |
+| <a id="property-metadata"></a> `metadata`     | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | Original route metadata                                                                              | [types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L71) |
+| <a id="property-pattern"></a> `pattern?`      | `string`                                            | Route pattern with parameters (e.g., /profile/:userId) if routePath contains params                  | [types.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L62) |
+| <a id="property-routable"></a> `routable`     | `boolean`                                           | Whether this state is routable (has meta.route) true = has meta.route, can receive play.route events | [types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L69) |
+| <a id="property-routepath"></a> `routePath`   | `string`                                            | Route path extracted from meta.route                                                                 | [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L60) |
+| <a id="property-stateid"></a> `stateId`       | `string`                                            | State identifier (node.id or path.join('.'))                                                         | [types.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L56) |
+| <a id="property-statepath"></a> `statePath`   | `string`[]                                          | State path segments from root                                                                        | [types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/types.ts#L58) |

package/api/@xmachines/play-router/interfaces/RouteMap.md

@@ -2,7 +2,7 @@
 
 # Interface: RouteMap
 
-Defined in: [create-route-map.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-route-map.ts#L28)
+Defined in: [create-route-map.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-route-map.ts#L28)
 
 Bidirectional route resolution interface returned by `createRouteMap()`.
 
@@ -23,7 +23,7 @@ events into `play.route` actor events.
 resolve(path): object;
 ```
 
-Defined in: [create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-route-map.ts#L45)
+Defined in: [create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-route-map.ts#L45)
 
 Resolve a URL path to a state ID and params.
 
@@ -52,5 +52,5 @@ if (to) {
 
 | Name     | Type                           | Defined in                                                                                                                                  |
 | -------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
-| `params` | `Record`\<`string`, `string`\> | [create-route-map.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-route-map.ts#L47) |
-| `to`     | `string` \| `null`             | [create-route-map.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-router/src/create-route-map.ts#L46) |
+| `params` | `Record`\<`string`, `string`\> | [create-route-map.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-route-map.ts#L47) |
+| `to`     | `string` \| `null`             | [create-route-map.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/create-route-map.ts#L46) |