@xmachines/docs 1.0.0 → 2.0.0-alpha.1

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

@@ -6,36 +6,38 @@
 function composeGuards<TContext, TEvent>(guards): ComposedGuard;
 ```
 
-Defined in: [packages/play-xstate/src/guards/compose.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/guards/compose.ts#L78)
+Defined in: [packages/play-xstate/src/guards/compose.ts:130](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/guards/compose.ts#L130)
 
-Compose guards with AND logic using XState's and() helper
+Compose guards with AND logic.
 
 Combines multiple guard predicates using AND semantics—all guards must pass for
-the composition to succeed. Uses XState's built-in `and()` helper to ensure proper
-type inference and machine serialization.
+the composition to succeed. Evaluation is short-circuiting, left to right.
 
 **Architectural Context:** Supports **Actor Authority (INV-01)** by enabling
 declarative guard composition in state machine transitions. Guards enforce business
 logic rules that determine whether navigation or actions are valid.
 
+**XState v6:** the composed value is a plain predicate. Call it inside a
+transition function and return early to block the transition:
+
 ## Type Parameters
 
-| Type Parameter | Default type | Description                |
-| -------------- | ------------ | -------------------------- |
-| `TContext`     | `any`        | State machine context type |
-| `TEvent`       | `any`        | Event type                 |
+| Type Parameter | Default type | Description                                                                                                            |
+| -------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------- |
+| `TContext`     | `any`        | State machine context type (defaults to `any` so the documented inline-predicate examples compile without annotations) |
+| `TEvent`       | `any`        | Event type                                                                                                             |
 
 ## Parameters
 
-| Parameter | Type                                                                  | Description                                                  |
-| --------- | --------------------------------------------------------------------- | ------------------------------------------------------------ |
-| `guards`  | [`GuardArray`](../type-aliases/GuardArray.md)\<`TContext`, `TEvent`\> | Array of guard predicates or guard names (string references) |
+| Parameter | Type                                                                  | Description                                                                                                          |
+| --------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| `guards`  | [`GuardArray`](../type-aliases/GuardArray.md)\<`TContext`, `TEvent`\> | Array of guard predicates or guard names (string references resolved against `args.guards` from `setup({ guards })`) |
 
 ## Returns
 
 [`ComposedGuard`](../type-aliases/ComposedGuard.md)
 
-XState and() guard composition
+Predicate returning `true` only when every guard passes
 
 ## Throws
 
@@ -49,6 +51,8 @@ AND composition with named guards
 import { setup } from "xstate";
 import { composeGuards } from "@xmachines/play-xstate";
 
+const canAccessAdmin = composeGuards(["isLoggedIn", "hasPermission"]);
+
 const machine = setup({
 	guards: {
 		isLoggedIn: ({ context }) => !!context.userId,
@@ -56,10 +60,9 @@ const machine = setup({
 	},
 }).createMachine({
 	on: {
-		accessAdmin: {
-			// Both guards must pass
-			guard: composeGuards(["isLoggedIn", "hasPermission"]),
-			target: "adminPanel",
+		accessAdmin: (args) => {
+			if (!canAccessAdmin(args)) return;
+			return { target: "adminPanel" };
 		},
 	},
 });
@@ -70,7 +73,10 @@ AND composition with inline predicates
 ```typescript
 import { composeGuards } from "@xmachines/play-xstate";
 
-guard: composeGuards([({ context }) => context.age >= 18, ({ context }) => context.verified]);
+const isEligible = composeGuards([
+	({ context }) => context.age >= 18,
+	({ context }) => context.verified,
+]);
 ```
 
 ## See

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

@@ -6,32 +6,31 @@
 function composeGuardsOr<TContext, TEvent>(guards): ComposedGuard;
 ```
 
-Defined in: [packages/play-xstate/src/guards/compose.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/guards/compose.ts#L144)
+Defined in: [packages/play-xstate/src/guards/compose.ts:189](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/guards/compose.ts#L189)
 
-Compose guards with OR logic using XState's or() helper
+Compose guards with OR logic.
 
 Combines multiple guard predicates using OR semantics—at least one guard must pass
-for the composition to succeed. Uses XState's built-in `or()` helper for proper
-type inference.
+for the composition to succeed. Evaluation is short-circuiting, left to right.
 
 ## Type Parameters
 
-| Type Parameter | Default type | Description                |
-| -------------- | ------------ | -------------------------- |
-| `TContext`     | `any`        | State machine context type |
-| `TEvent`       | `any`        | Event type                 |
+| Type Parameter | Default type |
+| -------------- | ------------ |
+| `TContext`     | `any`        |
+| `TEvent`       | `any`        |
 
 ## Parameters
 
-| Parameter | Type                                                                  | Description                              |
-| --------- | --------------------------------------------------------------------- | ---------------------------------------- |
-| `guards`  | [`GuardArray`](../type-aliases/GuardArray.md)\<`TContext`, `TEvent`\> | Array of guard predicates or guard names |
+| Parameter | Type                                                                  | Description                                                                                                          |
+| --------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| `guards`  | [`GuardArray`](../type-aliases/GuardArray.md)\<`TContext`, `TEvent`\> | Array of guard predicates or guard names (string references resolved against `args.guards` from `setup({ guards })`) |
 
 ## Returns
 
 [`ComposedGuard`](../type-aliases/ComposedGuard.md)
 
-XState or() guard composition
+Predicate returning `true` when any guard passes
 
 ## Throws
 
@@ -45,6 +44,8 @@ OR composition with named guards
 import { setup } from "xstate";
 import { composeGuardsOr } from "@xmachines/play-xstate";
 
+const canDelete = composeGuardsOr(["isOwner", "isAdmin"]);
+
 const machine = setup({
 	guards: {
 		isOwner: ({ context }) => context.role === "owner",
@@ -52,10 +53,9 @@ const machine = setup({
 	},
 }).createMachine({
 	on: {
-		deleteResource: {
-			// Either guard can pass
-			guard: composeGuardsOr(["isOwner", "isAdmin"]),
-			actions: "delete",
+		deleteResource: (args, enq) => {
+			if (!canDelete(args)) return;
+			enq(() => deleteIt());
 		},
 	},
 });

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:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/guards/helpers.ts#L71)
+Defined in: [packages/play-xstate/src/guards/helpers.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/guards/helpers.ts#L71)
 
 Check if a context field matches an expected value.
 

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

@@ -0,0 +1,87 @@
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / createRoutedMachine
+
+# Function: createRoutedMachine()
+
+```ts
+function createRoutedMachine<TSetup>(s): TSetup["createMachine"];
+```
+
+Defined in: [packages/play-xstate/src/routing/create-routed-machine.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/create-routed-machine.ts#L78)
+
+Returns a `createMachine` that routes: identical signature to the setup's
+own `createMachine`, with [formatPlayRouteTransitions](formatPlayRouteTransitions.md) applied to the
+config at runtime.
+
+### Why this exists
+
+`formatPlayRouteTransitions(config)` accepts a loosely-typed config. A config
+authored as a standalone value loses inline transition-function parameter
+inference entirely (implicit-any under strict mode), and even the inline
+`setup().createMachine(formatPlayRouteTransitions({ ... }))` form depends on
+TypeScript threading contextual typing through two generic calls.
+
+This wrapper removes the question: it is typed as the setup's own
+`createMachine`, so the config is contextually typed exactly as if passed to
+`setup().createMachine(...)` directly — transition-function args infer from
+the setup's schemas, sibling targets are validated, and the returned machine
+keeps its full literal state-value typing.
+
+Typing is _identical to native_ — including its current gaps: as of xstate
+6.0.0-alpha.20, `event` and `context` reads in transition args are fully
+typed, while returned context patches are property-typed but still carry a
+loose index signature in the alpha itself. Expect that to tighten upstream
+without changes here.
+
+## Type Parameters
+
+| Type Parameter                                                 |
+| -------------------------------------------------------------- |
+| `TSetup` _extends_ [`SetupLike`](../type-aliases/SetupLike.md) |
+
+## Parameters
+
+| Parameter | Type     | Description                                                  |
+| --------- | -------- | ------------------------------------------------------------ |
+| `s`       | `TSetup` | A `setup(...)` return value (anything with `createMachine`). |
+
+## Returns
+
+`TSetup`\[`"createMachine"`\]
+
+A function with the same signature as `s.createMachine` that
+applies [formatPlayRouteTransitions](formatPlayRouteTransitions.md) before creating the machine.
+
+## Example
+
+```typescript
+import { setup, types } from "xstate";
+import { createRoutedMachine, playMetaSchema, playRouteEventSchema } from "@xmachines/play-xstate";
+
+const authSetup = setup({
+	schemas: {
+		context: types<{ isAuthenticated: boolean }>(),
+		events: { "play.route": playRouteEventSchema },
+		meta: playMetaSchema,
+	},
+});
+
+const machine = createRoutedMachine(authSetup)({
+	initial: "home",
+	context: { isAuthenticated: false },
+	states: {
+		home: { id: "home", meta: { route: "/" } },
+		login: { id: "login", meta: { route: "/login" } },
+	},
+});
+// ({ context }) params in transitions infer from the setup schemas —
+// no explicit annotations needed.
+```
+
+Note: routes are injected at runtime, so the machine's static type does not
+gain an `xstate.route` event for them — `play.route` (declared in the
+setup's event schemas) remains the typed public API; native `xstate.route`
+interop is runtime-only.
+
+## See
+
+[formatPlayRouteTransitions](formatPlayRouteTransitions.md) for the routing transform itself

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

@@ -6,11 +6,11 @@
 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/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/v2.0.0-alpha.1/packages/play-xstate/src/define-player.ts#L61)
 
 Create a player factory from an XState machine
 
-Factory pattern that accepts an XState v5 machine,
+Factory pattern that accepts an XState v6 machine,
 returning a function that creates [PlayerActor](../classes/PlayerActor.md) instances. This enables
 creating multiple actor instances from a single configuration, useful for
 testing, multi-instance scenarios, or server-side rendering.
@@ -19,7 +19,7 @@ testing, multi-instance scenarios, or server-side rendering.
 
 | Type Parameter                                                                                 | Description                  |
 | ---------------------------------------------------------------------------------------------- | ---------------------------- |
-| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | XState v5 state machine type |
+| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | XState v6 state machine type |
 
 ## Parameters
 

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:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/routing/derive-route.ts#L91)
+Defined in: [packages/play-xstate/src/routing/derive-route.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/derive-route.ts#L91)
 
 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:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/guards/helpers.ts#L50)
+Defined in: [packages/play-xstate/src/guards/helpers.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/guards/helpers.ts#L50)
 
 Check if event type matches expected type
 

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

@@ -6,14 +6,20 @@
 function formatPlayRouteTransitions<T>(machineConfig): T;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L89)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:146](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L146)
 
-Formats play.route transitions from declarative route configs
+Formats play.route routing from declarative route configs.
 
-Crawls machine states looking for states with meta.route and generates
-transitions that handle `play.route` events by matching event.to to state IDs.
+Crawls machine states looking for states with `meta.route` and wires them to
+XState v6's **native routing machinery**:
 
-Inspired by XState's internal formatRouteTransitions (stateUtils.ts line 391).
+- every routed state gets a native `route: {}` config (unless it already
+  declares its own `route`), making it targetable via the built-in
+  `{ type: "xstate.route", to: "#id" }` event (Stately tooling interop and
+  statically-known graph edges), and
+- one root-level `play.route` forwarder performs the navigation for those
+  targets as ONE atomic transition: target + re-entry + a shallow
+  `params`/`query` context patch.
 
 ## Type Parameters
 
@@ -31,7 +37,7 @@ Inspired by XState's internal formatRouteTransitions (stateUtils.ts line 391).
 
 `T`
 
-The same machine config with auto-generated `play.route` handlers merged in, preserving the original type `T`.
+The machine config with native `route` configs and the `play.route` forwarder merged in, preserving the original type `T`.
 
 ## Example
 
@@ -47,8 +53,36 @@ const machineConfig = {
 const machine = createMachine(formatPlayRouteTransitions(machineConfig));
 ```
 
-This automatically generates play.route handlers at the root level that:
-
-- Match event.to against state IDs (e.g., event.to === "#home")
-- Target the appropriate state
-- Assign params and query from the event to context
+Because the injected `route` configs are static (object form), the machine's
+route transitions keep **statically-known targets** — `toDirectedGraph()` /
+`machineToGraph()` edges point at the actual routed states, so graph
+reachability queries work. (Function-form transition candidates would have
+dynamic targets, opaque to static analysis.)
+
+The `play.route` public API and its v5 semantics are preserved:
+
+- `send({ type: "play.route", to: "#home", params, query })` navigates and
+  patches `context.params`/`context.query` in the SAME transition — exit
+  actions of the departing state observe the OLD params, entry actions of
+  the target observe the NEW ones, `always` transitions never see a
+  half-navigated intermediate state, and entry/exit actions receive the
+  original `play.route` event;
+- user-defined `play.route` transitions (e.g. a hand-written 404 fallback)
+  are preserved AFTER the forwarder: for unknown targets the forwarder
+  returns `undefined`, so evaluation falls through to them;
+- `params`/`query` are only patched when the forwarder navigates — unknown
+  and blocked targets leave context untouched.
+
+When a state declares its OWN `route` config (which wins over the injected
+default), the forwarder re-raises the event as `xstate.route` instead of
+navigating, so the user's resolver decides — including blocking. The
+forwarder does NOT patch `params`/`query` for such targets (a blocking
+resolver would otherwise leave context describing a route that was never
+entered); the user's function-form resolver owns any context patch, and
+that navigation microstep runs under the `xstate.route` event.
+
+Native `xstate.route` events also work directly (Stately ecosystem tooling),
+but bypass the forwarder — no `params`/`query` context patch is applied, so
+stale values from earlier `play.route` events linger in context (and a
+router bridge deriving the URL from context would interpolate those stale
+params).

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:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/guards/helpers.ts#L24)
+Defined in: [packages/play-xstate/src/guards/helpers.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/guards/helpers.ts#L24)
 
 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:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/routing/derive-route.ts#L160)
+Defined in: [packages/play-xstate/src/routing/derive-route.ts:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/derive-route.ts#L160)
 
 Check if route path is absolute
 

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

@@ -6,31 +6,30 @@
 function negateGuard<TContext, TEvent>(guard): ComposedGuard;
 ```
 
-Defined in: [packages/play-xstate/src/guards/compose.ts:204](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/guards/compose.ts#L204)
+Defined in: [packages/play-xstate/src/guards/compose.ts:248](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/guards/compose.ts#L248)
 
-Negate a guard using XState's not() helper
+Negate a guard.
 
 Inverts a guard's result—if the guard passes, NOT fails; if guard fails, NOT passes.
-Uses XState's built-in `not()` helper for proper serialization.
 
 ## Type Parameters
 
-| Type Parameter | Default type | Description                |
-| -------------- | ------------ | -------------------------- |
-| `TContext`     | `any`        | State machine context type |
-| `TEvent`       | `any`        | Event type                 |
+| Type Parameter | Default type | Description                                                                                     |
+| -------------- | ------------ | ----------------------------------------------------------------------------------------------- |
+| `TContext`     | `any`        | State machine context type (defaults to `any` so inline predicates compile without annotations) |
+| `TEvent`       | `any`        | Event type                                                                                      |
 
 ## Parameters
 
-| Parameter | Type                                                                    | Description                             |
-| --------- | ----------------------------------------------------------------------- | --------------------------------------- |
-| `guard`   | `string` \| [`Guard`](../type-aliases/Guard.md)\<`TContext`, `TEvent`\> | Guard predicate or guard name to negate |
+| Parameter | Type                                                                    | Description                                                                                       |
+| --------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| `guard`   | `string` \| [`Guard`](../type-aliases/Guard.md)\<`TContext`, `TEvent`\> | Guard predicate or guard name (resolved against `args.guards` from `setup({ guards })`) to negate |
 
 ## Returns
 
 [`ComposedGuard`](../type-aliases/ComposedGuard.md)
 
-XState not() guard negation
+Predicate returning the inverted guard result
 
 ## Example
 
@@ -40,16 +39,17 @@ NOT composition with named guard
 import { setup } from "xstate";
 import { negateGuard } from "@xmachines/play-xstate";
 
+const isAuthenticated = negateGuard("isGuest");
+
 const machine = setup({
 	guards: {
 		isGuest: ({ context }) => !context.userId,
 	},
 }).createMachine({
 	on: {
-		accessDashboard: {
-			// Allow if NOT a guest (i.e., authenticated)
-			guard: negateGuard("isGuest"),
-			target: "dashboard",
+		accessDashboard: (args) => {
+			if (!isAuthenticated(args)) return;
+			return { target: "dashboard" };
 		},
 	},
 });

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/packages/play-xstate/src/types.ts#L7)
+Defined in: [packages/play-xstate/src/types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/types.ts#L7)
 
 Configuration for definePlayer()
 
@@ -14,7 +14,7 @@ Configuration for definePlayer()
 
 ## Properties
 
-| 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/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/packages/play-xstate/src/types.ts#L12) |
+| Property                                 | Type                                              | Description                       | Defined in                                                                                                                                     |
+| ---------------------------------------- | ------------------------------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-machine"></a> `machine`  | `TMachine`                                        | XState v6 state machine           | [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/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/v2.0.0-alpha.1/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/packages/play-xstate/src/types.ts#L47)
+Defined in: [packages/play-xstate/src/types.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/types.ts#L47)
 
 Optional restore arguments for the player factory.
 
@@ -17,6 +17,6 @@ Mirrors XState's createActor options bag while preserving the existing
 
 ## Properties
 
-| 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/packages/play-xstate/src/types.ts#L49) |
+| 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/v2.0.0-alpha.1/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/packages/play-xstate/src/types.ts#L20)
+Defined in: [packages/play-xstate/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/types.ts#L20)
 
 Player lifecycle hooks
 
@@ -16,10 +16,10 @@ Per CONTEXT.md: Rich set of hooks for observability
 
 ## Properties
 
-| 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/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/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/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/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/packages/play-xstate/src/types.ts#L28) |
+| 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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/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/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/v2.0.0-alpha.1/packages/play-xstate/src/routing/types.ts#L19)
 
 Route build context from machine context.
 
@@ -16,9 +16,9 @@ must populate `params` explicitly.
 
 ## Properties
 
-| 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/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/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/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/packages/play-xstate/src/routing/types.ts#L25) |
+| 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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/packages/play-xstate/src/routing/types.ts#L25) |

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

@@ -2,7 +2,7 @@
 
 # Interface: RouteObject
 
-Defined in: [packages/play-xstate/src/routing/types.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/routing/types.ts#L1)
+Defined in: [packages/play-xstate/src/routing/types.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/types.ts#L1)
 
 ## Indexable
 
@@ -12,6 +12,6 @@ Defined in: [packages/play-xstate/src/routing/types.ts:1](https://gitlab.com/xma
 
 ## Properties
 
-| Property                          | Type     | Defined in                                                                                                                                           |
-| --------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-path"></a> `path` | `string` | [packages/play-xstate/src/routing/types.ts:2](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/routing/types.ts#L2) |
+| Property                          | Type     | Defined in                                                                                                                                                   |
+| --------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-path"></a> `path` | `string` | [packages/play-xstate/src/routing/types.ts:2](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/types.ts#L2) |