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

package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-vue-router](../README.md) / VueRouterBridge
+[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / VueRouterBridge
 
 # Class: VueRouterBridge
 
-Defined in: [play-vue-router/src/vue-router-bridge.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-vue-router/src/vue-router-bridge.ts#L33)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-vue-router/src/vue-router-bridge.ts#L33)
 
 @xmachines/play-vue-router - Vue Router 4.x adapter for XMachines Play
 
@@ -23,7 +23,7 @@ new VueRouterBridge(
    routeMap): VueRouterBridge;
 ```
 
-Defined in: [play-vue-router/src/vue-router-bridge.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-vue-router/src/vue-router-bridge.ts#L54)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-vue-router/src/vue-router-bridge.ts#L42)
 
 #### Parameters
 
@@ -43,17 +43,17 @@ Defined in: [play-vue-router/src/vue-router-bridge.ts:54](https://gitlab.com/xma
 
 ## Properties
 
-| Property                                                              | Modifier    | Type                                                                                                                                                                                                                                                             | Default value | Description                                                                                                                                                                                      | Inherited from                                                                                                                                                                | 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`.                                                                                                                                           | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor)                                   | [play-router/src/router-bridge-base.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L104) |
-| <a id="property-hasconnectedonce"></a> `hasConnectedOnce`             | `protected` | `boolean`                                                                                                                                                                                                                                                        | `false`       | -                                                                                                                                                                                                | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce)             | [play-router/src/router-bridge-base.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L92)   |
-| <a id="property-isconnected"></a> `isConnected`                       | `protected` | `boolean`                                                                                                                                                                                                                                                        | `false`       | -                                                                                                                                                                                                | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected)                       | [play-router/src/router-bridge-base.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L91)   |
-| <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean`                                                                                                                                                                                                                                                        | `false`       | -                                                                                                                                                                                                | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L94)   |
-| <a id="property-lastsyncedpath"></a> `lastSyncedPath`                 | `protected` | `string` \| `null`                                                                                                                                                                                                                                               | `null`        | -                                                                                                                                                                                                | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath)                 | [play-router/src/router-bridge-base.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L93)   |
-| <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()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap)                             | [play-router/src/router-bridge-base.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L105) |
-| `routeMap.getPathByStateId`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                                                                                                                                                | `undefined`   | -                                                                                                                                                                                                | -                                                                                                                                                                             | [play-router/src/router-bridge-base.ts:107](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L107) |
-| `routeMap.getStateIdByPath`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                                                                                                                                                | `undefined`   | -                                                                                                                                                                                                | -                                                                                                                                                                             | [play-router/src/router-bridge-base.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L106) |
-| <a id="property-routewatcher"></a> `routeWatcher`                     | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null`                                                                                                                                                                          | `null`        | -                                                                                                                                                                                                | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher)                     | [play-router/src/router-bridge-base.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L95)   |
+| Property                                                              | Modifier    | Type                                                                                                                                                                                                                                                             | Default value | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Inherited from                                                                                                                                                                | 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`.                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor)                                   | [play-router/src/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`       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce)             | [play-router/src/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`       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected)                       | [play-router/src/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`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/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`        | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath)                 | [play-router/src/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.                                                                                                                                                                                                                                                                                                | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap)                             | [play-router/src/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`   | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | -                                                                                                                                                                             | [play-router/src/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`   | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | -                                                                                                                                                                             | [play-router/src/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`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null`                                                                                                                                                                          | `null`        | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher)                     | [play-router/src/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
 
@@ -63,7 +63,7 @@ Defined in: [play-vue-router/src/vue-router-bridge.ts:54](https://gitlab.com/xma
 connect(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L131)
+Defined in: [play-router/src/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.
 
@@ -95,7 +95,7 @@ Adapters that need custom initial-sync behavior should override
 disconnect(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L218)
+Defined in: [play-router/src/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.
 
@@ -117,7 +117,7 @@ Stops signal watching and unregisters framework-specific router listener.
 dispose(): void;
 ```
 
-Defined in: [play-vue-router/src/vue-router-bridge.ts:213](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-vue-router/src/vue-router-bridge.ts#L213)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:193](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-vue-router/src/vue-router-bridge.ts#L193)
 
 Cleanup alias for Vue component lifecycle (`onUnmounted(() => bridge.dispose())`).
 
@@ -133,7 +133,7 @@ Cleanup alias for Vue component lifecycle (`onUnmounted(() => bridge.dispose())`
 protected extractParams(pathname, stateId): Record<string, string>;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L326)
+Defined in: [play-router/src/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.
 
@@ -171,7 +171,7 @@ When URLPattern is absent and the route is parameterized
 protected extractQuery(search): Record<string, string>;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:363](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L363)
+Defined in: [play-router/src/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.
 
@@ -199,7 +199,7 @@ Extracted query parameters or empty object
 protected getInitialRouterPath(): string | null;
 ```
 
-Defined in: [play-vue-router/src/vue-router-bridge.ts:193](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-vue-router/src/vue-router-bridge.ts#L193)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-vue-router/src/vue-router-bridge.ts#L173)
 
 Return the router's current pathname at connect() time.
 
@@ -235,7 +235,7 @@ bridges that have not yet implemented this hook.
 protected getInitialRouterSearch(): string | undefined;
 ```
 
-Defined in: [play-vue-router/src/vue-router-bridge.ts:205](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-vue-router/src/vue-router-bridge.ts#L205)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-vue-router/src/vue-router-bridge.ts#L185)
 
 Return the initial URL search string for query-param forwarding on `connect()`.
 
@@ -260,7 +260,7 @@ from the first `"?"`. Returns `undefined` when no query string is present so
 protected navigateRouter(path): void;
 ```
 
-Defined in: [play-vue-router/src/vue-router-bridge.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-vue-router/src/vue-router-bridge.ts#L97)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-vue-router/src/vue-router-bridge.ts#L91)
 
 Navigate Vue Router to the given path.
 
@@ -268,6 +268,12 @@ Receives a raw actor route value (stateId or concrete path).
 `resolveNavigationPath` normalizes to a concrete path; parameterized patterns
 are skipped. Navigation errors are thrown as [VueRouterNavigationError](#).
 
+Echo suppression — preventing the watcher from re-driving the actor with the
+router's response to this push — is handled by `lastSyncedPath` in the base
+class. `syncRouterFromActor` sets `lastSyncedPath = resolved` before this call,
+so when the watcher fires with the same path it short-circuits at the
+`sanitizedPath === lastSyncedPath` check and sends no event.
+
 #### Parameters
 
 | Parameter | Type     |
@@ -290,7 +296,7 @@ are skipped. Navigation errors are thrown as [VueRouterNavigationError](#).
 protected resolveNavigationPath(route): string | null;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:348](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L348)
+Defined in: [play-router/src/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.
 
@@ -329,7 +335,7 @@ Concrete URL path, or `null` if navigation should be skipped
 protected syncActorFromRouter(pathname, search?): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:268](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L268)
+Defined in: [play-router/src/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.
 
@@ -359,16 +365,20 @@ Prevents circular updates via isProcessingNavigation flag.
 protected syncRouterFromActor(route): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:248](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L248)
+Defined in: [play-router/src/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.
 
 Calls navigateRouter() for framework-specific navigation.
-Prevents circular updates via isProcessingNavigation flag.
 
-`lastSyncedPath` is updated before `navigateRouter()` and the processing flag is
-released in a microtask so synchronous router callbacks triggered by navigation are
-suppressed as circular echoes.
+Echo suppression — preventing the router's own callback from re-driving the
+actor — is handled entirely by `lastSyncedPath`: it is set to `route` before
+`navigateRouter()` is called, so any `syncActorFromRouter` invocation for the
+same path short-circuits at the `sanitized === lastSyncedPath` check and sends
+no event regardless of whether the callback fires synchronously or asynchronously.
+
+`isProcessingNavigation` is NOT set here — it is only used inside
+`syncActorFromRouter` to guard against re-entrant guard-redirect loops.
 
 #### Parameters
 
@@ -392,7 +402,7 @@ suppressed as circular echoes.
 protected unwatchRouterChanges(): void;
 ```
 
-Defined in: [play-vue-router/src/vue-router-bridge.ts:188](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-vue-router/src/vue-router-bridge.ts#L188)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-vue-router/src/vue-router-bridge.ts#L168)
 
 Stop watching for router location changes.
 
@@ -414,7 +424,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
 protected watchRouterChanges(): void;
 ```
 
-Defined in: [play-vue-router/src/vue-router-bridge.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-vue-router/src/vue-router-bridge.ts#L129)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-vue-router/src/vue-router-bridge.ts#L118)
 
 Subscribe to Vue Router changes using `watch` from `@vue/reactivity`.
 

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

@@ -1,19 +1,39 @@
-[Documentation](../../../README.md) / [@xmachines/play-vue-router](../README.md) / createRouteMap
+[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / createRouteMap
 
 # Function: createRouteMap()
 
 ```ts
-function createRouteMap(machine): RouteMap;
+function createRouteMap(machine, options?): RouteMap;
 ```
 
-Defined in: [play-vue-router/src/create-route-map.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-vue-router/src/create-route-map.ts#L4)
+Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map.ts#L45)
+
+Create a `RouteMap` from an XState state machine.
+
+Extracts all routable states (those with `meta.route`) and builds a bidirectional
+path ↔ stateId lookup structure. The returned map is used by `RouterBridgeBase`
+subclasses to translate browser URL changes into `play.route` actor events and
+vice-versa.
 
 ## Parameters
 
-| Parameter | Type                                                                      |
-| --------- | ------------------------------------------------------------------------- |
-| `machine` | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
+| Parameter  | Type                                                                      | Description                                                                                                         |
+| ---------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| `machine`  | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | XState v5 state machine with `meta.route` annotations on states.                                                    |
+| `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md)                     | Optional configuration. Pass `{ cacheSize }` to override the default LRU cache size for parameterized path lookups. |
 
 ## Returns
 
 [`RouteMap`](../classes/RouteMap.md)
+
+A `RouteMap` for passing to any `RouterBridgeBase`-based adapter.
+
+## Example
+
+```typescript
+import { createRouteMap } from "@xmachines/play-router";
+import { connectRouter } from "@xmachines/play-dom-router";
+
+const routeMap = createRouteMap(myMachine);
+const disconnect = connectRouter({ actor, router, routeMap });
+```

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

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

package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md

@@ -0,0 +1,13 @@
+[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / RouteMapOptions
+
+# Interface: RouteMapOptions
+
+Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map.ts#L9)
+
+Options for `createRouteMap` and `createRouteMapFromTree`.
+
+## Properties
+
+| Property                                     | Type     | Description                                                                                                                                                                                                                                                                                                                                                                                | Defined in                                                                                                                                                  |
+| -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map.ts#L20) |

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

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-vue-router](../README.md) / RouteMapping
+[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / RouteMapping
 
 # Interface: RouteMapping
 
-Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/base-route-map.ts#L57)
+Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L57)
 
 A single state ID ↔ path mapping entry.
 
@@ -23,5 +23,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
 
 | Property                                | Modifier   | Type     | Description                                                                   | Defined in                                                                                                                                              |
 | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-path"></a> `path`       | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/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"`)                         | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/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?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/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"`)                         | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L59) |

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

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-vue-router](../README.md) / RouterBridge
+[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / RouterBridge
 
 # Interface: RouterBridge
 
-Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L271)
+Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L271)
 
 RouterBridge interface for runtime infrastructure adapters
 
@@ -44,7 +44,7 @@ class TanStackRouterBridge implements RouterBridge {
 
 ## See
 
-[Play RFC](../../docs/rfc/play.md) - Invariant INV-04
+[Play RFC](../../../../rfc/play.md) - Invariant INV-04
 
 ## Methods
 
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L287)
+Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/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: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L303)
+Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L303)
 
 Disconnect the router bridge from the Actor
 

package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-vue-router](../README.md) / RoutableActor
+[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / RoutableActor
 
 # Type Alias: RoutableActor
 
@@ -6,6 +6,6 @@
 type RoutableActor = AbstractActor<AnyActorLogic> & Routable & Viewable;
 ```
 
-Defined in: [play-vue-router/src/play-router-provider.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-vue-router/src/play-router-provider.ts#L10)
+Defined in: [play-vue-router/src/play-router-provider.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-vue-router/src/play-router-provider.ts#L10)
 
 Minimum actor shape accepted by PlayRouterProvider.

package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-vue-router](../README.md) / PlayRouterProvider
+[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / PlayRouterProvider
 
 # Variable: PlayRouterProvider
 
@@ -64,7 +64,7 @@ const PlayRouterProvider: DefineComponent<
 >;
 ```
 
-Defined in: [play-vue-router/src/play-router-provider.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-vue-router/src/play-router-provider.ts#L19)
+Defined in: [play-vue-router/src/play-router-provider.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-vue-router/src/play-router-provider.ts#L19)
 
 PlayRouterProvider — Vue convenience wrapper for VueRouterBridge.
 

package/api/@xmachines/play-xstate/README.md

@@ -1,4 +1,4 @@
-[Documentation](../../README.md) / @xmachines/play-xstate
+[API](../../README.md) / @xmachines/play-xstate
 
 # @xmachines/play-xstate
 
@@ -10,7 +10,7 @@ Transform declarative state machines into live actors with TC39 Signals and para
 
 `@xmachines/play-xstate` provides `definePlayer()`, the primary API for binding XState v5 state machines to the Play Architecture actor base. It enables business logic to control routing and state through guard-enforced transitions, signal lifecycle management, and XState DevTools compatibility.
 
-Per [Play RFC](../docs/rfc/play.md), this package implements:
+Per [Play RFC](../../../rfc/play.md), this package implements:
 
 - **Actor Authority (INV-01):** State machine guards decide navigation validity
 - **Strict Separation (INV-02):** Zero React/framework imports in business logic
@@ -604,18 +604,18 @@ This package implements Play RFC requirements:
 - `play.route` events support parameters (enhancement)
 - Route extraction for URL patterns
 
-**Note:** Route parameter extraction uses URLPattern API. See [@xmachines/play-tanstack-react-router](../play-tanstack-react-router) for polyfill requirements.
+**Note:** Route parameter extraction uses URLPattern API. See [@xmachines/play-tanstack-react-router](../play-tanstack-react-router/README.md) for polyfill requirements.
 
 ## Related Packages
 
-- **[@xmachines/play-actor](../play-actor)** - AbstractActor base class
-- **[@xmachines/play-signals](../play-signals)** - TC39 Signals polyfill
-- **[@xmachines/play-router](../play-router)** - Route extraction utilities
-- **[@xmachines/play-react](../play-react)** - React renderer
-- **[@xmachines/play-vue](../play-vue)** - Vue renderer
-- **[@xmachines/play-solid](../play-solid)** - SolidJS renderer
-- **[@xmachines/play-dom](../play-dom)** - Vanilla DOM renderer
-- **[@xmachines/play](../play)** - Protocol types (PlayEvent)
+- **[@xmachines/play-actor](../play-actor/README.md)** - AbstractActor base class
+- **[@xmachines/play-signals](../play-signals/README.md)** - TC39 Signals polyfill
+- **[@xmachines/play-router](../play-router/README.md)** - Route extraction utilities
+- **[@xmachines/play-react](../play-react/README.md)** - React renderer
+- **[@xmachines/play-vue](../play-vue/README.md)** - Vue renderer
+- **[@xmachines/play-solid](../play-solid/README.md)** - SolidJS renderer
+- **[@xmachines/play-dom](../play-dom/README.md)** - Vanilla DOM renderer
+- **[@xmachines/play](../play/README.md)** - Protocol types (PlayEvent)
 
 ## License