@xmachines/docs 1.0.0-beta.9 → 2.0.0-alpha.1

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / negateGuard
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / negateGuard
 
 # Function: negateGuard()
 
@@ -6,31 +6,30 @@
 function negateGuard<TContext, TEvent>(guard): ComposedGuard;
 ```
 
-Defined in: [packages/play-xstate/src/guards/compose.ts:198](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/guards/compose.ts#L198)
+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

@@ -1,24 +1,20 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / PlayerConfig
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / PlayerConfig
 
-# Interface: PlayerConfig\<TMachine, TCatalog\>
+# Interface: PlayerConfig\<TMachine\>
 
-Defined in: [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/types.ts#L9)
+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()
 
-Per CONTEXT.md: Single config object with machine, catalog, options
-
 ## Type Parameters
 
-| Type Parameter                         | Default type                    |
-| -------------------------------------- | ------------------------------- |
-| `TMachine` _extends_ `AnyStateMachine` | -                               |
-| `TCatalog`                             | `Record`\<`string`, `unknown`\> |
+| Type Parameter                                                                                 |
+| ---------------------------------------------------------------------------------------------- |
+| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
 
 ## Properties
 
-| Property                                 | Type                                              | Description                                                  | Defined in                                                                                                                                                               |
-| ---------------------------------------- | ------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-catalog"></a> `catalog?` | `TCatalog`                                        | UI component catalog (optional - allows machines without UI) | [packages/play-xstate/src/types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/types.ts#L17) |
-| <a id="property-machine"></a> `machine`  | `TMachine`                                        | XState v5 state machine                                      | [packages/play-xstate/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/types.ts#L14) |
-| <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\> | Lifecycle hooks and configuration                            | [packages/play-xstate/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/types.ts#L20) |
+| 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

@@ -0,0 +1,22 @@
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / PlayerFactoryResumeOptions
+
+# Interface: PlayerFactoryResumeOptions\<TMachine\>
+
+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.
+
+Mirrors XState's createActor options bag while preserving the existing
+`createPlayer(input?)` calling convention for fresh actors.
+
+## Type Parameters
+
+| Type Parameter                                                                                 |
+| ---------------------------------------------------------------------------------------------- |
+| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
+
+## 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/v2.0.0-alpha.1/packages/play-xstate/src/types.ts#L49) |

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

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / PlayerOptions
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / PlayerOptions
 
 # Interface: PlayerOptions\<TMachine\>
 
-Defined in: [packages/play-xstate/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/types.ts#L28)
+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
 
@@ -10,17 +10,16 @@ Per CONTEXT.md: Rich set of hooks for observability
 
 ## Type Parameters
 
-| Type Parameter                         |
-| -------------------------------------- |
-| `TMachine` _extends_ `AnyStateMachine` |
+| Type Parameter                                                                                 |
+| ---------------------------------------------------------------------------------------------- |
+| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
 
 ## 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:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/types.ts#L46) |
-| <a id="property-onstart"></a> `onStart?`               | (`actor`) => `void`                           | Called when actor starts                                                                                                                                                                                                                                                                                                                                            | [packages/play-xstate/src/types.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/types.ts#L30) |
-| <a id="property-onstatechange"></a> `onStateChange?`   | (`actor`, `state`) => `void`                  | Called when state signal changes                                                                                                                                                                                                                                                                                                                                    | [packages/play-xstate/src/types.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/types.ts#L43) |
-| <a id="property-onstop"></a> `onStop?`                 | (`actor`) => `void`                           | Called when actor stops                                                                                                                                                                                                                                                                                                                                             | [packages/play-xstate/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/types.ts#L33) |
-| <a id="property-ontransition"></a> `onTransition?`     | (`actor`, `prevState`, `nextState`) => `void` | Called on every state transition                                                                                                                                                                                                                                                                                                                                    | [packages/play-xstate/src/types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/types.ts#L36) |
-| <a id="property-propvalidation"></a> `propValidation?` | `"strict"` \| `"lenient"`                     | Prop validation failure mode (default: 'lenient') - 'lenient': On validation failure, call onError hook and render with unvalidated props (current behavior). Documents as explicit trade-off. - 'strict': On validation failure, call onError hook and set viewSignal to null (no render). Blocks rendering until machine transitions to a state with valid props. | [packages/play-xstate/src/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/types.ts#L57) |
+| 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

@@ -1,22 +1,24 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / RouteContext
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / RouteContext
 
 # Interface: RouteContext
 
-Defined in: [packages/play-xstate/src/routing/types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/routing/types.ts#L11)
+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
+Route build context from machine context.
 
-## Indexable
+All URL parameter substitution must go through `params` — flat context fields are not
+inspected. This is intentional: the index signature was removed to enable compile-time
+validation of context shapes and IDE autocomplete on context fields.
 
-```ts
-[key: string]: unknown
-```
+Machines using `formatPlayRouteTransitions` have `params` and `query` assigned
+automatically from each `play.route` event. Machines that call `buildRouteUrl` directly
+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:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/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/00a28432ed57807112288436d1ae4387d9f06919/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/00a28432ed57807112288436d1ae4387d9f06919/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/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/routing/types.ts#L15) |
+| 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

@@ -0,0 +1,17 @@
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / RouteObject
+
+# Interface: RouteObject
+
+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
+
+```ts
+[key: string]: unknown
+```
+
+## 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/v2.0.0-alpha.1/packages/play-xstate/src/routing/types.ts#L2) |

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

@@ -1,14 +1,35 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / ComposedGuard
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / ComposedGuard
 
 # Type Alias: ComposedGuard
 
 ```ts
-type ComposedGuard = GuardPredicate<MachineContext, EventObject, unknown, ParameterizedObject>;
+type ComposedGuard = (args) => boolean;
 ```
 
-Defined in: [packages/play-xstate/src/guards/compose.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/guards/compose.ts#L14)
+Defined in: [packages/play-xstate/src/guards/compose.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/guards/compose.ts#L28)
 
-Narrowest public return type for guard composition helpers.
+Composed guard: a plain predicate over transition arguments.
 
-`GuardPredicate<MachineContext, EventObject, unknown, ParameterizedObject>` is the
-widest-compatible concrete XState guard type that does not use `any`.
+XState v6 removed guard objects and the `and()`/`or()`/`not()` creators —
+guards are now plain functions evaluated inside transition functions. A
+composed guard is therefore just another predicate with the same shape as
+[Guard](Guard.md), callable anywhere transition args are available.
+
+String guard names are resolved against `args.guards` (the named guards
+declared in `setup({ guards })`, which XState v6 passes to every transition
+function). Resolving a name outside a transition function — or a name that
+was never declared — throws `UnresolvableGuardNameError` immediately.
+
+String names work in `on` transitions, `always`, entry/exit actions (since
+xstate 6.0.0-alpha.20 populates `guards` there), and function-form route
+resolvers.
+
+## Parameters
+
+| Parameter | Type      |
+| --------- | --------- |
+| `args`    | `unknown` |
+
+## Returns
+
+`boolean`

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / Guard
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / Guard
 
 # Type Alias: Guard\<TContext, TEvent\>
 
@@ -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/00a28432ed57807112288436d1ae4387d9f06919/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/v2.0.0-alpha.1/packages/play-xstate/src/guards/types.ts#L13)
 
 Standard XState guard function signature
 

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

@@ -1,12 +1,12 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / GuardArray
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / GuardArray
 
 # Type Alias: GuardArray\<TContext, TEvent\>
 
 ```ts
-type GuardArray<TContext, TEvent> = Guard<TContext, TEvent>[] | string[];
+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/00a28432ed57807112288436d1ae4387d9f06919/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/v2.0.0-alpha.1/packages/play-xstate/src/guards/types.ts#L23)
 
 Array of guard predicates or guard names
 

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

@@ -0,0 +1,30 @@
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / PlayRoutePayload
+
+# Type Alias: PlayRoutePayload
+
+```ts
+type PlayRoutePayload = WithOptional<
+	WithOptional<
+		WithOptional<
+			{
+				to: PlayRouteEvent["to"];
+			},
+			{
+				params: Record<string, string>;
+			}
+		>,
+		{
+			query: Record<string, string>;
+		}
+	>,
+	{
+		match: unknown;
+	}
+>;
+```
+
+Defined in: [packages/play-xstate/src/routing/schemas.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/schemas.ts#L62)
+
+The `play.route` event payload as machines receive it: `to` required;
+`params`/`query`/`match` encoded as optional-by-union so they stay omittable
+through XState v6's `Required<>` event inference.

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

@@ -1,12 +1,12 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / PlayerFactory
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / PlayerFactory
 
 # Type Alias: PlayerFactory\<TMachine\>
 
 ```ts
-type PlayerFactory<TMachine> = (input?) => PlayerActor<TMachine>;
+type PlayerFactory<TMachine> = (input?, options?) => PlayerActor<TMachine>;
 ```
 
-Defined in: [packages/play-xstate/src/types.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/types.ts#L65)
+Defined in: [packages/play-xstate/src/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/types.ts#L57)
 
 Factory function returned by definePlayer()
 
@@ -14,15 +14,16 @@ Per CONTEXT.md: Factory supports creating multiple actor instances
 
 ## Type Parameters
 
-| Type Parameter                         |
-| -------------------------------------- |
-| `TMachine` _extends_ `AnyStateMachine` |
+| Type Parameter                                                                                 |
+| ---------------------------------------------------------------------------------------------- |
+| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
 
 ## Parameters
 
-| Parameter | Type                      |
-| --------- | ------------------------- |
-| `input?`  | `InputFrom`\<`TMachine`\> |
+| Parameter  | Type                                                                                      |
+| ---------- | ----------------------------------------------------------------------------------------- |
+| `input?`   | [`InputFrom`](https://www.jsdocs.io/package/xstate#InputFrom)\<`TMachine`\>               |
+| `options?` | [`PlayerFactoryResumeOptions`](../interfaces/PlayerFactoryResumeOptions.md)\<`TMachine`\> |
 
 ## Returns
 

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / RouteMachineConfig
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / RouteMachineConfig
 
 # Type Alias: RouteMachineConfig
 
@@ -6,7 +6,24 @@
 type RouteMachineConfig = object;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/routing/format-play-route-transitions.ts#L29)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L76)
+
+Minimal structural constraint for machine configs accepted by
+`formatPlayRouteTransitions`.
+
+This is intentionally loose so the function accepts both the bare `createMachine`
+config object and the stricter `setup().createMachine` config without requiring
+any type casts at the call site. The generic `T extends RouteMachineConfig`
+parameter on `formatPlayRouteTransitions` preserves the original concrete type
+of the RETURN value, so it remains directly usable by `setup().createMachine()`.
+
+Known limitation: a config authored as a STANDALONE value
+(`const config = formatPlayRouteTransitions({...})`) is typed against this
+loose shape only, so inline transition functions lose parameter inference
+(implicit-any under strict mode). Written inline inside a
+`setup().createMachine(formatPlayRouteTransitions({...}))` call, contextual
+typing still flows. [createRoutedMachine](../functions/createRoutedMachine.md) is the recommended entry
+point either way — it keeps the setup's exact `createMachine` signature.
 
 ## Indexable
 
@@ -22,7 +39,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:2
 optional context?: unknown;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/routing/format-play-route-transitions.ts#L30)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L77)
 
 ---
 
@@ -32,7 +49,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:3
 optional on?: Record<string, unknown>;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/routing/format-play-route-transitions.ts#L32)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L79)
 
 ---
 
@@ -42,4 +59,4 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:3
 optional states?: Record<string, unknown>;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/routing/format-play-route-transitions.ts#L31)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L78)

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

@@ -0,0 +1,9 @@
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / RouteMetadata
+
+# Type Alias: RouteMetadata
+
+```ts
+type RouteMetadata = string | RouteObject;
+```
+
+Defined in: [packages/play-xstate/src/routing/types.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/types.ts#L6)

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-xstate](../README.md) / RouteStateNode
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / RouteStateNode
 
 # Type Alias: RouteStateNode
 
@@ -6,7 +6,14 @@
 type RouteStateNode = object;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/routing/format-play-route-transitions.ts#L13)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L14)
+
+Minimal structural shape of a single XState state node as read by
+`formatPlayRouteTransitions` when crawling the machine config.
+
+Only the fields the function actually inspects are typed here; all other
+state-node fields (e.g. `on`, `entry`, `after`) pass through unmodified via
+the index signature.
 
 ## Indexable
 
@@ -22,7 +29,9 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:1
 optional id?: string;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/routing/format-play-route-transitions.ts#L14)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L16)
+
+Optional explicit state ID (e.g. `"home"`, `"settings"`). Used as the `#id` target in `play.route` events.
 
 ---
 
@@ -32,14 +41,31 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:1
 optional meta?: object;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/routing/format-play-route-transitions.ts#L15)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L18)
+
+State metadata — `meta.route` marks the state as routable.
 
 #### route?
 
 ```ts
-optional route?: string;
+optional route?: RouteMetadata;
+```
+
+URL path template — string form (e.g. `"/profile/:username"`) or object
+form (`{ path, title }`), matching [RouteMetadata](RouteMetadata.md).
+
+---
+
+### route?
+
+```ts
+optional route?: unknown;
 ```
 
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L26)
+
+XState v6 native route config; injected as `{}` when absent.
+
 ---
 
 ### states?
@@ -48,4 +74,6 @@ optional route?: string;
 optional states?: Record<string, RouteStateNode>;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-xstate/src/routing/format-play-route-transitions.ts#L18)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L28)
+
+Nested child states, recursively crawled for additional route declarations.

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

@@ -0,0 +1,33 @@
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / SetupLike
+
+# Type Alias: SetupLike
+
+```ts
+type SetupLike = object;
+```
+
+Defined in: [packages/play-xstate/src/routing/create-routed-machine.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/create-routed-machine.ts#L11)
+
+Structural constraint for `setup(...)` return values: anything exposing a
+`createMachine` function. Kept structural (rather than importing XState's
+`SetupReturn`) so the wrapper stays agnostic to that type's many generics.
+
+## Properties
+
+### createMachine
+
+```ts
+createMachine: (...args) => unknown;
+```
+
+Defined in: [packages/play-xstate/src/routing/create-routed-machine.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/create-routed-machine.ts#L14)
+
+#### Parameters
+
+| Parameter | Type      |
+| --------- | --------- |
+| ...`args` | `never`[] |
+
+#### Returns
+
+`unknown`

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

@@ -0,0 +1,31 @@
+[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / WithOptional
+
+# Type Alias: WithOptional\<TBase, TExtra\>
+
+```ts
+type WithOptional<TBase, TExtra> = TBase | (TBase & TExtra);
+```
+
+Defined in: [packages/play-xstate/src/routing/schemas.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/schemas.ts#L55)
+
+Adds `TExtra` as an optional-by-union extension of `TBase`.
+
+XState v6's `InferEvents` wraps every event payload in `Required<>` (to
+undo Zod-style optional inference), which would make `?`-marked fields
+mandatory on every send. Encoding optionality as a union sidesteps that:
+`Required<>` distributes over the members, each of which is already fully
+required. Use it for your own event payload schemas with optional fields.
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `TBase`        |
+| `TExtra`       |
+
+## Example
+
+```typescript
+type SavePayload = WithOptional<{ id: string }, { draft: boolean }>;
+// accepts { id } and { id, draft } — and survives InferEvents' Required<>
+```