npm - @xmachines/docs - Versions diffs - 1.0.0-beta.33 → 1.0.0-beta.35 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (391) hide show

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

@@ -2,7 +2,7 @@
 # Interface: RouteInfo
-Defined in: [types.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L54)
+Defined in: [types.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/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:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/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.33/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.33/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.33/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.33/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.33/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.33/packages/play-router/src/types.ts#L58) |
+| <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.35/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.35/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.35/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.35/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.35/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.35/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.35/packages/play-router/src/types.ts#L58) |

package/api/@xmachines/play-router/interfaces/RouteMapping.md CHANGED Viewed

@@ -2,26 +2,26 @@
 # Interface: RouteMapping
-Defined in: [base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L57)
+Defined in: [base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/base-route-map.ts#L57)
 A single state ID ↔ path mapping entry.
-Both fields are `readonly` — mappings are immutable once passed to `BaseRouteMap`.
+Both fields are `readonly` — mappings are immutable once passed to `RouteMap`.
 Adapter packages re-export a structurally compatible `RouteMapping` type under
 their own name. This type is published from `@xmachines/play-router` as
-`BaseRouteMapping` to avoid name collisions with those adapter-local types.
+`RouteMapping` to avoid name collisions with those adapter-local types.
 ## Example
 ```typescript
-const mapping: BaseRouteMapping = { stateId: "home", path: "/" };
-const paramMapping: BaseRouteMapping = { stateId: "profile", path: "/profile/:userId" };
-const optionalMapping: BaseRouteMapping = { stateId: "settings", path: "/settings/:section?" };
+const mapping: RouteMapping = { stateId: "home", path: "/" };
+const paramMapping: RouteMapping = { stateId: "profile", path: "/profile/:userId" };
+const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:section?" };
 ```
 ## Properties
 | 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:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L61) |
-| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`)                         | [base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L59) |
+| <a id="property-path"></a> `path`       | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/base-route-map.ts#L61) |
+| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`)                         | [base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/base-route-map.ts#L59) |

package/api/@xmachines/play-router/interfaces/RouteMatch.md CHANGED Viewed

@@ -2,11 +2,11 @@
 # Interface: RouteMatch
-Defined in: [router-sync.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-sync.ts#L9)
+Defined in: [router-sync.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-sync.ts#L9)
 ## Properties
 | Property                               | Type                              | Defined in                                                                                                                        |
 | -------------------------------------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-params"></a> `params?` | `Record`\<`string`, `string`\>    | [router-sync.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-sync.ts#L11) |
-| <a id="property-to"></a> `to`          | `string` \| `null` \| `undefined` | [router-sync.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-sync.ts#L10) |
+| <a id="property-params"></a> `params?` | `Record`\<`string`, `string`\>    | [router-sync.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-sync.ts#L11) |
+| <a id="property-to"></a> `to`          | `string` \| `null` \| `undefined` | [router-sync.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-sync.ts#L10) |

package/api/@xmachines/play-router/interfaces/{RouteMap.md → RouteMatcher.md} RENAMED Viewed

@@ -1,31 +1,31 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMap
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMatcher
-# Interface: RouteMap
+# Interface: RouteMatcher
-Defined in: [create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/create-route-map.ts#L20)
+Defined in: [create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/create-route-map.ts#L20)
-Bidirectional route resolution interface returned by `createRouteMap()`.
+URL route matcher interface returned by `createRouteMap()`.
-Resolves incoming URL paths to state IDs (with `#` prefix) and extracts
+Matches incoming URL paths to state IDs (with `#` prefix) and extracts
 route parameters. Used by `RouterBridgeBase` to translate router navigation
 events into `play.route` actor events.
 ## See
 - [createRouteMap](../functions/createRouteMap.md) for the factory function
-- [BaseRouteMap](../classes/BaseRouteMap.md) for direct state ID ↔ path lookups without params extraction
+- [RouteMap](../classes/RouteMap.md) for direct state ID ↔ path lookups without params extraction
 ## Methods
-### resolve()
+### match()
 ```ts
-resolve(path): object;
+match(path): object;
 ```
-Defined in: [create-route-map.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/create-route-map.ts#L37)
+Defined in: [create-route-map.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/create-route-map.ts#L37)
-Resolve a URL path to a state ID and params.
+Match a URL path to a state ID and params.
 #### Parameters
@@ -42,7 +42,7 @@ Object with `to` (state ID with # prefix) and `params`
 Example:
 ```typescript
-const { to, params } = routeMap.resolve("/settings/account");
+const { to, params } = routeMatcher.match("/settings/account");
 // { to: "#settings", params: { section: "account" } }
 if (to) {
@@ -52,5 +52,5 @@ if (to) {
 | Name     | Type                           | Defined in                                                                                                                                  |
 | -------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
-| `params` | `Record`\<`string`, `string`\> | [create-route-map.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/create-route-map.ts#L39) |
-| `to`     | `string` \| `null`             | [create-route-map.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/create-route-map.ts#L38) |
+| `params` | `Record`\<`string`, `string`\> | [create-route-map.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/create-route-map.ts#L39) |
+| `to`     | `string` \| `null`             | [create-route-map.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/create-route-map.ts#L38) |

package/api/@xmachines/play-router/interfaces/RouteNode.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: RouteNode
-Defined in: [types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L77)
+Defined in: [types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L77)
 Node in the route tree representing a single route
@@ -10,12 +10,12 @@ Node in the route tree representing a single route
 | Property                                  | Type                                                | Description                                                                                                                                                                                                                             | Defined in                                                                                                              |
 | ----------------------------------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-children"></a> `children` | `RouteNode`[]                                       | Child routes                                                                                                                                                                                                                            | [types.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L101) |
-| <a id="property-fullpath"></a> `fullPath` | `string`                                            | The fully resolved absolute path from the root (e.g. `"/dashboard/overview"`). Always use `fullPath` for browser URL matching and route map construction. `createRouteMapFromTree` and `createRouteMapFromMachine` both use this field. | [types.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L90)   |
-| <a id="property-id"></a> `id`             | `string`                                            | Unique identifier (state ID)                                                                                                                                                                                                            | [types.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L79)   |
-| <a id="property-metadata"></a> `metadata` | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | Original meta.route metadata                                                                                                                                                                                                            | [types.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L105) |
-| <a id="property-parent"></a> `parent`     | `RouteNode` \| `null`                               | Parent route (null for root)                                                                                                                                                                                                            | [types.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L103) |
-| <a id="property-path"></a> `path`         | `string`                                            | The raw route path segment as declared in `meta.route` — may be relative (e.g. `"overview"`) or absolute (e.g. `"/dashboard"`). Do not use this for URL matching; use `fullPath` instead.                                               | [types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L84)   |
-| <a id="property-pattern"></a> `pattern?`  | `string`                                            | Route pattern with parameters (e.g., /profile/:userId) if path contains params                                                                                                                                                          | [types.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L92)   |
-| <a id="property-routable"></a> `routable` | `boolean`                                           | Whether this state is routable (has meta.route) States with meta.route can receive play.route events                                                                                                                                    | [types.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L99)   |
-| <a id="property-stateid"></a> `stateId`   | `string`                                            | XState state ID this route maps to                                                                                                                                                                                                      | [types.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L94)   |
+| <a id="property-children"></a> `children` | `RouteNode`[]                                       | Child routes                                                                                                                                                                                                                            | [types.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L101) |
+| <a id="property-fullpath"></a> `fullPath` | `string`                                            | The fully resolved absolute path from the root (e.g. `"/dashboard/overview"`). Always use `fullPath` for browser URL matching and route map construction. `createRouteMapFromTree` and `createRouteMapFromMachine` both use this field. | [types.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L90)   |
+| <a id="property-id"></a> `id`             | `string`                                            | Unique identifier (state ID)                                                                                                                                                                                                            | [types.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L79)   |
+| <a id="property-metadata"></a> `metadata` | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | Original meta.route metadata                                                                                                                                                                                                            | [types.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L105) |
+| <a id="property-parent"></a> `parent`     | `RouteNode` \| `null`                               | Parent route (null for root)                                                                                                                                                                                                            | [types.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L103) |
+| <a id="property-path"></a> `path`         | `string`                                            | The raw route path segment as declared in `meta.route` — may be relative (e.g. `"overview"`) or absolute (e.g. `"/dashboard"`). Do not use this for URL matching; use `fullPath` instead.                                               | [types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L84)   |
+| <a id="property-pattern"></a> `pattern?`  | `string`                                            | Route pattern with parameters (e.g., /profile/:userId) if path contains params                                                                                                                                                          | [types.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L92)   |
+| <a id="property-routable"></a> `routable` | `boolean`                                           | Whether this state is routable (has meta.route) States with meta.route can receive play.route events                                                                                                                                    | [types.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L99)   |
+| <a id="property-stateid"></a> `stateId`   | `string`                                            | XState state ID this route maps to                                                                                                                                                                                                      | [types.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L94)   |

package/api/@xmachines/play-router/interfaces/RouteObject.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: RouteObject
-Defined in: [types.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L39)
+Defined in: [types.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L39)
 Route object with additional metadata.
@@ -18,4 +18,4 @@ Additional route metadata (title, breadcrumb, etc.)
 | Property                          | Type     | Description                             | Defined in                                                                                                            |
 | --------------------------------- | -------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-path"></a> `path` | `string` | Route path template (e.g., '/user/:id') | [types.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L41) |
+| <a id="property-path"></a> `path` | `string` | Route path template (e.g., '/user/:id') | [types.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L41) |

package/api/@xmachines/play-router/interfaces/RouteTree.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: RouteTree
-Defined in: [types.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L115)
+Defined in: [types.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L115)
 Complete route tree with lookup maps
@@ -15,7 +15,7 @@ Provides bidirectional mapping between state IDs and URL paths:
 | Property                                    | Type                                                                                                      | Description                                                                                                                                                                                                                                                                                                                                                      | Defined in                                                                                                              |
 | ------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-bypath"></a> `byPath`       | `Map`\<`string`, [`RouteNode`](RouteNode.md)\>                                                            | Map full path -> route node Used to look up state ID from URL path for play.route event targeting                                                                                                                                                                                                                                                                | [types.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L127) |
-| <a id="property-bystateid"></a> `byStateId` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\>                                                            | Map state ID -> route node Used to look up URL path from state ID for browser URL sync                                                                                                                                                                                                                                                                           | [types.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L122) |
-| <a id="property-graph"></a> `graph?`        | `Graph`\<[`MachineNodeData`](MachineNodeData.md), [`MachineEdgeData`](MachineEdgeData.md), `any`, `any`\> | Graph representation of the state machine for advanced queries. Populated by extractMachineRoutes() — use for hierarchy queries, reachability checks, and transition-aware navigation via @statelyai/graph algorithms. **Example** `import { getSuccessors, hasPath } from "@statelyai/graph"; const successors = getSuccessors(tree.graph!, "myMachine.home");` | [types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L139) |
-| <a id="property-root"></a> `root`           | [`RouteNode`](RouteNode.md)                                                                               | Root route node                                                                                                                                                                                                                                                                                                                                                  | [types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L117) |
+| <a id="property-bypath"></a> `byPath`       | `Map`\<`string`, [`RouteNode`](RouteNode.md)\>                                                            | Map full path -> route node Used to look up state ID from URL path for play.route event targeting                                                                                                                                                                                                                                                                | [types.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L127) |
+| <a id="property-bystateid"></a> `byStateId` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\>                                                            | Map state ID -> route node Used to look up URL path from state ID for browser URL sync                                                                                                                                                                                                                                                                           | [types.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L122) |
+| <a id="property-graph"></a> `graph?`        | `Graph`\<[`MachineNodeData`](MachineNodeData.md), [`MachineEdgeData`](MachineEdgeData.md), `any`, `any`\> | Graph representation of the state machine for advanced queries. Populated by extractMachineRoutes() — use for hierarchy queries, reachability checks, and transition-aware navigation via @statelyai/graph algorithms. **Example** `import { getSuccessors, hasPath } from "@statelyai/graph"; const successors = getSuccessors(tree.graph!, "myMachine.home");` | [types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L139) |
+| <a id="property-root"></a> `root`           | [`RouteNode`](RouteNode.md)                                                                               | Root route node                                                                                                                                                                                                                                                                                                                                                  | [types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L117) |

package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: RouteWatcherHandle
-Defined in: [router-bridge-base.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L70)
+Defined in: [router-bridge-base.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L70)
 Narrow interface for the TC39 Signal watcher used by `RouterBridgeBase` to
 monitor `actor.currentRoute` changes.
@@ -24,7 +24,7 @@ created and managed internally by `RouterBridgeBase`.
 unwatch(): void;
 ```
-Defined in: [router-bridge-base.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L74)
+Defined in: [router-bridge-base.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L74)
 Stop observing and release the watcher.
@@ -40,7 +40,7 @@ Stop observing and release the watcher.
 watch(signal): void;
 ```
-Defined in: [router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L72)
+Defined in: [router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L72)
 Arm the watcher to observe the given signal.

package/api/@xmachines/play-router/interfaces/RouterBridge.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: RouterBridge
-Defined in: [types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L271)
+Defined in: [types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L271)
 RouterBridge interface for runtime infrastructure adapters
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
-Defined in: [types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L287)
+Defined in: [types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L287)
 Connect the router bridge to the Actor
@@ -83,7 +83,7 @@ await bridge.connect();
 disconnect(): void | Promise<void>;
 ```
-Defined in: [types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L303)
+Defined in: [types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L303)
 Disconnect the router bridge from the Actor

package/api/@xmachines/play-router/interfaces/WindowLike.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: WindowLike
-Defined in: [types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L324)
+Defined in: [types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L324)
 Minimal window interface required by adapters that subscribe to DOM events
 (e.g. `hashchange`). Injectable for SSR and testing — pass a mock instead of
@@ -30,7 +30,7 @@ connectRouter({ actor, routeMap, window: mockWin });
 addEventListener(type, listener): void;
 ```
-Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L325)
+Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L325)
 #### Parameters
@@ -51,7 +51,7 @@ Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.
 removeEventListener(type, listener): void;
 ```
-Defined in: [types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L326)
+Defined in: [types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L326)
 #### Parameters

package/api/@xmachines/play-router/type-aliases/MachineGraph.md CHANGED Viewed

@@ -6,7 +6,7 @@
 type MachineGraph = Graph<MachineNodeData, MachineEdgeData>;
 ```
-Defined in: [machine-to-graph.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/machine-to-graph.ts#L17)
+Defined in: [machine-to-graph.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/machine-to-graph.ts#L18)
 Typed @statelyai/graph Graph representing a state machine.
 Provides hierarchy queries, traversal algorithms, and reachability checks.

package/api/@xmachines/play-router/type-aliases/RouteMetadata.md CHANGED Viewed

@@ -6,6 +6,6 @@
 type RouteMetadata = string | RouteObject;
 ```
-Defined in: [types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L49)
+Defined in: [types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/types.ts#L49)
 Route metadata from state machine `meta.route` field.

package/api/@xmachines/play-signals/functions/watchSignal.md CHANGED Viewed

@@ -6,7 +6,7 @@
 function watchSignal<T>(signal, onValue): () => void;
 ```
-Defined in: [packages/play-signals/src/watch-signal.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/watch-signal.ts#L21)
+Defined in: [packages/play-signals/src/watch-signal.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/watch-signal.ts#L21)
 Subscribe to a single signal using the canonical one-shot watcher lifecycle.

package/api/@xmachines/play-signals/interfaces/ComputedOptions.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: ComputedOptions\<T\>
-Defined in: [packages/play-signals/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/types.ts#L84)
+Defined in: [packages/play-signals/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/types.ts#L84)
 Options for creating Signal.Computed
@@ -31,4 +31,4 @@ const options: ComputedOptions<string> = {
 | Property                               | Type                    | Description                              | Defined in                                                                                                                                       |
 | -------------------------------------- | ----------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for memoization | [packages/play-signals/src/types.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/types.ts#L88) |
+| <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for memoization | [packages/play-signals/src/types.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/types.ts#L88) |

package/api/@xmachines/play-signals/interfaces/SignalComputed.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: SignalComputed\<T\>
-Defined in: [packages/play-signals/src/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/types.ts#L111)
+Defined in: [packages/play-signals/src/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/types.ts#L111)
 Lazily-evaluated, memoized computed signal
@@ -38,7 +38,7 @@ console.log(doubled.get()); // 10 (memoized, not recomputed)
 get(): T;
 ```
-Defined in: [packages/play-signals/src/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/types.ts#L117)
+Defined in: [packages/play-signals/src/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/types.ts#L117)
 Read computed value (recalculates only if dependencies changed)

package/api/@xmachines/play-signals/interfaces/SignalOptions.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: SignalOptions\<T\>
-Defined in: [packages/play-signals/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/types.ts#L26)
+Defined in: [packages/play-signals/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/types.ts#L26)
 Options for creating Signal.State
@@ -32,4 +32,4 @@ const count = new Signal.State(0, options);
 | Property                               | Type                    | Description                                               | Defined in                                                                                                                                       |
 | -------------------------------------- | ----------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for determining if value changed | [packages/play-signals/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/types.ts#L33) |
+| <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for determining if value changed | [packages/play-signals/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/types.ts#L33) |

package/api/@xmachines/play-signals/interfaces/SignalState.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: SignalState\<T\>
-Defined in: [packages/play-signals/src/types.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/types.ts#L53)
+Defined in: [packages/play-signals/src/types.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/types.ts#L53)
 Writable state signal holding a single reactive value
@@ -35,7 +35,7 @@ console.log(name.get()); // 'Bob'
 get(): T;
 ```
-Defined in: [packages/play-signals/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/types.ts#L59)
+Defined in: [packages/play-signals/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/types.ts#L59)
 Read current value and track as dependency
@@ -53,7 +53,7 @@ Current value of the signal
 set(value): void;
 ```
-Defined in: [packages/play-signals/src/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/types.ts#L66)
+Defined in: [packages/play-signals/src/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/types.ts#L66)
 Write new value and notify watchers if changed

package/api/@xmachines/play-signals/interfaces/SignalWatcher.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: SignalWatcher
-Defined in: [packages/play-signals/src/types.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/types.ts#L167)
+Defined in: [packages/play-signals/src/types.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/types.ts#L167)
 Watcher for observing signal changes and scheduling effects
@@ -40,7 +40,7 @@ getPending(): (
   | SignalComputed<unknown>)[];
 ```
-Defined in: [packages/play-signals/src/types.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/types.ts#L187)
+Defined in: [packages/play-signals/src/types.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/types.ts#L187)
 Get signals that changed since last check
@@ -60,7 +60,7 @@ Array of signals that have pending updates
 unwatch(signal): void;
 ```
-Defined in: [packages/play-signals/src/types.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/types.ts#L180)
+Defined in: [packages/play-signals/src/types.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/types.ts#L180)
 Stop watching a signal
@@ -82,7 +82,7 @@ Stop watching a signal
 watch(signal): void;
 ```
-Defined in: [packages/play-signals/src/types.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/types.ts#L173)
+Defined in: [packages/play-signals/src/types.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/types.ts#L173)
 Start watching a signal for changes

package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md CHANGED Viewed

@@ -6,7 +6,7 @@
 type WatcherNotify = () => void;
 ```
-Defined in: [packages/play-signals/src/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-signals/src/types.ts#L139)
+Defined in: [packages/play-signals/src/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-signals/src/types.ts#L139)
 Notification callback for Signal.subtle.Watcher