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

package/api/@xmachines/play-router/classes/RouterBridgeBase.md

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / RouterBridgeBase
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouterBridgeBase
 
 # Abstract Class: RouterBridgeBase
 
-Defined in: [router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L101)
+Defined in: [router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L101)
 
 Abstract base class for all `@xmachines` router adapter bridges.
 
@@ -30,7 +30,7 @@ between frameworks.
 new RouterBridgeBase(actor, routeMap): RouterBridgeBase;
 ```
 
-Defined in: [router-bridge-base.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L125)
+Defined in: [router-bridge-base.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L125)
 
 #### Parameters
 
@@ -49,15 +49,15 @@ Defined in: [router-bridge-base.ts:125](https://gitlab.com/xmachin-es/xmachines-
 
 | Property                                                              | Modifier    | Type                                                                                                                                                                                                                                                             | Default value | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Defined in                                                                                                                                        |
 | --------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                                   | `readonly`  | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined`   | A `Routable` actor exposing `currentRoute` and `send`.                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L126) |
-| <a id="property-hasconnectedonce"></a> `hasConnectedOnce`             | `protected` | `boolean`                                                                                                                                                                                                                                                        | `false`       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [router-bridge-base.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L104) |
-| <a id="property-isconnected"></a> `isConnected`                       | `protected` | `boolean`                                                                                                                                                                                                                                                        | `false`       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [router-bridge-base.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L103) |
-| <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean`                                                                                                                                                                                                                                                        | `false`       | Guards `syncActorFromRouter` against re-entrant calls triggered by the actor's own guard redirects (router→actor send → signal fires → actor→router push → another syncActorFromRouter before the first one returns). NOT used for actor→router echo suppression — that is handled exclusively by `lastSyncedPath`, which is updated before `navigateRouter()` is called so any router callback for the same path short-circuits at the `sanitized === lastSyncedPath` check in `syncActorFromRouter`. | [router-bridge-base.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L116) |
-| <a id="property-lastsyncedpath"></a> `lastSyncedPath`                 | `protected` | `string` \| `null`                                                                                                                                                                                                                                               | `null`        | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [router-bridge-base.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L105) |
-| <a id="property-routemap"></a> `routeMap`                             | `readonly`  | `object`                                                                                                                                                                                                                                                         | `undefined`   | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap(machine)` or an equivalent.                                                                                                                                                                                                                                                                                                | [router-bridge-base.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L127) |
-| `routeMap.getPathByStateId`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                                                                                                                                                | `undefined`   | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [router-bridge-base.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L129) |
-| `routeMap.getStateIdByPath`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                                                                                                                                                | `undefined`   | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [router-bridge-base.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L128) |
-| <a id="property-routewatcher"></a> `routeWatcher`                     | `protected` | [`RouteWatcherHandle`](../interfaces/RouteWatcherHandle.md) \| `null`                                                                                                                                                                                            | `null`        | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [router-bridge-base.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L117) |
+| <a id="property-actor"></a> `actor`                                   | `readonly`  | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined`   | A `Routable` actor exposing `currentRoute` and `send`.                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L126) |
+| <a id="property-hasconnectedonce"></a> `hasConnectedOnce`             | `protected` | `boolean`                                                                                                                                                                                                                                                        | `false`       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [router-bridge-base.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L104) |
+| <a id="property-isconnected"></a> `isConnected`                       | `protected` | `boolean`                                                                                                                                                                                                                                                        | `false`       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [router-bridge-base.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L103) |
+| <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean`                                                                                                                                                                                                                                                        | `false`       | Guards `syncActorFromRouter` against re-entrant calls triggered by the actor's own guard redirects (router→actor send → signal fires → actor→router push → another syncActorFromRouter before the first one returns). NOT used for actor→router echo suppression — that is handled exclusively by `lastSyncedPath`, which is updated before `navigateRouter()` is called so any router callback for the same path short-circuits at the `sanitized === lastSyncedPath` check in `syncActorFromRouter`. | [router-bridge-base.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L116) |
+| <a id="property-lastsyncedpath"></a> `lastSyncedPath`                 | `protected` | `string` \| `null`                                                                                                                                                                                                                                               | `null`        | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [router-bridge-base.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L105) |
+| <a id="property-routemap"></a> `routeMap`                             | `readonly`  | `object`                                                                                                                                                                                                                                                         | `undefined`   | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap(machine)` or an equivalent.                                                                                                                                                                                                                                                                                                | [router-bridge-base.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L127) |
+| `routeMap.getPathByStateId`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                                                                                                                                                | `undefined`   | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [router-bridge-base.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L129) |
+| `routeMap.getStateIdByPath`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                                                                                                                                                | `undefined`   | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [router-bridge-base.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L128) |
+| <a id="property-routewatcher"></a> `routeWatcher`                     | `protected` | [`RouteWatcherHandle`](../interfaces/RouteWatcherHandle.md) \| `null`                                                                                                                                                                                            | `null`        | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [router-bridge-base.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L117) |
 
 ## Methods
 
@@ -67,7 +67,7 @@ Defined in: [router-bridge-base.ts:125](https://gitlab.com/xmachin-es/xmachines-
 connect(): void;
 ```
 
-Defined in: [router-bridge-base.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L153)
+Defined in: [router-bridge-base.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L153)
 
 Connect the router bridge to the Actor.
 
@@ -99,7 +99,7 @@ Adapters that need custom initial-sync behavior should override
 disconnect(): void;
 ```
 
-Defined in: [router-bridge-base.ts:249](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L249)
+Defined in: [router-bridge-base.ts:249](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L249)
 
 Disconnect the router bridge from the Actor.
 
@@ -121,7 +121,7 @@ Stops signal watching and unregisters framework-specific router listener.
 protected extractParams(pathname, stateId): Record<string, string>;
 ```
 
-Defined in: [router-bridge-base.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L373)
+Defined in: [router-bridge-base.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L373)
 
 Extract path parameters from URL using the URLPattern API.
 
@@ -155,7 +155,7 @@ When URLPattern is absent and the route is parameterized
 protected extractQuery(search): Record<string, string>;
 ```
 
-Defined in: [router-bridge-base.ts:410](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L410)
+Defined in: [router-bridge-base.ts:410](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L410)
 
 Extract query parameters from URL search string.
 
@@ -179,7 +179,7 @@ Extracted query parameters or empty object
 protected getInitialRouterPath(): string | null | undefined;
 ```
 
-Defined in: [router-bridge-base.ts:467](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L467)
+Defined in: [router-bridge-base.ts:467](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L467)
 
 Return the router's current pathname at connect() time.
 
@@ -211,7 +211,7 @@ bridges that have not yet implemented this hook.
 protected getInitialRouterSearch(): string | undefined;
 ```
 
-Defined in: [router-bridge-base.ts:484](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L484)
+Defined in: [router-bridge-base.ts:484](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L484)
 
 Return the router's current search string at connect() time.
 
@@ -237,7 +237,7 @@ URL search string (e.g. `"?tab=security"`), or `undefined` if not available.
 abstract protected navigateRouter(path): void;
 ```
 
-Defined in: [router-bridge-base.ts:422](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L422)
+Defined in: [router-bridge-base.ts:422](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L422)
 
 Navigate the framework router to the given path.
 
@@ -262,7 +262,7 @@ Must trigger the framework router's navigation (e.g., router.navigate(path)).
 protected resolveNavigationPath(route): string | null;
 ```
 
-Defined in: [router-bridge-base.ts:395](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L395)
+Defined in: [router-bridge-base.ts:395](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L395)
 
 Resolve an actor route value to a concrete URL path for navigation.
 
@@ -297,7 +297,7 @@ Concrete URL path, or `null` if navigation should be skipped
 protected syncActorFromRouter(pathname, search?): void;
 ```
 
-Defined in: [router-bridge-base.ts:315](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L315)
+Defined in: [router-bridge-base.ts:315](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L315)
 
 Sync actor state when router location changes.
 
@@ -323,7 +323,7 @@ Prevents circular updates via isProcessingNavigation flag.
 protected syncRouterFromActor(route): void;
 ```
 
-Defined in: [router-bridge-base.ts:290](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L290)
+Defined in: [router-bridge-base.ts:290](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L290)
 
 Sync router location when actor route signal changes.
 
@@ -356,7 +356,7 @@ no event regardless of whether the callback fires synchronously or asynchronousl
 abstract protected unwatchRouterChanges(): void;
 ```
 
-Defined in: [router-bridge-base.ts:447](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L447)
+Defined in: [router-bridge-base.ts:447](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L447)
 
 Stop watching for router location changes.
 
@@ -374,7 +374,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
 abstract protected watchRouterChanges(): void;
 ```
 
-Defined in: [router-bridge-base.ts:440](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L440)
+Defined in: [router-bridge-base.ts:440](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L440)
 
 Start watching for router location changes.
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / buildPlayRouteEvent
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / buildPlayRouteEvent
 
 # Function: buildPlayRouteEvent()
 
@@ -9,7 +9,7 @@ function buildPlayRouteEvent(options): {
 } | null;
 ```
 
-Defined in: [router-sync.ts:140](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L140)
+Defined in: [router-sync.ts:140](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-sync.ts#L140)
 
 Build a normalized `play.route` event from raw router/browser input.
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / buildRouteTree
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / buildRouteTree
 
 # Function: buildRouteTree()
 
@@ -6,7 +6,7 @@
 function buildRouteTree(routes): RouteTree;
 ```
 
-Defined in: [build-tree.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/build-tree.ts#L13)
+Defined in: [build-tree.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/build-tree.ts#L13)
 
 Build hierarchical route tree from flat route list
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / createRouteMap
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / createRouteMap
 
 # Function: createRouteMap()
 
@@ -6,7 +6,7 @@
 function createRouteMap(machine, options?): RouteMap;
 ```
 
-Defined in: [create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/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.45/packages/play-router/src/create-route-map.ts#L45)
 
 Create a `RouteMap` from an XState state machine.
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / createRouteMapFromTree
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / createRouteMapFromTree
 
 # Function: createRouteMapFromTree()
 
@@ -6,7 +6,7 @@
 function createRouteMapFromTree(routeTree, options?): RouteMap;
 ```
 
-Defined in: [create-route-map-from-tree.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/create-route-map-from-tree.ts#L33)
+Defined in: [create-route-map-from-tree.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map-from-tree.ts#L33)
 
 Create a `RouteMap` from a `RouteTree` node structure.
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / createRouteMatcher
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / createRouteMatcher
 
 # Function: createRouteMatcher()
 
@@ -6,7 +6,7 @@
 function createRouteMatcher(routeTree): RouteMatcher;
 ```
 
-Defined in: [create-route-matcher.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/create-route-matcher.ts#L74)
+Defined in: [create-route-matcher.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-matcher.ts#L74)
 
 Create a URL pattern matcher from a RouteTree for efficient path lookups.
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / detectDuplicateRoutes
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / detectDuplicateRoutes
 
 # Function: detectDuplicateRoutes()
 
@@ -6,7 +6,7 @@
 function detectDuplicateRoutes(routes): void;
 ```
 
-Defined in: [validate-routes.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/validate-routes.ts#L50)
+Defined in: [validate-routes.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/validate-routes.ts#L50)
 
 Detect duplicate route paths
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / extractMachineRoutes
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / extractMachineRoutes
 
 # Function: extractMachineRoutes()
 
@@ -6,7 +6,7 @@
 function extractMachineRoutes(machine): RouteTree;
 ```
 
-Defined in: [extract-routes.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/extract-routes.ts#L93)
+Defined in: [extract-routes.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/extract-routes.ts#L93)
 
 Extract complete route tree from state machine graph
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / extractQuery
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / extractQuery
 
 # Function: extractQuery()
 
@@ -6,7 +6,7 @@
 function extractQuery(search): Record<string, string>;
 ```
 
-Defined in: [router-sync.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L121)
+Defined in: [router-sync.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-sync.ts#L121)
 
 Parse a URL search string into the plain object shape expected by
 `play.route` events.

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / extractRouteParams
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / extractRouteParams
 
 # Function: extractRouteParams()
 
@@ -6,7 +6,7 @@
 function extractRouteParams(pathname, pattern): Record<string, string>;
 ```
 
-Defined in: [router-sync.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L101)
+Defined in: [router-sync.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-sync.ts#L101)
 
 Extract named path parameters from a URL using the URLPattern API.
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / findRouteById
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / findRouteById
 
 # Function: findRouteById()
 
@@ -6,7 +6,7 @@
 function findRouteById(tree, id): RouteNode | undefined;
 ```
 
-Defined in: [find-route.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/find-route.ts#L52)
+Defined in: [find-route.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/find-route.ts#L52)
 
 Find route node by state ID
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / findRouteByPath
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / findRouteByPath
 
 # Function: findRouteByPath()
 
@@ -6,7 +6,7 @@
 function findRouteByPath(tree, path): RouteNode | undefined;
 ```
 
-Defined in: [find-route.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/find-route.ts#L77)
+Defined in: [find-route.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/find-route.ts#L77)
 
 Find route node by URL path
 

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

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

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / getRoutableRoutes
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / getRoutableRoutes
 
 # Function: getRoutableRoutes()
 
@@ -6,7 +6,7 @@
 function getRoutableRoutes(tree): RouteNode[];
 ```
 
-Defined in: [query.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/query.ts#L67)
+Defined in: [query.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/query.ts#L67)
 
 Get all routable routes from tree as flat array
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / getTransitionReachableRoutes
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / getTransitionReachableRoutes
 
 # Function: getTransitionReachableRoutes()
 
@@ -6,7 +6,7 @@
 function getTransitionReachableRoutes(graph, stateId): string[];
 ```
 
-Defined in: [query.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/query.ts#L113)
+Defined in: [query.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/query.ts#L113)
 
 Get routes reachable via transitions from current state
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / isRouteReachable
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / isRouteReachable
 
 # Function: isRouteReachable()
 
@@ -6,7 +6,7 @@
 function isRouteReachable(graph, fromStateId, toStateId): boolean;
 ```
 
-Defined in: [query.ts:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/query.ts#L149)
+Defined in: [query.ts:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/query.ts#L149)
 
 Check if a route is reachable from current state via transitions
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / machineToGraph
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / machineToGraph
 
 # Function: machineToGraph()
 
@@ -6,7 +6,7 @@
 function machineToGraph(machine): MachineGraph;
 ```
 
-Defined in: [machine-to-graph.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/machine-to-graph.ts#L71)
+Defined in: [machine-to-graph.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/machine-to-graph.ts#L71)
 
 ## Parameters
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / routeExists
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / routeExists
 
 # Function: routeExists()
 
@@ -6,7 +6,7 @@
 function routeExists(tree, path): boolean;
 ```
 
-Defined in: [query.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/query.ts#L89)
+Defined in: [query.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/query.ts#L89)
 
 Validate route path exists in tree
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / sanitizePathname
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / sanitizePathname
 
 # Function: sanitizePathname()
 
@@ -6,7 +6,7 @@
 function sanitizePathname(pathname): string | null;
 ```
 
-Defined in: [router-sync.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L69)
+Defined in: [router-sync.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-sync.ts#L69)
 
 Normalize a pathname before route-map lookup.
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / validateRouteFormat
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / validateRouteFormat
 
 # Function: validateRouteFormat()
 
@@ -6,7 +6,7 @@
 function validateRouteFormat(routePath, stateId): void;
 ```
 
-Defined in: [validate-routes.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/validate-routes.ts#L15)
+Defined in: [validate-routes.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/validate-routes.ts#L15)
 
 Validate route path format
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / validateStateExists
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / validateStateExists
 
 # Function: validateStateExists()
 
@@ -6,7 +6,7 @@
 function validateStateExists(stateId, stateIds): void;
 ```
 
-Defined in: [validate-routes.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/validate-routes.ts#L31)
+Defined in: [validate-routes.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/validate-routes.ts#L31)
 
 Validate state exists in state ID set
 

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

@@ -1,13 +1,13 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / BuildPlayRouteEventOptions
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / BuildPlayRouteEventOptions
 
 # Interface: BuildPlayRouteEventOptions
 
-Defined in: [router-sync.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L14)
+Defined in: [router-sync.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-sync.ts#L14)
 
 ## Properties
 
 | Property                                  | Type                                                   | Defined in                                                                                                                        |
 | ----------------------------------------- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-match"></a> `match`       | (`sanitizedPathname`) => [`RouteMatch`](RouteMatch.md) | [router-sync.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L17) |
-| <a id="property-pathname"></a> `pathname` | `string`                                               | [router-sync.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L15) |
-| <a id="property-search"></a> `search?`    | `string`                                               | [router-sync.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L16) |
+| <a id="property-match"></a> `match`       | (`sanitizedPathname`) => [`RouteMatch`](RouteMatch.md) | [router-sync.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-sync.ts#L17) |
+| <a id="property-pathname"></a> `pathname` | `string`                                               | [router-sync.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-sync.ts#L15) |
+| <a id="property-search"></a> `search?`    | `string`                                               | [router-sync.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-sync.ts#L16) |

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

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / LocationLike
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / LocationLike
 
 # Interface: LocationLike
 
-Defined in: [types.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L344)
+Defined in: [types.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L344)
 
 Minimal location interface required by adapters that read the current URL at
 `connect()` time. Injectable for SSR and testing — pass a mock instead of the
@@ -23,5 +23,5 @@ connectRouter({ actor, routeMap, location: mockLoc });
 
 | Property                                  | Modifier   | Type     | Defined in                                                                                                              |
 | ----------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [types.ts:345](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L345) |
-| <a id="property-search"></a> `search`     | `readonly` | `string` | [types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L346) |
+| <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [types.ts:345](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L345) |
+| <a id="property-search"></a> `search`     | `readonly` | `string` | [types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L346) |

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

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / MachineEdgeData
+[API](../../../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.44/packages/play-router/src/types.ts#L22)
+Defined in: [types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L22)
 
 Data attached to each edge in the machine graph representation.
 Captures transition event and guard information.
@@ -11,5 +11,5 @@ Captures transition event and guard information.
 
 | 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.44/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.44/packages/play-router/src/types.ts#L26) |
+| <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.45/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.45/packages/play-router/src/types.ts#L26) |

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

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / MachineNodeData
+[API](../../../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.44/packages/play-router/src/types.ts#L7)
+Defined in: [types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/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.
@@ -11,7 +11,7 @@ Captures the essential state metadata needed for route extraction and queries.
 
 | 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.44/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.44/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.44/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.44/packages/play-router/src/types.ts#L11) |
+| <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.45/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.45/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.45/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.45/packages/play-router/src/types.ts#L11) |