@xmachines/docs 1.0.0-beta.19 → 1.0.0-beta.21

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.19/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.21/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:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-xstate/src/routing/format-play-route-transitions.ts#L88)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L88)
 
 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.19/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.21/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.19/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.21/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.19/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.21/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.19/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.21/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.19/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.19/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.21/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.21/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.19/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.21/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.19/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.21/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.19/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.21/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.19/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.19/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.19/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.19/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.19/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.21/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.21/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.21/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.21/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.21/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:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-xstate/src/routing/types.ts#L11)
+Defined in: [packages/play-xstate/src/routing/types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/types.ts#L11)
 
 Route build context from machine context
 
@@ -16,7 +16,7 @@ Route build context from machine context
 
 | Property                                         | Type                            | Description                    | Defined in                                                                                                                                                     |
 | ------------------------------------------------ | ------------------------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-basepath"></a> `basePath?`       | `string`                        | Base path for relative routes  | [packages/play-xstate/src/routing/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-xstate/src/routing/types.ts#L13) |
-| <a id="property-hash"></a> `hash?`               | `string`                        | Hash fragment                  | [packages/play-xstate/src/routing/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-xstate/src/routing/types.ts#L19) |
-| <a id="property-query"></a> `query?`             | `Record`\<`string`, `unknown`\> | Query parameters               | [packages/play-xstate/src/routing/types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-xstate/src/routing/types.ts#L17) |
-| <a id="property-routeparams"></a> `routeParams?` | `Record`\<`string`, `unknown`\> | Route parameters to substitute | [packages/play-xstate/src/routing/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-xstate/src/routing/types.ts#L15) |
+| <a id="property-basepath"></a> `basePath?`       | `string`                        | Base path for relative routes  | [packages/play-xstate/src/routing/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/types.ts#L13) |
+| <a id="property-hash"></a> `hash?`               | `string`                        | Hash fragment                  | [packages/play-xstate/src/routing/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/types.ts#L19) |
+| <a id="property-query"></a> `query?`             | `Record`\<`string`, `unknown`\> | Query parameters               | [packages/play-xstate/src/routing/types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/types.ts#L17) |
+| <a id="property-routeparams"></a> `routeParams?` | `Record`\<`string`, `unknown`\> | Route parameters to substitute | [packages/play-xstate/src/routing/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/types.ts#L15) |

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.19/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.21/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.19/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.21/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.19/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.21/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.19/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.21/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:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-xstate/src/routing/format-play-route-transitions.ts#L52)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L52)
 
 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:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-xstate/src/routing/format-play-route-transitions.ts#L53)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L53)
 
 ---
 
@@ -42,7 +42,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:5
 optional on?: Record<string, unknown>;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-xstate/src/routing/format-play-route-transitions.ts#L55)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L55)
 
 ---
 
@@ -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:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-xstate/src/routing/format-play-route-transitions.ts#L54)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L54)

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:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-xstate/src/routing/format-play-route-transitions.ts#L21)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L21)
 
 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:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-xstate/src/routing/format-play-route-transitions.ts#L23)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L23)
 
 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:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-xstate/src/routing/format-play-route-transitions.ts#L25)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L25)
 
 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:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-xstate/src/routing/format-play-route-transitions.ts#L30)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L30)
 
 Nested child states, recursively crawled for additional route declarations.

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

@@ -6,7 +6,7 @@
 function defineXmVitestConfig(importMetaUrl, overrides): object;
 ```
 
-Defined in: [src/index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/shared/src/index.ts#L10)
+Defined in: [src/index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/shared/src/index.ts#L10)
 
 Create a Vitest config with XMachines workspace defaults.
 
@@ -26,4 +26,4 @@ render it under `@xmachines/shared` instead of nested module pages.
 
 | Name   | Type  | Defined in                                                                                                                   |
 | ------ | ----- | ---------------------------------------------------------------------------------------------------------------------------- |
-| `test` | `any` | [config/vitest.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/shared/config/vitest.ts#L82) |
+| `test` | `any` | [config/vitest.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/shared/config/vitest.ts#L82) |

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xmachines/docs",
-  "version": "1.0.0-beta.19",
+  "version": "1.0.0-beta.21",
   "description": "Documentation for XMachines",
   "keywords": [
     "documentation",
@@ -22,6 +22,7 @@
     "api",
     "examples",
     "guides",
+    "rfc",
     "index.js",
     "index.d.ts"
   ],
@@ -33,7 +34,8 @@
     },
     "./api/*": "./api/*",
     "./examples/*": "./examples/*",
-    "./guides/*": "./guides/*"
+    "./guides/*": "./guides/*",
+    "./rfc/*": "./rfc/*"
   },
   "publishConfig": {
     "access": "public"
@@ -46,7 +48,7 @@
     "typedoc": "typedoc"
   },
   "devDependencies": {
-    "@xmachines/shared": "1.0.0-beta.19",
+    "@xmachines/shared": "1.0.0-beta.21",
     "typedoc": "^0.28.18",
     "typedoc-plugin-llms-txt": "^0.1.2",
     "typedoc-plugin-markdown": "^4.11.0"

package/rfc/broker.md

@@ -0,0 +1,100 @@
+# RFC: Broker
+
+**Status:** Draft  
+**Version:** 1  
+**Scope:** Real-time event transport, consumer coordination, run execution bindings  
+**Non-goals:** Persistence formats, execution semantics
+
+---
+
+## 1. Purpose
+
+This RFC defines how **XMachines runs** are driven by streaming broker backends.
+
+Unlike **Git**, which solves for durability and offline distribution, **Broker** solves for:
+
+- **Liveness:** pushing events to machines in real-time
+- **Coordination:** managing concurrency via consumer groups
+- **Transport:** bridging the gap between topics and run streams
+
+---
+
+## 2. Separation of Concerns
+
+This RFC establishes **Broker** as orthogonal to **Git**.
+
+| Feature          | Git (Persistence)              | Broker (Execution)                    |
+| ---------------- | ------------------------------ | ------------------------------------- |
+| Role             | the ledger (storage)           | the pipe (transport)                  |
+| Model            | pull (fetch/clone)             | push (subscribe)                      |
+| Concurrency      | optimistic locking (branching) | pessimistic locking (consumer groups) |
+| Latency          | batch / high latency           | streaming / sub-second                |
+| Primary Artifact | commit (immutable record)      | message (trigger)                     |
+
+A typical setup uses Broker for the **hot path** (real-time execution) and Git for the **cold path** (archival/audit).
+
+---
+
+## 3. Package Model
+
+The Broker implementation follows the adapter pattern:
+
+- **`@xmachines/broker`** — core interfaces for `BrokerConsumer` and `BrokerProducer`
+- **`@xmachines/broker-kafka`** — Kafka adapter
+- **`@xmachines/broker-redpanda`** — Redpanda adapter
+
+---
+
+## 4. Execution Model
+
+The Broker acts as the **drive mechanism** for a run. It does not replace the run; it feeds it.
+
+### Consumer Binding
+
+- The Broker subscribes to a topic
+- It maps the partition key to a specific **run ID**
+- It instantiates the run (if not already running)
+
+### Stream Piping
+
+**Inbound:**  
+The Broker pipes the topic partition into the run's **in stream** (`WritableStream`)
+
+**Outbound:**  
+The Broker pipes the run's **out stream** (`ReadableStream`) back to a result topic or dead-letter queue
+
+### Backpressure
+
+Because XMachines uses **Web Streams**, backpressure propagates automatically.
+
+If the run is slow to process, the Broker stops fetching from the partition.
+
+---
+
+## 5. Concurrency & Ordering
+
+[Run RFC](run.md) mandates that a run is deterministic given an ordered sequence of events.
+
+**Broker RFC** guarantees this via **partition leasing**:
+
+- A specific run ID is pinned to a specific partition
+- The Broker's consumer group protocol ensures only one worker node holds the lease at any time
+
+This provides the **single writer guarantee** required by the run without needing a distributed lock manager.
+
+---
+
+## 6. Invariants
+
+1. Transport agnostic — the run does not know it is being driven by Kafka
+2. Ordering preserved — messages from a partition are delivered in strict order
+3. At-least-once — offsets are committed only after the run has successfully processed the event
+4. Partition alignment — a single run must never span multiple partitions
+
+---
+
+## 7. Lock statement
+
+> The Broker is the active transport binding that drives XMachines runs from real-time streams.  
+> It handles coordination and delivery, delegating logic to the run and persistence to the configured durability backend.  
+> This is Broker.

package/rfc/browser.md

@@ -0,0 +1,44 @@
+# RFC: Browser
+
+**Status:** Draft  
+**Version:** 1  
+**Scope:** Browser-native interoperability  
+**Non-goals:** Execution, persistence, protocols
+
+---
+
+## 1. Purpose
+
+Defines browser-specific adapters using Web Streams.
+
+---
+
+## 2. Package Model
+
+Alias:
+
+- `@xmachines/browser`
+
+Implementations:
+
+- `browser-dom`
+- `browser-ws`
+- `browser-worker`
+
+Only non-isomorphic APIs receive browser packages.
+
+---
+
+## 3. Invariants
+
+1. Web Streams only
+2. Optional dependency
+3. No persistence
+4. No protocol semantics
+
+---
+
+## 4. Lock statement
+
+> Browser interop is explicit and stream-based.  
+> This is Browser.

package/rfc/cli.md

@@ -0,0 +1,118 @@
+# RFC: CLI
+
+**Status:** Draft  
+**Version:** 1  
+**Scope:** Command-line interface architecture, configuration, and implementation resolution  
+**Non-goals:** Execution semantics, protocol definitions, stream behavior
+
+---
+
+## 1. Purpose
+
+This RFC defines the XMachines CLI architecture.
+
+The CLI provides:
+
+- a human-facing interface to XMachines capabilities
+- configuration and defaults for implementation selection
+- an orchestration layer over RFC-defined capabilities
+
+The CLI does not define behavior. It selects and wires implementations.
+
+---
+
+## 2. Design Principles
+
+1. CLI is optional
+2. CLI never defines semantics
+3. CLI resolves implementations explicitly
+4. Configuration is explicit and persistent
+5. Alias packages expose commands, implementation packages implement behavior
+
+---
+
+## 3. Package Structure
+
+- `@xmachines/cli`
+- built using oclif
+- contains command definitions and shared helpers only
+
+---
+
+## 4. Implementation Resolution
+
+Resolution order:
+
+1. explicit CLI flags
+2. persisted configuration
+3. alias-level defaults (if any)
+4. error
+
+Implementation identifiers are stored as fully qualified package names.
+If no scope is provided, default scope is `@xmachines/`.
+
+---
+
+## 5. Configuration Model
+
+- stored via oclif config
+- user-scoped
+- persistent across upgrades
+
+Defaults follow a first-writer-wins strategy.
+
+---
+
+## 6. Install & Uninstall Hooks
+
+Implementation packages MAY:
+
+- suggest themselves as defaults on install
+- respect `if-not-set` or `quiet` strategies
+- avoid auto-reassignment on uninstall
+
+Uninstall MAY support an explicit purge option to remove config entries.
+
+---
+
+## 7. Feature Enablement
+
+Some capabilities expose features (e.g. REST, Git, MCP).
+
+Rules:
+
+- features map to installed packages
+- enablement is explicit
+- disablement requires explicit flags
+
+---
+
+## 8. Scope Boundaries
+
+The CLI:
+
+- wires components
+- launches servers
+- manages configuration
+
+The CLI does NOT:
+
+- define protocol semantics
+- parse stream payloads
+- implement execution logic
+
+---
+
+## 9. Invariants
+
+1. No implicit defaults
+2. Explicit implementation selection
+3. CLI never defines semantics
+
+---
+
+## 10. Lock statement
+
+> The CLI is an orchestration and configuration layer only.  
+> All semantics live in other RFCs.  
+> This is CLI.

package/rfc/git.md

@@ -0,0 +1,61 @@
+# RFC: Git
+
+**Status:** Draft  
+**Version:** 1  
+**Scope:** Durable streams and distribution  
+**Non-goals:** Runtime execution
+
+---
+
+## 1. Purpose
+
+Git is used as:
+
+- durable stream
+- replication mechanism
+- backup format
+
+Git is optional.
+
+---
+
+## 2. Model
+
+- machines = orphan branches
+- runs = forks
+- events = commits
+- snapshots = commits
+
+History is append-only.
+
+---
+
+## 3. Identity
+
+- commit hashes are canonical IDs
+- same algorithm used with or without Git
+
+---
+
+## 4. SmartHTTP
+
+```
+/<repo>.git/**
+```
+
+Standard Git semantics apply.
+
+---
+
+## 5. Invariants
+
+1. No history rewriting
+2. Git is optional
+3. Append-only semantics
+
+---
+
+## 6. Lock statement
+
+> Git is a durable, append-only stream for XMachines.  
+> This is Git.