@xmachines/docs 1.0.0-beta.30 → 1.0.0-beta.32

package/api/@xmachines/play-xstate/functions/composeGuardsOr.md

@@ -6,7 +6,7 @@
 function composeGuardsOr<TContext, TEvent>(guards): ComposedGuard;
 ```
 
-Defined in: [packages/play-xstate/src/guards/compose.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/guards/compose.ts#L143)
+Defined in: [packages/play-xstate/src/guards/compose.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/guards/compose.ts#L143)
 
 Compose guards with OR logic using XState's or() helper
 

package/api/@xmachines/play-xstate/functions/contextFieldMatches.md

@@ -6,7 +6,7 @@
 function contextFieldMatches<TContext>(fieldPath, expectedValue): Guard<TContext, PlayEvent>;
 ```
 
-Defined in: [packages/play-xstate/src/guards/helpers.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/guards/helpers.ts#L68)
+Defined in: [packages/play-xstate/src/guards/helpers.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/guards/helpers.ts#L68)
 
 Check if a context field matches an expected value.
 

package/api/@xmachines/play-xstate/functions/definePlayer.md

@@ -6,7 +6,7 @@
 function definePlayer<TMachine>(config): PlayerFactory<TMachine>;
 ```
 
-Defined in: [packages/play-xstate/src/define-player.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/define-player.ts#L61)
+Defined in: [packages/play-xstate/src/define-player.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/define-player.ts#L61)
 
 Create a player factory from an XState machine
 

package/api/@xmachines/play-xstate/functions/deriveRoute.md

@@ -6,7 +6,7 @@
 function deriveRoute(stateMeta): string | null;
 ```
 
-Defined in: [packages/play-xstate/src/routing/derive-route.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/derive-route.ts#L90)
+Defined in: [packages/play-xstate/src/routing/derive-route.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/derive-route.ts#L90)
 
 Derive route from XState state metadata
 

package/api/@xmachines/play-xstate/functions/eventMatches.md

@@ -6,7 +6,7 @@
 function eventMatches<TEvent>(eventType): Guard<unknown, TEvent>;
 ```
 
-Defined in: [packages/play-xstate/src/guards/helpers.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/guards/helpers.ts#L49)
+Defined in: [packages/play-xstate/src/guards/helpers.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/guards/helpers.ts#L49)
 
 Check if event type matches expected type
 

package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md

@@ -6,7 +6,7 @@
 function formatPlayRouteTransitions<T>(machineConfig): T;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/format-play-route-transitions.ts#L84)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/format-play-route-transitions.ts#L84)
 
 Formats play.route transitions from declarative route configs
 

package/api/@xmachines/play-xstate/functions/hasContext.md

@@ -6,7 +6,7 @@
 function hasContext<TContext>(path): Guard<TContext, PlayEvent>;
 ```
 
-Defined in: [packages/play-xstate/src/guards/helpers.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/guards/helpers.ts#L23)
+Defined in: [packages/play-xstate/src/guards/helpers.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/guards/helpers.ts#L23)
 
 Check if context has a truthy value at path
 

package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md

@@ -6,7 +6,7 @@
 function isAbsoluteRoute(path): boolean;
 ```
 
-Defined in: [packages/play-xstate/src/routing/derive-route.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/derive-route.ts#L150)
+Defined in: [packages/play-xstate/src/routing/derive-route.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/derive-route.ts#L150)
 
 Check if route path is absolute
 

package/api/@xmachines/play-xstate/functions/negateGuard.md

@@ -6,7 +6,7 @@
 function negateGuard<TContext, TEvent>(guard): ComposedGuard;
 ```
 
-Defined in: [packages/play-xstate/src/guards/compose.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/guards/compose.ts#L203)
+Defined in: [packages/play-xstate/src/guards/compose.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/guards/compose.ts#L203)
 
 Negate a guard using XState's not() helper
 

package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md

@@ -2,7 +2,7 @@
 
 # Interface: PlayerConfig\<TMachine\>
 
-Defined in: [packages/play-xstate/src/types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/types.ts#L7)
+Defined in: [packages/play-xstate/src/types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/types.ts#L7)
 
 Configuration for definePlayer()
 
@@ -16,5 +16,5 @@ Configuration for definePlayer()
 
 | Property                                 | Type                                              | Description                       | Defined in                                                                                                                                     |
 | ---------------------------------------- | ------------------------------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-machine"></a> `machine`  | `TMachine`                                        | XState v5 state machine           | [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/types.ts#L9)   |
-| <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\> | Lifecycle hooks and configuration | [packages/play-xstate/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/types.ts#L12) |
+| <a id="property-machine"></a> `machine`  | `TMachine`                                        | XState v5 state machine           | [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/types.ts#L9)   |
+| <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\> | Lifecycle hooks and configuration | [packages/play-xstate/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/types.ts#L12) |

package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md

@@ -2,7 +2,7 @@
 
 # Interface: PlayerFactoryResumeOptions\<TMachine\>
 
-Defined in: [packages/play-xstate/src/types.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/types.ts#L47)
+Defined in: [packages/play-xstate/src/types.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/types.ts#L47)
 
 Optional restore arguments for the player factory.
 
@@ -19,4 +19,4 @@ Mirrors XState's createActor options bag while preserving the existing
 
 | Property                                   | Type                                                                              | Description                                            | Defined in                                                                                                                                     |
 | ------------------------------------------ | --------------------------------------------------------------------------------- | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-snapshot"></a> `snapshot?` | [`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\> | Persisted XState snapshot used to restore actor state. | [packages/play-xstate/src/types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/types.ts#L49) |
+| <a id="property-snapshot"></a> `snapshot?` | [`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\> | Persisted XState snapshot used to restore actor state. | [packages/play-xstate/src/types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/types.ts#L49) |

package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md

@@ -2,7 +2,7 @@
 
 # Interface: PlayerOptions\<TMachine\>
 
-Defined in: [packages/play-xstate/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/types.ts#L20)
+Defined in: [packages/play-xstate/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/types.ts#L20)
 
 Player lifecycle hooks
 
@@ -18,8 +18,8 @@ Per CONTEXT.md: Rich set of hooks for observability
 
 | Property                                             | Type                                          | Description                      | Defined in                                                                                                                                     |
 | ---------------------------------------------------- | --------------------------------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-onerror"></a> `onError?`             | (`actor`, `error`) => `void`                  | Called on actor errors           | [packages/play-xstate/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/types.ts#L38) |
-| <a id="property-onstart"></a> `onStart?`             | (`actor`) => `void`                           | Called when actor starts         | [packages/play-xstate/src/types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/types.ts#L22) |
-| <a id="property-onstatechange"></a> `onStateChange?` | (`actor`, `state`) => `void`                  | Called when state signal changes | [packages/play-xstate/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/types.ts#L35) |
-| <a id="property-onstop"></a> `onStop?`               | (`actor`) => `void`                           | Called when actor stops          | [packages/play-xstate/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/types.ts#L25) |
-| <a id="property-ontransition"></a> `onTransition?`   | (`actor`, `prevState`, `nextState`) => `void` | Called on every state transition | [packages/play-xstate/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/types.ts#L28) |
+| <a id="property-onerror"></a> `onError?`             | (`actor`, `error`) => `void`                  | Called on actor errors           | [packages/play-xstate/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/types.ts#L38) |
+| <a id="property-onstart"></a> `onStart?`             | (`actor`) => `void`                           | Called when actor starts         | [packages/play-xstate/src/types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/types.ts#L22) |
+| <a id="property-onstatechange"></a> `onStateChange?` | (`actor`, `state`) => `void`                  | Called when state signal changes | [packages/play-xstate/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/types.ts#L35) |
+| <a id="property-onstop"></a> `onStop?`               | (`actor`) => `void`                           | Called when actor stops          | [packages/play-xstate/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/types.ts#L25) |
+| <a id="property-ontransition"></a> `onTransition?`   | (`actor`, `prevState`, `nextState`) => `void` | Called on every state transition | [packages/play-xstate/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/types.ts#L28) |

package/api/@xmachines/play-xstate/interfaces/RouteContext.md

@@ -2,7 +2,7 @@
 
 # Interface: RouteContext
 
-Defined in: [packages/play-xstate/src/routing/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/types.ts#L19)
+Defined in: [packages/play-xstate/src/routing/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/types.ts#L19)
 
 Route build context from machine context.
 
@@ -18,7 +18,7 @@ must populate `params` explicitly.
 
 | Property                                   | Type                            | Description                                                                        | Defined in                                                                                                                                                     |
 | ------------------------------------------ | ------------------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-basepath"></a> `basePath?` | `string`                        | Base path for relative routes                                                      | [packages/play-xstate/src/routing/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/types.ts#L21) |
-| <a id="property-hash"></a> `hash?`         | `string`                        | Hash fragment                                                                      | [packages/play-xstate/src/routing/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/types.ts#L27) |
-| <a id="property-params"></a> `params?`     | `Record`\<`string`, `unknown`\> | Path-only route parameters to substitute (e.g., `:userId` from `/profile/:userId`) | [packages/play-xstate/src/routing/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/types.ts#L23) |
-| <a id="property-query"></a> `query?`       | `Record`\<`string`, `unknown`\> | Query parameters                                                                   | [packages/play-xstate/src/routing/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/types.ts#L25) |
+| <a id="property-basepath"></a> `basePath?` | `string`                        | Base path for relative routes                                                      | [packages/play-xstate/src/routing/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/types.ts#L21) |
+| <a id="property-hash"></a> `hash?`         | `string`                        | Hash fragment                                                                      | [packages/play-xstate/src/routing/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/types.ts#L27) |
+| <a id="property-params"></a> `params?`     | `Record`\<`string`, `unknown`\> | Path-only route parameters to substitute (e.g., `:userId` from `/profile/:userId`) | [packages/play-xstate/src/routing/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/types.ts#L23) |
+| <a id="property-query"></a> `query?`       | `Record`\<`string`, `unknown`\> | Query parameters                                                                   | [packages/play-xstate/src/routing/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/types.ts#L25) |

package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md

@@ -6,7 +6,7 @@
 type ComposedGuard = GuardPredicate<MachineContext, EventObject, unknown, ParameterizedObject>;
 ```
 
-Defined in: [packages/play-xstate/src/guards/compose.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/guards/compose.ts#L14)
+Defined in: [packages/play-xstate/src/guards/compose.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/guards/compose.ts#L14)
 
 Narrowest public return type for guard composition helpers.
 

package/api/@xmachines/play-xstate/type-aliases/Guard.md

@@ -6,7 +6,7 @@
 type Guard<TContext, TEvent> = (args) => boolean;
 ```
 
-Defined in: [packages/play-xstate/src/guards/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/guards/types.ts#L13)
+Defined in: [packages/play-xstate/src/guards/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/guards/types.ts#L13)
 
 Standard XState guard function signature
 

package/api/@xmachines/play-xstate/type-aliases/GuardArray.md

@@ -6,7 +6,7 @@
 type GuardArray<TContext, TEvent> = Guard<TContext, TEvent>[] | string[];
 ```
 
-Defined in: [packages/play-xstate/src/guards/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/guards/types.ts#L23)
+Defined in: [packages/play-xstate/src/guards/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/guards/types.ts#L23)
 
 Array of guard predicates or guard names
 

package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md

@@ -6,7 +6,7 @@
 type PlayerFactory<TMachine> = (input?, options?) => PlayerActor<TMachine>;
 ```
 
-Defined in: [packages/play-xstate/src/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/types.ts#L57)
+Defined in: [packages/play-xstate/src/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/types.ts#L57)
 
 Factory function returned by definePlayer()
 

package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md

@@ -6,7 +6,7 @@
 type RouteMachineConfig = object;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/format-play-route-transitions.ts#L48)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/format-play-route-transitions.ts#L48)
 
 Minimal structural constraint for machine configs accepted by
 `formatPlayRouteTransitions`.
@@ -32,7 +32,7 @@ through the transform, so the return value remains directly usable by
 optional context?: unknown;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/format-play-route-transitions.ts#L49)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/format-play-route-transitions.ts#L49)
 
 ---
 
@@ -42,7 +42,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:4
 optional on?: Record<string, unknown>;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/format-play-route-transitions.ts#L51)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/format-play-route-transitions.ts#L51)
 
 ---
 
@@ -52,4 +52,4 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:5
 optional states?: Record<string, unknown>;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/format-play-route-transitions.ts#L50)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/format-play-route-transitions.ts#L50)

package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md

@@ -6,7 +6,7 @@
 type RouteStateNode = object;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/format-play-route-transitions.ts#L13)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/format-play-route-transitions.ts#L13)
 
 Minimal structural shape of a single XState state node as read by
 `formatPlayRouteTransitions` when crawling the machine config.
@@ -29,7 +29,7 @@ the index signature.
 optional id?: string;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/format-play-route-transitions.ts#L15)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/format-play-route-transitions.ts#L15)
 
 Optional explicit state ID (e.g. `"home"`, `"settings"`). Used as the `#id` target in `play.route` events.
 
@@ -41,7 +41,7 @@ Optional explicit state ID (e.g. `"home"`, `"settings"`). Used as the `#id` targ
 optional meta?: object;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/format-play-route-transitions.ts#L17)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/format-play-route-transitions.ts#L17)
 
 State metadata — `meta.route` marks the state as routable.
 
@@ -61,6 +61,6 @@ URL path template (e.g. `"/profile/:username"`, `"/settings/:section?"`).
 optional states?: Record<string, RouteStateNode>;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/format-play-route-transitions.ts#L22)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-xstate/src/routing/format-play-route-transitions.ts#L22)
 
 Nested child states, recursively crawled for additional route declarations.

package/api/@xmachines/shared/README.md

@@ -140,7 +140,7 @@ What the shared Vitest layer provides automatically:
 - Shared setup injection (`config/vitest.setup.ts`) unless already present
 - Node setup injection (`config/vitest.node.setup.ts`) for non-browser projects
 - Runtime preflight:
-    - Node.js runtime/version check (`>=22`) in node setup
+  - Node.js runtime/version check (`>=22`) in node setup
 - DOM matcher extension via `@testing-library/jest-dom/vitest`
 
 ### Vitest Setup Injection Rules
@@ -190,9 +190,9 @@ import { foo } from "./bar"; // ❌ Wrong
 - **Plugins:** TypeScript, Unicorn, Import
 - **Categories:** Correctness (error), Suspicious (warn), Performance (warn)
 - **Key Rules:**
-    - Circular dependency detection (`import/no-cycle`)
-    - Unused variables (allow `_` prefix)
-    - TypeScript-specific checks
+  - Circular dependency detection (`import/no-cycle`)
+  - Unused variables (allow `_` prefix)
+  - TypeScript-specific checks
 
 ### Oxfmt (`config/oxfmt.json`)
 
@@ -206,14 +206,14 @@ import { foo } from "./bar"; // ❌ Wrong
 - **Helper API:** `defineXmVitestConfig(importMetaUrl, overrides)` merges shared defaults with package-specific Vitest config
 - **Auto-aliasing:** `resolve.alias` is wired to `xmAliases(importMetaUrl)` so workspace packages resolve to source
 - **Cross-runtime setup (`config/vitest.setup.ts`):**
-    - extends `expect` with `@testing-library/jest-dom/vitest`
+  - extends `expect` with `@testing-library/jest-dom/vitest`
 - **URLPattern setup (`config/vitest.urlpattern.setup.ts`):**
-    - loads `urlpattern-polyfill` — opt-in per package via `setupFiles: ["@xmachines/shared/vitest-urlpattern-setup"]`
-    - required for packages exercising URLPattern-based route matching (play-router and adapters)
-    - mirrors what consumers must do in production on Node < 24 or older browsers
+  - loads `urlpattern-polyfill` — opt-in per package via `setupFiles: ["@xmachines/shared/vitest-urlpattern-setup"]`
+  - required for packages exercising URLPattern-based route matching (play-router and adapters)
+  - mirrors what consumers must do in production on Node < 24 or older browsers
 - **Node-only setup (`config/vitest.node.setup.ts`):**
-    - asserts Node runtime (`process.release.name === "node"`)
-    - enforces Node version `>=22`
+  - asserts Node runtime (`process.release.name === "node"`)
+  - enforces Node version `>=22`
 - **Browser behavior:** Browser projects do not receive node-only setup injection
 - **Override model:** Package-level config still controls test environment, includes/excludes, plugins, coverage, and browser provider
 
@@ -228,22 +228,22 @@ import { foo } from "./bar"; // ❌ Wrong
 ### Vite Alias Troubleshooting
 
 - **`[xmAliases] Could not find workspace root`**
-    - Ensure `xmAliases` receives `import.meta.url` from the calling config file.
-    - Ensure the config file lives somewhere under the monorepo root.
+  - Ensure `xmAliases` receives `import.meta.url` from the calling config file.
+  - Ensure the config file lives somewhere under the monorepo root.
 - **Workspace package import resolves to missing `dist/` files**
-    - Ensure config includes `resolve.alias: xmAliases(import.meta.url)`.
-    - Re-run after cleaning caches when lockfile/deps changed.
+  - Ensure config includes `resolve.alias: xmAliases(import.meta.url)`.
+  - Re-run after cleaning caches when lockfile/deps changed.
 
 ### Vitest Troubleshooting
 
 - **`URLPattern is unavailable after setup`**
-    - Ensure `test.setupFiles` is not replacing shared setup unexpectedly.
-    - Ensure config is created via `defineXmVitestConfig(...)`.
+  - Ensure `test.setupFiles` is not replacing shared setup unexpectedly.
+  - Ensure config is created via `defineXmVitestConfig(...)`.
 - **`Node runtime is required for this Vitest configuration`**
-    - This indicates node-only setup loaded in a browser project.
-    - Set `test.browser.enabled: true` in that project config.
+  - This indicates node-only setup loaded in a browser project.
+  - Set `test.browser.enabled: true` in that project config.
 - **Workspace import resolution failures (e.g. `@xmachines/play-signals`)**
-    - Confirm config uses `defineXmVitestConfig(import.meta.url, ...)` so aliases are injected.
+  - Confirm config uses `defineXmVitestConfig(import.meta.url, ...)` so aliases are injected.
 
 ## TypeScript Composite Build System
 
@@ -311,31 +311,31 @@ When creating a new package:
 
 1. **Add to root tsconfig.json references:**
 
-    ```json
-    {
-    	"references": [{ "path": "./packages/your-new-package" }]
-    }
-    ```
+   ```json
+   {
+   	"references": [{ "path": "./packages/your-new-package" }]
+   }
+   ```
 
 2. **Enable composite in package tsconfig.json:**
 
-    ```json
-    {
-    	"extends": "@xmachines/shared/tsconfig",
-    	"compilerOptions": {
-    		"composite": true,
-    		"rootDir": "./src",
-    		"outDir": "./dist"
-    	}
-    }
-    ```
+   ```json
+   {
+   	"extends": "@xmachines/shared/tsconfig",
+   	"compilerOptions": {
+   		"composite": true,
+   		"rootDir": "./src",
+   		"outDir": "./dist"
+   	}
+   }
+   ```
 
 3. **Declare dependencies (if any):**
-    ```json
-    {
-    	"references": [{ "path": "../dependency-package" }]
-    }
-    ```
+   ```json
+   {
+   	"references": [{ "path": "../dependency-package" }]
+   }
+   ```
 
 ### IDE Benefits
 
@@ -355,14 +355,14 @@ To add a new shared configuration (e.g., for Jest, Vitest, etc.):
 
 1. Create `config/<tool>.json` (or `.js`, `.ts` as appropriate)
 2. Add exports to `package.json` exports field:
-    ```json
-    {
-    	"exports": {
-    		"./<tool>": "./config/<tool>.json",
-    		"./config/<tool>.json": "./config/<tool>.json"
-    	}
-    }
-    ```
+   ```json
+   {
+   	"exports": {
+   		"./<tool>": "./config/<tool>.json",
+   		"./config/<tool>.json": "./config/<tool>.json"
+   	}
+   }
+   ```
 3. Document in this README with usage examples
 4. Note whether the tool supports package exports or requires relative paths
 

package/api/@xmachines/shared/functions/defineXmVitestConfig.md

@@ -6,7 +6,7 @@
 function defineXmVitestConfig(importMetaUrl, overrides): UserConfig;
 ```
 
-Defined in: [index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/shared/src/index.ts#L10)
+Defined in: [index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/shared/src/index.ts#L10)
 
 Create a Vitest config with XMachines workspace defaults.
 

package/api/@xmachines/shared/functions/xmAliases.md

@@ -6,7 +6,7 @@
 function xmAliases(importMetaUrl): Record<string, string>;
 ```
 
-Defined in: [index.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/shared/src/index.ts#L20)
+Defined in: [index.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/shared/src/index.ts#L20)
 
 Build Vite/Vitest alias entries for all `@xmachines/*` workspace packages.
 

package/examples/@xmachines/play-dom-demo/README.md

@@ -127,13 +127,19 @@ Expected result: library-pattern invariant tests pass and the browser renderer s
 - [Play DOM package README](../../README.md)
 - [Play DOM Router demo README](../../../play-dom-router/examples/demo/README.md)
 
+## Type Aliases
+
+- [AuthCatalog](type-aliases/AuthCatalog.md)
+
 ## Variables
 
 - [About](variables/About.md)
+- [authCatalog](variables/authCatalog.md)
 - [Contact](variables/Contact.md)
 - [Dashboard](variables/Dashboard.md)
 - [Home](variables/Home.md)
 - [Login](variables/Login.md)
+- [NavBarView](variables/NavBarView.md)
 - [Navigation](variables/Navigation.md)
 - [Overview](variables/Overview.md)
 - [Profile](variables/Profile.md)
@@ -142,4 +148,5 @@ Expected result: library-pattern invariant tests pass and the browser renderer s
 
 ## Functions
 
+- [createNavBar](functions/createNavBar.md)
 - [initShell](functions/initShell.md)

package/examples/@xmachines/play-dom-demo/functions/createNavBar.md

@@ -0,0 +1,23 @@
+[Documentation](../../../README.md) / [@xmachines/play-dom-demo](../README.md) / createNavBar
+
+# Function: createNavBar()
+
+```ts
+function createNavBar(actor, container): () => void;
+```
+
+Defined in: [play-dom/examples/demo/src/components/NavBar.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/examples/demo/src/components/NavBar.ts#L15)
+
+Create and mount a reactive NavBar into the given container element.
+Returns a cleanup function to stop watching.
+
+## Parameters
+
+| Parameter   | Type          |
+| ----------- | ------------- |
+| `actor`     | `AuthActor`   |
+| `container` | `HTMLElement` |
+
+## Returns
+
+() => `void`

package/examples/@xmachines/play-dom-demo/functions/initShell.md

@@ -6,7 +6,7 @@
 function initShell(actor, appElement): () => void;
 ```
 
-Defined in: [shell.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/examples/demo/src/shell.ts#L32)
+Defined in: [play-dom/examples/demo/src/shell.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/examples/demo/src/shell.ts#L33)
 
 ## Parameters
 

package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-dom-demo](../README.md) / AuthCatalog
+
+# Type Alias: AuthCatalog
+
+```ts
+type AuthCatalog = typeof authCatalog;
+```
+
+Defined in: [play-dom/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/examples/demo/src/catalog.ts#L6)

package/examples/@xmachines/play-dom-demo/variables/About.md

@@ -6,4 +6,4 @@
 const About: ComponentFn<AuthCatalog, "About">;
 ```
 
-Defined in: [components/About.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/examples/demo/src/components/About.ts#L4)
+Defined in: [play-dom/examples/demo/src/components/About.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/examples/demo/src/components/About.ts#L4)

package/examples/@xmachines/play-dom-demo/variables/Contact.md

@@ -6,4 +6,4 @@
 const Contact: ComponentFn<AuthCatalog, "Contact">;
 ```
 
-Defined in: [components/Contact.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/examples/demo/src/components/Contact.ts#L4)
+Defined in: [play-dom/examples/demo/src/components/Contact.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/examples/demo/src/components/Contact.ts#L4)

package/examples/@xmachines/play-dom-demo/variables/Dashboard.md

@@ -6,4 +6,4 @@
 const Dashboard: ComponentFn<AuthCatalog, "Dashboard">;
 ```
 
-Defined in: [components/Dashboard.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/examples/demo/src/components/Dashboard.ts#L4)
+Defined in: [play-dom/examples/demo/src/components/Dashboard.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/examples/demo/src/components/Dashboard.ts#L4)

package/examples/@xmachines/play-dom-demo/variables/Home.md

@@ -6,4 +6,4 @@
 const Home: ComponentFn<AuthCatalog, "Home">;
 ```
 
-Defined in: [components/Home.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/examples/demo/src/components/Home.ts#L4)
+Defined in: [play-dom/examples/demo/src/components/Home.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/examples/demo/src/components/Home.ts#L4)

package/examples/@xmachines/play-dom-demo/variables/Login.md

@@ -6,4 +6,4 @@
 const Login: ComponentFn<AuthCatalog, "Login">;
 ```
 
-Defined in: [components/Login.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/examples/demo/src/components/Login.ts#L4)
+Defined in: [play-dom/examples/demo/src/components/Login.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/examples/demo/src/components/Login.ts#L4)

package/examples/@xmachines/play-dom-demo/variables/NavBarView.md

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-dom-demo](../README.md) / NavBarView
+
+# Variable: NavBarView
+
+```ts
+const NavBarView: ComponentFn<AuthCatalog, "NavBar">;
+```
+
+Defined in: [play-dom/examples/demo/src/components/NavBarView.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/examples/demo/src/components/NavBarView.ts#L13)

package/examples/@xmachines/play-dom-demo/variables/Navigation.md

@@ -6,4 +6,4 @@
 const Navigation: ComponentFn<AuthCatalog, "Navigation">;
 ```
 
-Defined in: [components/Navigation.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/examples/demo/src/components/Navigation.ts#L4)
+Defined in: [play-dom/examples/demo/src/components/Navigation.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/examples/demo/src/components/Navigation.ts#L4)

package/examples/@xmachines/play-dom-demo/variables/Overview.md

@@ -6,4 +6,4 @@
 const Overview: ComponentFn<AuthCatalog, "Overview">;
 ```
 
-Defined in: [components/Overview.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/examples/demo/src/components/Overview.ts#L4)
+Defined in: [play-dom/examples/demo/src/components/Overview.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/examples/demo/src/components/Overview.ts#L4)