@xmachines/docs 1.0.0-beta.9 → 1.0.0

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

@@ -1,61 +1,82 @@
-[Documentation](../../../README.md) / [@xmachines/play-vue-router](../README.md) / RouteMap
+[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / RouteMap
 
 # Class: RouteMap
 
-Defined in: [play-vue-router/src/route-map.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/route-map.ts#L14)
+Defined in: [play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L101)
 
-VueBaseRouteMap — intermediate base class for Vue Router adapters.
+Shared bidirectional route map base class.
 
-Extends `BaseRouteMap` (bucket-indexed O(k) pattern matching + QuickLRU 500-entry
-cache) and adds the Vue-specific adapter layer: `routeName` ↔ `stateId` bidirectional
-lookup and optional URL pattern access.
+All framework adapters use this class as their route map — they add no logic of their
+own and inherit the full public API from here.
 
-**Why a separate base class?** Vue Router uses named routes (`routeName`) rather than
-URL paths for navigation. `BaseRouteMap` operates on path strings; `VueBaseRouteMap`
-bridges the two by translating `RouteMapping` entries at construction time — only
-mappings with a `pattern` field participate in URL path resolution via `BaseRouteMap`.
+**Lookup strategy:**
 
-Exported from `@xmachines/play-vue-router` for consumers who need to extend or test
-the Vue routing layer directly. Most consumers use `RouteMap` instead.
+- Static paths (no `:param`) → O(1) `Map` lookup
+- Dynamic paths → O(k) bucket-indexed scan using `URLPattern`, where `k` is the number
+  of routes sharing the same first path segment
+- Results are cached after the first match in an LRU cache (default 500 entries,
+  configurable via the `cacheSize` constructor option)
+
+**Pattern syntax** (`:param` / `:param?` / `*`):
+
+- `:param` — required segment, matches exactly one non-`/` segment
+- `:param?` — optional segment, matches zero or one non-`/` segment
+- `*` — wildcard, matches any number of segments (URLPattern semantics)
+
+**StateId forms:** stateIds may be registered and looked up in either
+`"#stateId"` or `"stateId"` form — `RouteMap` canonicalizes internally.
+`getStateIdByPath` returns the stateId exactly as registered;
+`getPathByStateId` accepts both forms. Registering the same stateId in both
+forms refers to one entry (the later registration wins for reverse lookup).
 
 ## Example
 
 ```typescript
-import { VueBaseRouteMap } from "@xmachines/play-vue-router";
+import { RouteMap } from "@xmachines/play-router";
 
-class MyVueRouteMap extends VueBaseRouteMap {
-	// add custom resolution logic
-}
-```
+const map = new RouteMap([
+	{ stateId: "home", path: "/" },
+	{ stateId: "profile", path: "/profile/:userId" },
+	{ stateId: "settings", path: "/settings/:section?" },
+]);
 
-## Extends
+map.getStateIdByPath("/"); // "home"
+map.getStateIdByPath("/profile/123"); // "profile"
+map.getStateIdByPath("/settings"); // "settings"
+map.getStateIdByPath("/unknown"); // null
 
-- [`VueBaseRouteMap`](VueBaseRouteMap.md)
+map.getPathByStateId("profile"); // "/profile/:userId"
+map.getPathByStateId("missing"); // null
+```
 
 ## Constructors
 
 ### Constructor
 
 ```ts
-new RouteMap(mappings): RouteMap;
+new RouteMap(mappings, options?): RouteMap;
 ```
 
-Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-base-route-map.ts#L32)
+Defined in: [play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L127)
+
+Build a route map from an array of state ID ↔ path mappings.
+
+Static paths (no `:param`) are indexed in an O(1) `Map`.
+Parameterized paths are compiled to `URLPattern` and grouped into first-segment
+buckets for efficient candidate selection.
 
 #### Parameters
 
-| Parameter  | Type                                              |
-| ---------- | ------------------------------------------------- |
-| `mappings` | [`RouteMapping`](../interfaces/RouteMapping.md)[] |
+| Parameter            | Type                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                  |
+| -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `mappings`           | [`RouteMapping`](../interfaces/RouteMapping.md)[] | Array of `{ stateId, path }` entries. Order determines priority when multiple patterns could match the same path.                                                                                                                                                                                                                                                                                            |
+| `options`            | \{ `cacheSize?`: `number`; \}                     | Optional configuration. `options.cacheSize`: Maximum number of resolved parameterized path lookups to cache. Defaults to `500`. Increase for applications with many unique parameterized URL values (e.g. user profile pages with thousands of distinct IDs). After eviction the path falls back to the O(k) bucket pattern scan — correct but slower. Minimum effective value is `1` (QuickLRU constraint). |
+| `options.cacheSize?` | `number`                                          | -                                                                                                                                                                                                                                                                                                                                                                                                            |
 
 #### Returns
 
 `RouteMap`
 
-#### Inherited from
-
-[`VueBaseRouteMap`](VueBaseRouteMap.md).[`constructor`](VueBaseRouteMap.md#constructor)
-
 ## Methods
 
 ### getPathByStateId()
@@ -64,10 +85,14 @@ Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xm
 getPathByStateId(stateId): string | null;
 ```
 
-Defined in: play-router/dist/base-route-map.d.ts:111
+Defined in: [play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L218)
 
 Look up the path pattern registered for a state ID.
 
+Accepts the stateId in either `"#stateId"` or `"stateId"` form regardless of
+which form was used at registration — lookups are canonicalized internally,
+so consumers never need to try both forms.
+
 #### Parameters
 
 | Parameter | Type     | Description                                               |
@@ -84,91 +109,10 @@ The registered path pattern, or `null` if the state ID is unknown
 
 ```typescript
 map.getPathByStateId("profile"); // "/profile/:userId"
+map.getPathByStateId("#profile"); // "/profile/:userId" (same entry)
 map.getPathByStateId("missing"); // null
 ```
 
-#### Inherited from
-
-[`VueBaseRouteMap`](VueBaseRouteMap.md).[`getPathByStateId`](VueBaseRouteMap.md#getpathbystateid)
-
----
-
-### getPattern()
-
-```ts
-getPattern(stateId): string | undefined;
-```
-
-Defined in: [play-vue-router/src/vue-base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-base-route-map.ts#L58)
-
-Get the URL path pattern for a given state ID (e.g. `"/profile/:userId"`).
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `stateId` | `string` |
-
-#### Returns
-
-`string` \| `undefined`
-
-#### Inherited from
-
-[`VueBaseRouteMap`](VueBaseRouteMap.md).[`getPattern`](VueBaseRouteMap.md#getpattern)
-
----
-
-### getRouteName()
-
-```ts
-getRouteName(stateId): string | undefined;
-```
-
-Defined in: [play-vue-router/src/vue-base-route-map.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-base-route-map.ts#L48)
-
-Get the Vue Router route name for a given state ID.
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `stateId` | `string` |
-
-#### Returns
-
-`string` \| `undefined`
-
-#### Inherited from
-
-[`VueBaseRouteMap`](VueBaseRouteMap.md).[`getRouteName`](VueBaseRouteMap.md#getroutename)
-
----
-
-### getStateId()
-
-```ts
-getStateId(routeName): string | undefined;
-```
-
-Defined in: [play-vue-router/src/vue-base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-base-route-map.ts#L53)
-
-Get the state ID for a given Vue Router route name.
-
-#### Parameters
-
-| Parameter   | Type     |
-| ----------- | -------- |
-| `routeName` | `string` |
-
-#### Returns
-
-`string` \| `undefined`
-
-#### Inherited from
-
-[`VueBaseRouteMap`](VueBaseRouteMap.md).[`getStateId`](VueBaseRouteMap.md#getstateid)
-
 ---
 
 ### getStateIdByPath()
@@ -177,7 +121,7 @@ Get the state ID for a given Vue Router route name.
 getStateIdByPath(path): string | null;
 ```
 
-Defined in: play-router/dist/base-route-map.d.ts:98
+Defined in: [play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L178)
 
 Resolve a URL path to its mapped state ID.
 
@@ -203,7 +147,3 @@ The mapped state ID, or `null` if no route matches
 map.getStateIdByPath("/profile/123"); // "profile"
 map.getStateIdByPath("/unknown"); // null
 ```
-
-#### Inherited from
-
-[`VueBaseRouteMap`](VueBaseRouteMap.md).[`getStateIdByPath`](VueBaseRouteMap.md#getstateidbypath)

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:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-router-bridge.ts#L32)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue-router/src/vue-router-bridge.ts#L32)
 
 @xmachines/play-vue-router - Vue Router 4.x adapter for XMachines Play
 
@@ -20,51 +20,27 @@ Provides bidirectional integration between Vue Router and XMachines state machin
 new VueRouterBridge(
    vueRouter,
    actor,
-   vueRouteMap): VueRouterBridge;
+   routeMap): VueRouterBridge;
 ```
 
-Defined in: [play-vue-router/src/vue-router-bridge.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-router-bridge.ts#L109)
-
-Create a Vue Router bridge
+Defined in: [play-vue-router/src/vue-router-bridge.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue-router/src/vue-router-bridge.ts#L41)
 
 #### Parameters
 
-| Parameter     | Type                                                                                                                                    | Description                                 |
-| ------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
-| `vueRouter`   | `Router`                                                                                                                                | Vue Router instance                         |
-| `actor`       | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`AnyActorLogic`\> & [`Routable`](../../play-actor/interfaces/Routable.md) | XMachines actor instance                    |
-| `vueRouteMap` | [`RouteMap`](RouteMap.md)                                                                                                               | Bidirectional state ID ↔ route name mapping |
+| Parameter   | Type                                                                 |
+| ----------- | -------------------------------------------------------------------- |
+| `vueRouter` | `RouterClassic`                                                      |
+| `actor`     | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) |
+| `routeMap`  | [`RouteMap`](RouteMap.md)                                            |
 
 #### Returns
 
 `VueRouterBridge`
 
-#### Example
-
-```typescript
-const bridge = new VueRouterBridge(router, actor, routeMap);
-bridge.connect(); // Explicit connect — NOT automatic
-onUnmounted(() => bridge.disconnect());
-```
-
 #### Overrides
 
 [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`constructor`](../../play-router/classes/RouterBridgeBase.md#constructor)
 
-## Properties
-
-| Property                                                              | Modifier    | Type                                                                                                                                    | Description                                           | Inherited from                                                                                                                                                                | Defined in                                  |
-| --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
-| <a id="property-actor"></a> `actor`                                   | `readonly`  | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`AnyActorLogic`\> & [`Routable`](../../play-actor/interfaces/Routable.md) | Actor with currentRoute signal and send method        | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor)                                   | play-router/dist/router-bridge-base.d.ts:55 |
-| <a id="property-hasconnectedonce"></a> `hasConnectedOnce`             | `protected` | `boolean`                                                                                                                               | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce)             | play-router/dist/router-bridge-base.d.ts:61 |
-| <a id="property-isconnected"></a> `isConnected`                       | `protected` | `boolean`                                                                                                                               | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected)                       | play-router/dist/router-bridge-base.d.ts:60 |
-| <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean`                                                                                                                               | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | play-router/dist/router-bridge-base.d.ts:63 |
-| <a id="property-lastsyncedpath"></a> `lastSyncedPath`                 | `protected` | `string`                                                                                                                                | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath)                 | play-router/dist/router-bridge-base.d.ts:62 |
-| <a id="property-routemap"></a> `routeMap`                             | `readonly`  | `object`                                                                                                                                | Bidirectional route map for stateId ↔ path resolution | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap)                             | play-router/dist/router-bridge-base.d.ts:56 |
-| `routeMap.getPathByStateId`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                       | -                                                     | -                                                                                                                                                                             | play-router/dist/router-bridge-base.d.ts:58 |
-| `routeMap.getStateIdByPath`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                       | -                                                     | -                                                                                                                                                                             | play-router/dist/router-bridge-base.d.ts:57 |
-| <a id="property-routewatcher"></a> `routeWatcher`                     | `protected` | \| [`Watcher`](../../play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md) \| `null`                                     | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher)                     | play-router/dist/router-bridge-base.d.ts:64 |
-
 ## Methods
 
 ### connect()
@@ -73,28 +49,27 @@ onUnmounted(() => bridge.disconnect());
 connect(): void;
 ```
 
-Defined in: [play-vue-router/src/vue-router-bridge.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-router-bridge.ts#L229)
+Defined in: [play-router/src/router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/router-bridge-base.ts#L151)
 
-Override base class connect() to add Vue-native initial router → actor sync.
+Connect the router bridge to the Actor.
 
-Calls super.connect() to:
+Sets up the TC39 Signal watcher for actor → router direction and
+starts watching router changes (framework-specific).
 
-1. Set isConnected = true, hasConnectedOnce = true
-2. Create the TC39 Signal watcher for actor → router direction
-3. Call watchRouterChanges() to register the afterEach guard
+Ordering here is part of the bridge contract:
 
-Then performs the initial URL → actor sync using Vue-native route name lookup
-(afterEach does not fire for the already-loaded route at connect time).
+- `lastSyncedPath` is seeded in the constructor from `actor.currentRoute`
+- the actor watcher is installed before adapter router subscriptions
+- initial sync then resolves deep-link vs restore using `actor.initialRoute`
 
-**Note:** The super.connect() call is intentional — it ensures that any change
-to RouterBridgeBase.connect() initialization order causes VueRouterBridge
-integration tests to fail, providing a safety net (per CONS-09).
+Adapters that need custom initial-sync behavior should override
+`getInitialRouterPath()` rather than reordering `connect()` steps.
 
 #### Returns
 
 `void`
 
-#### Overrides
+#### Inherited from
 
 [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`connect`](../../play-router/classes/RouterBridgeBase.md#connect)
 
@@ -106,7 +81,7 @@ integration tests to fail, providing a safety net (per CONS-09).
 disconnect(): void;
 ```
 
-Defined in: play-router/dist/router-bridge-base.d.ts:87
+Defined in: [play-router/src/router-bridge-base.ts:256](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/router-bridge-base.ts#L256)
 
 Disconnect the router bridge from the Actor.
 
@@ -128,233 +103,10 @@ Stops signal watching and unregisters framework-specific router listener.
 dispose(): void;
 ```
 
-Defined in: [play-vue-router/src/vue-router-bridge.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-router-bridge.ts#L275)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-vue-router/src/vue-router-bridge.ts#L203)
 
-Cleanup alias for component lifecycle integration.
+Cleanup alias for Vue component lifecycle (`onUnmounted(() => bridge.dispose())`).
 
 #### Returns
 
 `void`
-
-#### Example
-
-```typescript
-onUnmounted(() => bridge.dispose());
-```
-
----
-
-### extractParams()
-
-```ts
-protected extractParams(pathname, stateId): Record<string, string>;
-```
-
-Defined in: play-router/dist/router-bridge-base.d.ts:134
-
-Extract path parameters from URL using the URLPattern API.
-
-Accesses `globalThis.URLPattern` at runtime — no polyfill is imported by this
-library. If `URLPattern` is unavailable (Node.js < 24, older browsers without a
-polyfill), this method returns `{}` silently (graceful degradation — routing still
-works, params will be empty).
-
-#### Parameters
-
-| Parameter  | Type     | Description                                       |
-| ---------- | -------- | ------------------------------------------------- |
-| `pathname` | `string` | The actual URL path (e.g., '/profile/john')       |
-| `stateId`  | `string` | The matched state ID for looking up route pattern |
-
-#### Returns
-
-`Record`\<`string`, `string`\>
-
-Extracted path parameters, or empty object if URLPattern is unavailable or no match
-
-#### Inherited from
-
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`extractParams`](../../play-router/classes/RouterBridgeBase.md#extractparams)
-
----
-
-### extractQuery()
-
-```ts
-protected extractQuery(search): Record<string, string>;
-```
-
-Defined in: play-router/dist/router-bridge-base.d.ts:141
-
-Extract query parameters from URL search string.
-
-#### Parameters
-
-| Parameter | Type     | Description                                      |
-| --------- | -------- | ------------------------------------------------ |
-| `search`  | `string` | URL search string (e.g., '?tab=security&page=1') |
-
-#### Returns
-
-`Record`\<`string`, `string`\>
-
-Extracted query parameters or empty object
-
-#### Inherited from
-
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`extractQuery`](../../play-router/classes/RouterBridgeBase.md#extractquery)
-
----
-
-### getInitialRouterPath()
-
-```ts
-protected getInitialRouterPath(): string | null;
-```
-
-Defined in: [play-vue-router/src/vue-router-bridge.ts:263](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-router-bridge.ts#L263)
-
-Return null to suppress base class initial sync — VueRouterBridge handles it
-in connect() using the Vue-native named-route lookup instead.
-
-#### Returns
-
-`string` \| `null`
-
-#### Overrides
-
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`getInitialRouterPath`](../../play-router/classes/RouterBridgeBase.md#getinitialrouterpath)
-
----
-
-### navigateRouter()
-
-```ts
-protected navigateRouter(path): void;
-```
-
-Defined in: [play-vue-router/src/vue-router-bridge.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-router-bridge.ts#L126)
-
-Navigate Vue Router to the given path/stateId.
-
-For state IDs (starting with #), resolves to named route.
-For paths (starting with /), navigates directly.
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `path`    | `string` |
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`navigateRouter`](../../play-router/classes/RouterBridgeBase.md#navigaterouter)
-
----
-
-### syncActorFromRouter()
-
-```ts
-protected syncActorFromRouter(pathname, search?): void;
-```
-
-Defined in: play-router/dist/router-bridge-base.d.ts:101
-
-Sync actor state when router location changes.
-
-Sends play.route event to actor with resolved stateId, params, and query.
-Prevents circular updates via isProcessingNavigation flag.
-
-#### Parameters
-
-| Parameter  | Type     |
-| ---------- | -------- |
-| `pathname` | `string` |
-| `search?`  | `string` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`syncActorFromRouter`](../../play-router/classes/RouterBridgeBase.md#syncactorfromrouter)
-
----
-
-### syncRouterFromActor()
-
-```ts
-protected syncRouterFromActor(route): void;
-```
-
-Defined in: play-router/dist/router-bridge-base.d.ts:94
-
-Sync router location when actor route signal changes.
-
-Calls navigateRouter() for framework-specific navigation.
-Prevents circular updates via isProcessingNavigation flag.
-
-#### Parameters
-
-| Parameter | Type      |
-| --------- | --------- |
-| `route`   | `unknown` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`syncRouterFromActor`](../../play-router/classes/RouterBridgeBase.md#syncrouterfromactor)
-
----
-
-### unwatchRouterChanges()
-
-```ts
-protected unwatchRouterChanges(): void;
-```
-
-Defined in: [play-vue-router/src/vue-router-bridge.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-router-bridge.ts#L209)
-
-Unsubscribe from Vue Router afterEach guard.
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`unwatchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#unwatchrouterchanges)
-
----
-
-### watchRouterChanges()
-
-```ts
-protected watchRouterChanges(): void;
-```
-
-Defined in: [play-vue-router/src/vue-router-bridge.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-router-bridge.ts#L150)
-
-Subscribe to Vue Router changes using afterEach guard.
-
-Vue's afterEach provides native params/query extraction which is
-more accurate than URLPattern-based extraction. Override the base class
-router→actor sync to use Vue-native params/query.
-
-Note: Uses isProcessingNavigation flag from base class.
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`watchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#watchrouterchanges)

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:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/create-route-map.ts#L9)
+Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/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` |
+| 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 });
+```