@xmachines/docs 1.0.0-beta.29 → 1.0.0-beta.31

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

@@ -38,7 +38,7 @@ without muting console output.
 - `PlayRenderer` — main renderer component (Vue SFC)
 - `useActor` — composable for accessing the actor inside a `PlayRenderer` tree
 - `defineRegistry` — SFC-aware wrapper; auto-wraps `.vue` SFCs via `h(SFC, ctx)`
-- `useStateBinding` — re-exported from `@json-render/vue`
+- `useBoundProp` — re-exported from `@json-render/vue`
 - `ComponentFn` (type) — re-exported from `@json-render/vue`
 - `ComponentContext` (type) — re-exported from `@json-render/vue`
 - `PlayRendererProps` (type)
@@ -62,14 +62,14 @@ export type Catalog = typeof catalog;
 ```
 
 ```vue
-<!-- Login.vue — Vue SFC; useStateBinding works in <script setup> -->
+<!-- Login.vue — Vue SFC; useBoundProp works in <script setup> -->
 <script setup lang="ts">
-import { useStateBinding } from "@xmachines/play-vue";
+import { useBoundProp } from "@xmachines/play-vue";
 import type { ComponentContext } from "@xmachines/play-vue";
 import type { Catalog } from "./catalog.js";
 
 const { props, emit, bindings } = defineProps<ComponentContext<Catalog, "Login">>();
-const [username, setUsername] = useStateBinding<string>(bindings?.username ?? "/username");
+const [username, setUsername] = useBoundProp<string>(bindings?.username ?? "/username");
 </script>
 
 <template>
@@ -90,9 +90,17 @@ import { catalog } from "./catalog.js";
 import LoginSFC from "./Login.vue";
 import DashboardSFC from "./Dashboard.vue";
 
-export const { registry } = defineRegistry(catalog, {
+export const registryResult = defineRegistry(catalog, {
 	components: { Login: LoginSFC, Dashboard: DashboardSFC },
-	actions: { login: async () => {}, logout: async () => {} },
+	actions: {
+		login: async (params) => {
+			if (!params) return;
+			actor.send({ type: "auth.login", username: params.username });
+		},
+		logout: async (params) => {
+			actor.send({ type: "auth.logout" });
+		},
+	},
 });
 ```
 
@@ -173,7 +181,7 @@ export const machine = setup({
 import { definePlayer } from "@xmachines/play-xstate";
 import { PlayRenderer } from "@xmachines/play-vue";
 import { machine } from "./machine.js";
-import { registry } from "./registry.js";
+import { registryResult } from "./registry.js";
 
 const createPlayer = definePlayer({ machine });
 const actor = createPlayer();
@@ -181,11 +189,7 @@ actor.start();
 </script>
 
 <template>
-	<PlayRenderer
-		:actor="actor"
-		:registry="registry"
-		:actions="{ login: 'auth.login', logout: 'auth.logout' }"
-	/>
+	<PlayRenderer :actor="actor" :registryResult="registryResult" />
 </template>
 ```
 
@@ -196,23 +200,16 @@ actor.start();
 Main Vue component. Subscribes to `actor.currentView` and renders the spec.
 
 ```vue
-<PlayRenderer
-	:actor="actor"
-	:registry="registry"
-	:actions="{ login: 'auth.login' }"
-	:store="myStore"
-/>
+<PlayRenderer :actor="actor" :registryResult="registryResult" :store="myStore" />
 ```
 
 **`actor`** — A `PlayerActor` (or any `AbstractActor & Viewable`). Provides the `currentView` signal.
 
-**`registry`** — Built with `defineRegistry(catalog, { components, actions })` from `@xmachines/play-vue`. Pass `.vue` SFCs directly — they are auto-wrapped via `h(SFC, ctx)` so `useStateBinding` and other composables work inside `<script setup>`.
+**`registryResult`** — The full `DefineRegistryResult` returned by `defineRegistry(catalog, { components, actions })` from `@xmachines/play-vue`. Pass `.vue` SFCs directly — they are auto-wrapped via `h(SFC, ctx)` so `useBoundProp` and other composables work inside `<script setup>`.
 
 `defineRegistry` also accepts `onRenderError(error, elementType)`, which receives errors
 caught by `@json-render/vue`'s inner element boundary before the default logger is used.
 
-**`actions`** — Maps json-render action names (from spec `on` bindings) to XState event type strings. Type-checked against `EventFromLogic<TLogic>["type"]` when `TLogic` is specified.
-
 **`store`** (optional) — Controls per-view UI state (`$state` bindings, form values):
 
 - **Omitted (uncontrolled, default):** A fresh `@xstate/store` atom is created per view transition, seeded from `view.spec.state`.
@@ -230,9 +227,17 @@ const store: StateStore = xstateStoreStateStore({ atom: createAtom({ username: "
 overriding the outer Vue error boundary:
 
 ```ts
-export const { registry } = defineRegistry(catalog, {
+export const registryResult = defineRegistry(catalog, {
 	components: { Login: LoginSFC, Dashboard: DashboardSFC },
-	actions: { login: async () => {}, logout: async () => {} },
+	actions: {
+		login: async (params) => {
+			if (!params) return;
+			actor.send({ type: "auth.login", username: params.username });
+		},
+		logout: async (params) => {
+			actor.send({ type: "auth.logout" });
+		},
+	},
 	onRenderError(error, elementType) {
 		reportExpectedRenderError(error, elementType);
 	},
@@ -240,12 +245,7 @@ export const { registry } = defineRegistry(catalog, {
 ```
 
 ```vue
-<PlayRenderer
-	:actor="actor"
-	:registry="registry"
-	:store="store"
-	:actions="{ login: 'auth.login' }"
-/>
+<PlayRenderer :actor="actor" :registryResult="registryResult" :store="store" />
 ```
 
 ---
@@ -285,8 +285,8 @@ Priority: **route param fills `undefined` slots; explicit non-`undefined` spec p
 - Vue reactivity is only used to trigger re-renders — not for business logic
 - `actor.currentView` (TC39 Signal) is bridged to Vue's reactive system inside `PlayRenderer`
 - Per-view UI state lives in an `@xstate/store` atom, not in Vue reactive state
-- `@json-render/vue` drives rendering; `PlayRenderer` is the signal bridge — import `defineRegistry`, `ComponentFn`, `ComponentContext`, and `useStateBinding` from `@xmachines/play-vue`
-- Vue views should be `.vue` SFCs using `ComponentContext<MyCatalog, "X">` — `defineRegistry` from `@xmachines/play-vue` auto-wraps them via `h(SFC, ctx)`, giving each SFC its own `setup()` context where `useStateBinding` and Vue composables work correctly
+- `@json-render/vue` drives rendering; `PlayRenderer` is the signal bridge — import `defineRegistry`, `ComponentFn`, `ComponentContext`, and `useBoundProp` from `@xmachines/play-vue`
+- Vue views should be `.vue` SFCs using `ComponentContext<MyCatalog, "X">` — `defineRegistry` from `@xmachines/play-vue` auto-wraps them via `h(SFC, ctx)`, giving each SFC its own `setup()` context where `useBoundProp` and Vue composables work correctly
 
 @xmachines/play-vue - Vue 3 renderer for XMachines Play architecture
 
@@ -295,7 +295,7 @@ and renders UI components via @json-render/vue. Vue reactivity is only used
 to trigger re-renders — signals are the source of truth.
 
 Re-exports `defineRegistry` (SFC-aware — auto-wraps `.vue` SFCs via `h()`),
-`useStateBinding`, `ComponentFn`, and `ComponentContext` so consumers import
+`useBoundProp`, `ComponentFn`, and `ComponentContext` so consumers import
 everything from `@xmachines/play-vue` rather than `@json-render/vue` directly.
 
 ## Interfaces
@@ -319,4 +319,4 @@ everything from `@xmachines/play-vue` rather than `@json-render/vue` directly.
 
 - [defineRegistry](functions/defineRegistry.md)
 - [useActor](functions/useActor.md)
-- [useStateBinding](functions/useStateBinding.md)
+- [useBoundProp](functions/useBoundProp.md)

package/api/@xmachines/play-vue/functions/defineRegistry.md

@@ -6,7 +6,7 @@
 function defineRegistry<C>(catalog, options): DefineRegistryResult;
 ```
 
-Defined in: [packages/play-vue/src/define-registry.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue/src/define-registry.ts#L116)
+Defined in: [packages/play-vue/src/define-registry.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue/src/define-registry.ts#L116)
 
 Create a component registry, automatically wrapping `.vue` SFCs so they work
 correctly with `@json-render/vue`'s rendering pipeline.

package/api/@xmachines/play-vue/functions/useActor.md

@@ -6,7 +6,7 @@
 function useActor(): PlayActor;
 ```
 
-Defined in: [packages/play-vue/src/useActor.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue/src/useActor.ts#L42)
+Defined in: [packages/play-vue/src/useActor.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue/src/useActor.ts#L42)
 
 ## Returns
 

package/api/@xmachines/play-vue/functions/useBoundProp.md

@@ -0,0 +1,45 @@
+[Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / useBoundProp
+
+# Function: useBoundProp()
+
+```ts
+function useBoundProp<T>(propValue, bindingPath): [T | undefined, (value) => void];
+```
+
+Defined in: `@json-render/vue`
+
+Composable for two-way bound props. Returns `[value, setValue]` where:
+
+- `value` is the already-resolved prop value (passed through from render props)
+- `setValue` writes back to the bound state path (no-op if not bound)
+
+Designed to work with the `bindings` map that the renderer provides when
+a prop uses `{ $bindState: "/path" }` or `{ $bindItem: "field" }`.
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+## Parameters
+
+| Parameter     | Type                    |
+| ------------- | ----------------------- |
+| `propValue`   | `T` \| `undefined`      |
+| `bindingPath` | `string` \| `undefined` |
+
+## Returns
+
+\[`T` \| `undefined`, (`value`) => `void`\]
+
+## Example
+
+```ts
+import { useBoundProp } from "@json-render/vue";
+
+const Input: ComponentFn<AppCatalog, "Input"> = ({ props, bindings }) => {
+	const [value, setValue] = useBoundProp<string>(props.value as string, bindings?.value);
+	return h("input", { value: value ?? "", onInput: (e) => setValue(e.target.value) });
+};
+```

package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md

@@ -2,21 +2,20 @@
 
 # Interface: PlayRendererProps\<TLogic\>
 
-Defined in: [packages/play-vue/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue/src/types.ts#L25)
+Defined in: [packages/play-vue/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue/src/types.ts#L23)
 
 Props for PlayRenderer component
 
 ## Type Parameters
 
-| Type Parameter                                                                           | Default type                                                          | Description                                                                                                                                                                                                                 |
-| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `TLogic` _extends_ [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | The XState actor logic type. Defaults to `AnyActorLogic` for non-generic usage. When a specific machine type is provided, the `actions` values are constrained to the event type strings that the machine actually accepts. |
+| Type Parameter                                                                           | Default type                                                          | Description                                                                     |
+| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
+| `TLogic` _extends_ [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | The XState actor logic type. Defaults to `AnyActorLogic` for non-generic usage. |
 
 ## Properties
 
-| Property                                  | Type                                                                                                                                                                                                | Description                                                                                                                                                                                                                                                                                                                                                         | Defined in                                                                                                                               |
-| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actions"></a> `actions?`  | `object`                                                                                                                                                                                            | Optional map of json-render action names to XState event type strings. Values are constrained to `EventFromLogic<TLogic>["type"]` — passing a non-existent event type string is a compile error when TLogic is specified.                                                                                                                                           | [packages/play-vue/src/types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue/src/types.ts#L46) |
-| <a id="property-actor"></a> `actor`       | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability)                                                                                                                                                                                                                                                                                               | [packages/play-vue/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue/src/types.ts#L27) |
-| <a id="property-registry"></a> `registry` | `ComponentRegistry`                                                                                                                                                                                 | Component registry from @json-render/vue defineRegistry                                                                                                                                                                                                                                                                                                             | [packages/play-vue/src/types.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue/src/types.ts#L30) |
-| <a id="property-store"></a> `store?`      | `StateStore`                                                                                                                                                                                        | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [packages/play-vue/src/types.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue/src/types.ts#L39) |
+| Property                                              | Type                                                                                                                                                                                                | Description                                                                                                                                                                                                                                                                                                                                                         | Defined in                                                                                                                               |
+| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`                   | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability)                                                                                                                                                                                                                                                                                               | [packages/play-vue/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue/src/types.ts#L25) |
+| <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult`                                                                                                                                                                              | Full result from defineRegistry() in @json-render/vue. Contains both the component registry and the action handlers factory. Action handlers are real async functions dispatching to the actor (not string-mapped event types).                                                                                                                                     | [packages/play-vue/src/types.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue/src/types.ts#L32) |
+| <a id="property-store"></a> `store?`                  | `StateStore`                                                                                                                                                                                        | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [packages/play-vue/src/types.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue/src/types.ts#L41) |

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

@@ -6,7 +6,7 @@
 type ComponentEntry<C, K> = ComponentFn<C, K> | Component;
 ```
 
-Defined in: [packages/play-vue/src/define-registry.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue/src/define-registry.ts#L90)
+Defined in: [packages/play-vue/src/define-registry.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue/src/define-registry.ts#L90)
 
 ## Type Parameters
 

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

@@ -6,7 +6,7 @@
 type ComponentsMap<C> = { [K in keyof InferCatalogComponents<C>]?: ComponentEntry<C, K> };
 ```
 
-Defined in: [packages/play-vue/src/define-registry.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue/src/define-registry.ts#L94)
+Defined in: [packages/play-vue/src/define-registry.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue/src/define-registry.ts#L94)
 
 ## Type Parameters
 

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

@@ -7,13 +7,13 @@ type DefineRegistryOptions<C> = Omit<Parameters<typeof defineRegistryBase>[1], "
 	object;
 ```
 
-Defined in: [packages/play-vue/src/define-registry.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue/src/define-registry.ts#L98)
+Defined in: [packages/play-vue/src/define-registry.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue/src/define-registry.ts#L98)
 
 ## Type Declaration
 
 | Name          | Type                                       | Defined in                                                                                                                                                     |
 | ------------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue/src/define-registry.ts#L102) |
+| `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue/src/define-registry.ts#L102) |
 
 ## Type Parameters
 

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

@@ -6,4 +6,4 @@
 type PlayActor = AbstractActor<AnyActorLogic>;
 ```
 
-Defined in: [packages/play-vue/src/useActor.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue/src/useActor.ts#L25)
+Defined in: [packages/play-vue/src/useActor.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue/src/useActor.ts#L25)

package/api/@xmachines/play-vue/variables/PlayRenderer.md

@@ -6,4 +6,4 @@
 const PlayRenderer: DefineComponent<{}, {}, unknown>;
 ```
 
-Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue/src/vue-shim.d.ts#L3)
+Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue/src/vue-shim.d.ts#L3)

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

@@ -2,7 +2,7 @@
 
 # Class: RouteMap
 
-Defined in: [play-vue-router/src/route-map.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/route-map.ts#L10)
+Defined in: [play-vue-router/src/route-map.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue-router/src/route-map.ts#L10)
 
 Bidirectional route mapper for Vue Router.
 
@@ -20,7 +20,7 @@ Alias for [BaseRouteMap](VueBaseRouteMap.md) from `@xmachines/play-router`.
 new RouteMap(mappings, options?): RouteMap;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L125)
+Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L125)
 
 Build a route map from an array of state ID ↔ path mappings.
 
@@ -52,7 +52,7 @@ buckets for efficient candidate selection.
 getPathByStateId(stateId): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L209)
+Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L209)
 
 Look up the path pattern registered for a state ID.
 
@@ -87,7 +87,7 @@ map.getPathByStateId("missing"); // null
 getStateIdByPath(path): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L174)
+Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L174)
 
 Resolve a URL path to its mapped state ID.
 

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

@@ -2,7 +2,7 @@
 
 # Class: VueBaseRouteMap
 
-Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L100)
+Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L100)
 
 Shared bidirectional route map base class.
 
@@ -54,7 +54,7 @@ map.getPathByStateId("missing"); // null
 new VueBaseRouteMap(mappings, options?): BaseRouteMap;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L125)
+Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L125)
 
 Build a route map from an array of state ID ↔ path mappings.
 
@@ -82,7 +82,7 @@ buckets for efficient candidate selection.
 getPathByStateId(stateId): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L209)
+Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L209)
 
 Look up the path pattern registered for a state ID.
 
@@ -113,7 +113,7 @@ map.getPathByStateId("missing"); // null
 getStateIdByPath(path): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L174)
+Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L174)
 
 Resolve a URL path to its mapped state ID.
 

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

@@ -2,7 +2,7 @@
 
 # Class: VueRouterBridge
 
-Defined in: [play-vue-router/src/vue-router-bridge.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L16)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue-router/src/vue-router-bridge.ts#L16)
 
 @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:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L21)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue-router/src/vue-router-bridge.ts#L21)
 
 #### Parameters
 
@@ -45,15 +45,15 @@ Defined in: [play-vue-router/src/vue-router-bridge.ts:21](https://gitlab.com/xma
 
 | 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:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L99)   |
-| <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:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L87)   |
-| <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:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L86)   |
-| <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:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L89)   |
-| <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:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L88)   |
-| <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:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L100) |
-| `routeMap.getPathByStateId`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                                                                                                                                                | `undefined`   | -                                                                                                                                                                                                | -                                                                                                                                                                             | [play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L102) |
-| `routeMap.getStateIdByPath`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                                                                                                                                                | `undefined`   | -                                                                                                                                                                                                | -                                                                                                                                                                             | [play-router/src/router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L101) |
-| <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:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L90)   |
+| <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:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L99)   |
+| <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:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L87)   |
+| <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:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L86)   |
+| <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:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L89)   |
+| <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:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L88)   |
+| <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:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L100) |
+| `routeMap.getPathByStateId`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                                                                                                                                                | `undefined`   | -                                                                                                                                                                                                | -                                                                                                                                                                             | [play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L102) |
+| `routeMap.getStateIdByPath`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                                                                                                                                                | `undefined`   | -                                                                                                                                                                                                | -                                                                                                                                                                             | [play-router/src/router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L101) |
+| <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:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L90)   |
 
 ## Methods
 
@@ -63,7 +63,7 @@ Defined in: [play-vue-router/src/vue-router-bridge.ts:21](https://gitlab.com/xma
 connect(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L126)
+Defined in: [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L126)
 
 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:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L209)
+Defined in: [play-router/src/router-bridge-base.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L209)
 
 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:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L135)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue-router/src/vue-router-bridge.ts#L135)
 
 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:318](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L318)
+Defined in: [play-router/src/router-bridge-base.ts:318](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L318)
 
 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:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L355)
+Defined in: [play-router/src/router-bridge-base.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L355)
 
 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:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L115)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue-router/src/vue-router-bridge.ts#L115)
 
 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:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L127)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue-router/src/vue-router-bridge.ts#L127)
 
 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:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L64)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue-router/src/vue-router-bridge.ts#L64)
 
 Navigate Vue Router to the given path.
 
@@ -290,7 +290,7 @@ are skipped. Navigation errors are thrown as [VueRouterNavigationError](#).
 protected resolveNavigationPath(route): string | null;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L340)
+Defined in: [play-router/src/router-bridge-base.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L340)
 
 Resolve an actor route value to a concrete URL path for navigation.
 
@@ -329,7 +329,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:260](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L260)
+Defined in: [play-router/src/router-bridge-base.ts:260](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L260)
 
 Sync actor state when router location changes.
 
@@ -359,7 +359,7 @@ Prevents circular updates via isProcessingNavigation flag.
 protected syncRouterFromActor(route): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L240)
+Defined in: [play-router/src/router-bridge-base.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L240)
 
 Sync router location when actor route signal changes.
 
@@ -392,7 +392,7 @@ suppressed as circular echoes.
 protected unwatchRouterChanges(): void;
 ```
 
-Defined in: [play-vue-router/src/vue-router-bridge.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L110)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue-router/src/vue-router-bridge.ts#L110)
 
 Stop watching for router location changes.
 
@@ -414,7 +414,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
 protected watchRouterChanges(): void;
 ```
 
-Defined in: [play-vue-router/src/vue-router-bridge.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L78)
+Defined in: [play-vue-router/src/vue-router-bridge.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue-router/src/vue-router-bridge.ts#L78)
 
 Subscribe to Vue Router changes using `afterEach`.
 

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

@@ -6,7 +6,7 @@
 function createRouteMap(machine): RouteMap;
 ```
 
-Defined in: [play-vue-router/src/create-route-map.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/create-route-map.ts#L5)
+Defined in: [play-vue-router/src/create-route-map.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-vue-router/src/create-route-map.ts#L5)
 
 ## Parameters