@xmachines/docs 1.0.0-beta.10

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

@@ -0,0 +1,209 @@
+[Documentation](../../../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)
+
+VueBaseRouteMap — intermediate base class for Vue Router adapters.
+
+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.
+
+**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`.
+
+Exported from `@xmachines/play-vue-router` for consumers who need to extend or test
+the Vue routing layer directly. Most consumers use `RouteMap` instead.
+
+## Example
+
+```typescript
+import { VueBaseRouteMap } from "@xmachines/play-vue-router";
+
+class MyVueRouteMap extends VueBaseRouteMap {
+	// add custom resolution logic
+}
+```
+
+## Extends
+
+- [`VueBaseRouteMap`](VueBaseRouteMap.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new RouteMap(mappings): 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)
+
+#### Parameters
+
+| Parameter  | Type                                              |
+| ---------- | ------------------------------------------------- |
+| `mappings` | [`RouteMapping`](../interfaces/RouteMapping.md)[] |
+
+#### Returns
+
+`RouteMap`
+
+#### Inherited from
+
+[`VueBaseRouteMap`](VueBaseRouteMap.md).[`constructor`](VueBaseRouteMap.md#constructor)
+
+## Methods
+
+### getPathByStateId()
+
+```ts
+getPathByStateId(stateId): string | null;
+```
+
+Defined in: play-router/dist/base-route-map.d.ts:111
+
+Look up the path pattern registered for a state ID.
+
+#### Parameters
+
+| Parameter | Type     | Description                                               |
+| --------- | -------- | --------------------------------------------------------- |
+| `stateId` | `string` | State machine state ID (e.g., `"profile"`, `"#settings"`) |
+
+#### Returns
+
+`string` \| `null`
+
+The registered path pattern, or `null` if the state ID is unknown
+
+#### Example
+
+```typescript
+map.getPathByStateId("profile"); // "/profile/:userId"
+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()
+
+```ts
+getStateIdByPath(path): string | null;
+```
+
+Defined in: play-router/dist/base-route-map.d.ts:98
+
+Resolve a URL path to its mapped state ID.
+
+Strips query strings and hash fragments before matching. Tries an O(1) exact
+lookup first, then falls back to bucket-indexed pattern matching. Results are
+cached after the first pattern match.
+
+#### Parameters
+
+| Parameter | Type     | Description                                                                    |
+| --------- | -------- | ------------------------------------------------------------------------------ |
+| `path`    | `string` | URL pathname, optionally including query/hash (e.g., `"/profile/123?ref=nav"`) |
+
+#### Returns
+
+`string` \| `null`
+
+The mapped state ID, or `null` if no route matches
+
+#### Example
+
+```typescript
+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/VueBaseRouteMap.md

@@ -0,0 +1,201 @@
+[Documentation](../../../README.md) / [@xmachines/play-vue-router](../README.md) / VueBaseRouteMap
+
+# Class: VueBaseRouteMap
+
+Defined in: [play-vue-router/src/vue-base-route-map.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-vue-router/src/vue-base-route-map.ts#L28)
+
+VueBaseRouteMap — intermediate base class for Vue Router adapters.
+
+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.
+
+**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`.
+
+Exported from `@xmachines/play-vue-router` for consumers who need to extend or test
+the Vue routing layer directly. Most consumers use `RouteMap` instead.
+
+## Example
+
+```typescript
+import { VueBaseRouteMap } from "@xmachines/play-vue-router";
+
+class MyVueRouteMap extends VueBaseRouteMap {
+	// add custom resolution logic
+}
+```
+
+## Extends
+
+- [`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md)
+
+## Extended by
+
+- [`RouteMap`](RouteMap.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new VueBaseRouteMap(mappings): VueBaseRouteMap;
+```
+
+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)
+
+#### Parameters
+
+| Parameter  | Type                                              |
+| ---------- | ------------------------------------------------- |
+| `mappings` | [`RouteMapping`](../interfaces/RouteMapping.md)[] |
+
+#### Returns
+
+`VueBaseRouteMap`
+
+#### Overrides
+
+[`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md).[`constructor`](../../play-router/classes/BaseRouteMap.md#constructor)
+
+## Methods
+
+### getPathByStateId()
+
+```ts
+getPathByStateId(stateId): string | null;
+```
+
+Defined in: play-router/dist/base-route-map.d.ts:111
+
+Look up the path pattern registered for a state ID.
+
+#### Parameters
+
+| Parameter | Type     | Description                                               |
+| --------- | -------- | --------------------------------------------------------- |
+| `stateId` | `string` | State machine state ID (e.g., `"profile"`, `"#settings"`) |
+
+#### Returns
+
+`string` \| `null`
+
+The registered path pattern, or `null` if the state ID is unknown
+
+#### Example
+
+```typescript
+map.getPathByStateId("profile"); // "/profile/:userId"
+map.getPathByStateId("missing"); // null
+```
+
+#### Inherited from
+
+[`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md).[`getPathByStateId`](../../play-router/classes/BaseRouteMap.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`
+
+---
+
+### 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`
+
+---
+
+### 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`
+
+---
+
+### getStateIdByPath()
+
+```ts
+getStateIdByPath(path): string | null;
+```
+
+Defined in: play-router/dist/base-route-map.d.ts:98
+
+Resolve a URL path to its mapped state ID.
+
+Strips query strings and hash fragments before matching. Tries an O(1) exact
+lookup first, then falls back to bucket-indexed pattern matching. Results are
+cached after the first pattern match.
+
+#### Parameters
+
+| Parameter | Type     | Description                                                                    |
+| --------- | -------- | ------------------------------------------------------------------------------ |
+| `path`    | `string` | URL pathname, optionally including query/hash (e.g., `"/profile/123?ref=nav"`) |
+
+#### Returns
+
+`string` \| `null`
+
+The mapped state ID, or `null` if no route matches
+
+#### Example
+
+```typescript
+map.getStateIdByPath("/profile/123"); // "profile"
+map.getStateIdByPath("/unknown"); // null
+```
+
+#### Inherited from
+
+[`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md).[`getStateIdByPath`](../../play-router/classes/BaseRouteMap.md#getstateidbypath)