@xmachines/docs 1.0.0-beta.9 → 1.1.0

package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md

@@ -1,90 +1,49 @@
-[Documentation](../../../README.md) / [@xmachines/play-solid-router](../README.md) / AbstractActor
+[API](../../../README.md) / [@xmachines/play-solid-router](../README.md) / AbstractActor
 
-# Abstract Interface: AbstractActor\<TLogic\>
+# Abstract Interface: AbstractActor\<TLogic, TEvent\>
 
-Defined in: packages/play-actor/dist/abstract-actor.d.ts:173
+Defined in: [packages/play-actor/src/abstract-actor.ts:193](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L193)
 
 Abstract base class for Play Architecture actors.
 
-Extends XState Actor to maintain ecosystem compatibility (inspection, devtools)
-while enforcing minimal signal protocol for Actor ↔ Infrastructure communication.
+Provides signal-driven state observation that integrates with XState ecosystem
+tooling (devtools, inspection) while exposing reactive signals for
+Infrastructure layer communication.
 
-The core protocol contains only:
-
-- state: Reactive state snapshot
-- send: Event dispatch method
-
-Optional capabilities (routing, view rendering) are provided via interfaces:
-
-- Implement Routable for routing support
-- Implement Viewable for view rendering support
-
-Concrete implementations created by @xmachines/play-xstate adapter.
-
-## Examples
-
-Simple actor (no routing, no view)
-
-```typescript
-class SimpleActor extends AbstractActor<AnyActorLogic> {
-  state = new Signal.State({...});
-  send(event) { ... }
-}
-```
-
-Routable actor
-
-```typescript
-class RoutableActor extends AbstractActor<AnyActorLogic> implements Routable {
-  state = new Signal.State({...});
-  currentRoute = new Signal.Computed(() => deriveRoute(this.state.get()));
-  send(event) { ... }
-}
-```
-
-Full-featured actor (routing + view)
-
-```typescript
-class PlayerActor extends AbstractActor<AnyActorLogic> implements Routable, Viewable {
-  state = new Signal.State({...});
-  currentRoute = new Signal.Computed(() => deriveRoute(this.state.get()));
-  currentView = new Signal.State(null);
-  catalog = {};
-  send(event) { ... }
-}
-```
-
-## See
-
-- [RFC Play v1 Section 5.3](https://gitlab.com/xmachin-es/rfc/-/blob/main/src/play-v1.md#53-actor-protocol)
-- [Routable](../../play-actor/interfaces/Routable.md) for routing capability
-- [Viewable](../../play-actor/interfaces/Viewable.md) for view rendering capability
+**A subclass IS the actor.** Forward the logic _and_ its options to
+`super(logic, options)`, then observe `this`. Holding a separately
+constructed actor alongside leaves this instance running as an empty second
+actor, and every inherited member — `system`, `sessionId`, `clock`, the
+internal `_send` that receives `sendTo()` traffic, and anything a future
+XState version adds — answers from that empty one until it is individually
+forwarded.
 
 ## Extends
 
-- `Actor`\<`TLogic`\>
+- [`Actor`](https://www.jsdocs.io/package/xstate#Actor)\<`TLogic`\>
 
 ## Type Parameters
 
-| Type Parameter                     | Description                                                                                                                                                                                                                                                                                     |
-| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `TLogic` _extends_ `AnyActorLogic` | XState actor logic type (maintains type safety) Invariant: Actor Authority - Actor is the sole source of truth for state transitions. Invariant: Signal-Only Reactivity - Infrastructure observes via TC39 Signals. Invariant: Passive Infrastructure - Infrastructure reflects, never decides. |
+| Type Parameter                                                                           | Default type                                                      | Description                                     |
+| ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------- |
+| `TLogic` _extends_ [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | -                                                                 | XState actor logic type                         |
+| `TEvent` _extends_ [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)     | [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject) | Event type constraint (defaults to EventObject) |
 
 ## Properties
 
-| Property                                    | Modifier   | Type                                                                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Inherited from    | Defined in                                                    |
-| ------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------- |
-| <a id="property-_parent"></a> `_parent?`    | `public`   | `AnyActorRef`                                                                                     | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | `Actor._parent`   | node_modules/xstate/dist/declarations/src/createActor.d.ts:33 |
-| <a id="property-clock"></a> `clock`         | `public`   | `Clock`                                                                                           | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `Actor.clock`     | node_modules/xstate/dist/declarations/src/createActor.d.ts:25 |
-| <a id="property-id"></a> `id`               | `public`   | `string`                                                                                          | The unique identifier for this actor relative to its parent.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | `Actor.id`        | node_modules/xstate/dist/declarations/src/createActor.d.ts:28 |
-| <a id="property-logic"></a> `logic`         | `public`   | `TLogic`                                                                                          | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | `Actor.logic`     | node_modules/xstate/dist/declarations/src/createActor.d.ts:18 |
-| <a id="property-options"></a> `options`     | `public`   | `Readonly`\<`ActorOptions`\<`TLogic`\>\>                                                          | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | `Actor.options`   | node_modules/xstate/dist/declarations/src/createActor.d.ts:26 |
-| <a id="property-ref"></a> `ref`             | `public`   | `ActorRef`\<`SnapshotFrom`\<`TLogic`\>, `EventFromLogic`\<`TLogic`\>, `EmittedFrom`\<`TLogic`\>\> | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | `Actor.ref`       | node_modules/xstate/dist/declarations/src/createActor.d.ts:34 |
-| <a id="property-sessionid"></a> `sessionId` | `public`   | `string`                                                                                          | The globally unique process ID for this invocation.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | `Actor.sessionId` | node_modules/xstate/dist/declarations/src/createActor.d.ts:38 |
-| <a id="property-src"></a> `src`             | `public`   | `string` \| `AnyActorLogic`                                                                       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | `Actor.src`       | node_modules/xstate/dist/declarations/src/createActor.d.ts:42 |
-| <a id="property-state"></a> `state`         | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\>                     | Reactive snapshot of current actor state. Typed as `Signal.State<unknown>` at the abstract level; concrete implementations narrow this to the actual snapshot type (e.g., `Signal.State<AnyMachineSnapshot>` in `@xmachines/play-xstate`'s `PlayerActor`). Infrastructure observes this signal to react to state changes without directly coupling to the Actor's internal state machine implementation. **Example** `// Infrastructure observes state signal const watcher = new Signal.subtle.Watcher(() => { console.log('Actor state changed:', actor.state.get()); }); watcher.watch(actor.state);` | -                 | packages/play-actor/dist/abstract-actor.d.ts:193              |
-| <a id="property-system"></a> `system`       | `public`   | `AnyActorSystem`                                                                                  | The system to which this actor belongs.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | `Actor.system`    | node_modules/xstate/dist/declarations/src/createActor.d.ts:40 |
-| <a id="property-systemid"></a> `systemId`   | `public`   | `string` \| `undefined`                                                                           | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | `Actor.systemId`  | node_modules/xstate/dist/declarations/src/createActor.d.ts:36 |
+| Property                                    | Modifier   | Type                                                                                                                                                                                                                                                                                                               | Description                                                                                                                                                                             | Inherited from    | Defined in                                                                                                                                               |
+| ------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-_parent"></a> `_parent?`    | `public`   | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef)                                                                                                                                                                                                                                                  | -                                                                                                                                                                                       | `Actor._parent`   | -                                                                                                                                                        |
+| <a id="property-clock"></a> `clock`         | `public`   | [`Clock`](https://www.jsdocs.io/package/xstate#Clock)                                                                                                                                                                                                                                                              | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions.                                                                                | `Actor.clock`     | -                                                                                                                                                        |
+| <a id="property-id"></a> `id`               | `public`   | `string`                                                                                                                                                                                                                                                                                                           | The unique identifier for this actor relative to its parent.                                                                                                                            | `Actor.id`        | -                                                                                                                                                        |
+| <a id="property-logic"></a> `logic`         | `public`   | `TLogic`                                                                                                                                                                                                                                                                                                           | -                                                                                                                                                                                       | `Actor.logic`     | -                                                                                                                                                        |
+| <a id="property-options"></a> `options`     | `public`   | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\>                                                                                                                                                                                                                      | -                                                                                                                                                                                       | `Actor.options`   | -                                                                                                                                                        |
+| <a id="property-ref"></a> `ref`             | `public`   | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TLogic`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TLogic`\>\> | -                                                                                                                                                                                       | `Actor.ref`       | -                                                                                                                                                        |
+| <a id="property-sessionid"></a> `sessionId` | `public`   | `string`                                                                                                                                                                                                                                                                                                           | The globally unique process ID for this invocation.                                                                                                                                     | `Actor.sessionId` | -                                                                                                                                                        |
+| <a id="property-src"></a> `src`             | `public`   | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)                                                                                                                                                                                                                               | -                                                                                                                                                                                       | `Actor.src`       | -                                                                                                                                                        |
+| <a id="property-state"></a> `state`         | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\>                                                                                                                                                                                                                                      | Reactive snapshot of current actor state. Infrastructure observes this signal to react to state changes without directly coupling to the actor's internal state machine implementation. | -                 | [packages/play-actor/src/abstract-actor.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L203) |
+| <a id="property-system"></a> `system`       | `public`   | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem)                                                                                                                                                                                                                                            | The system to which this actor belongs.                                                                                                                                                 | `Actor.system`    | -                                                                                                                                                        |
+| <a id="property-systemid"></a> `systemId`   | `public`   | `string` \| `undefined`                                                                                                                                                                                                                                                                                            | -                                                                                                                                                                                       | `Actor.systemId`  | -                                                                                                                                                        |
 
 ## Methods
 
@@ -94,11 +53,11 @@ class PlayerActor extends AbstractActor<AnyActorLogic> implements Routable, View
 observable: InteropSubscribable<SnapshotFrom<TLogic>>;
 ```
 
-Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:153
+Defined in: `xstate`
 
 #### Returns
 
-`InteropSubscribable`\<`SnapshotFrom`\<`TLogic`\>\>
+[`InteropSubscribable`](https://www.jsdocs.io/package/xstate#InteropSubscribable)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>\>
 
 #### Inherited from
 
@@ -114,13 +73,13 @@ Actor.[observable]
 getPersistedSnapshot(): Snapshot<unknown>;
 ```
 
-Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:152
+Defined in: `xstate`
 
 Obtain the internal state of the actor, which can be persisted.
 
 #### Returns
 
-`Snapshot`\<`unknown`\>
+[`Snapshot`](https://www.jsdocs.io/package/xstate#Snapshot)\<`unknown`\>
 
 #### Remarks
 
@@ -130,7 +89,7 @@ Note that the persisted state is not the same as the snapshot from
 [Actor.getSnapshot](../../play-actor/classes/AbstractActor.md#getsnapshot). Persisted state represents the internal state of
 the actor, while snapshots represent the actor's last emitted value.
 
-Can be restored with [ActorOptions.state](#)
+Can be restored with [ActorOptions.state](https://www.jsdocs.io/package/xstate#ActorOptions.state)
 
 #### See
 
@@ -150,13 +109,13 @@ Actor.getPersistedSnapshot;
 getSnapshot(): SnapshotFrom<TLogic>;
 ```
 
-Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:168
+Defined in: `xstate`
 
 Read an actor’s snapshot synchronously.
 
 #### Returns
 
-`SnapshotFrom`\<`TLogic`\>
+[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>
 
 #### Remarks
 
@@ -187,7 +146,7 @@ Actor.getSnapshot;
 on<TType>(type, handler): Subscription;
 ```
 
-Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:115
+Defined in: `xstate`
 
 #### Type Parameters
 
@@ -204,7 +163,7 @@ Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:115
 
 #### Returns
 
-`Subscription`
+[`Subscription`](https://www.jsdocs.io/package/xstate#Subscription)
 
 #### Inherited from
 
@@ -214,42 +173,68 @@ Actor.on;
 
 ---
 
-### send()
+### select()
 
 ```ts
-abstract send(event): void;
+select<TSelected>(selector, equalityFn?): Readable<TSelected>;
 ```
 
-Defined in: packages/play-actor/dist/abstract-actor.d.ts:216
+Defined in: `xstate`
 
-Send event to Actor
+#### Type Parameters
 
-Infrastructure forwards user intents (navigation, domain events, custom events)
-as events to the Actor. The Actor's state machine guards determine whether
-each event is valid from the current state.
+| Type Parameter |
+| -------------- |
+| `TSelected`    |
 
 #### Parameters
 
-| Parameter | Type                                       | Description                                                                                                                                  |
-| --------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| `event`   | `object` & `Record`\<`string`, `unknown`\> | Event object with type property (e.g., PlayEvent, PlayRouteEvent) Invariant: Actor Authority - Only Actor decides whether an event is valid. |
+| Parameter     | Type                        |
+| ------------- | --------------------------- |
+| `selector`    | (`snapshot`) => `TSelected` |
+| `equalityFn?` | (`a`, `b`) => `boolean`     |
 
 #### Returns
 
-`void`
+`Readable`\<`TSelected`\>
 
-#### Example
+#### Inherited from
 
-```typescript
-// Infrastructure forwards user intent
-actor.send({ type: "auth.login", userId: "123" });
-// Actor's guards determine if event is allowed
+```ts
+Actor.select;
 ```
 
-#### Remarks
+---
+
+### send()
+
+```ts
+abstract send(event): void;
+```
 
-Accepts any event object with a type property. Core events (PlayEvent) are in
-@xmachines/play, routing events (PlayRouteEvent) are in @xmachines/play-router.
+Defined in: [packages/play-actor/src/abstract-actor.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L218)
+
+Send event to Actor.
+
+Constrained to TEvent for type safety in concrete implementations.
+
+Note for implementations that wrap `send` (validating the event, or
+notifying hooks around it): this declaration is abstract purely to narrow
+the event type, and TypeScript forbids `super` calls to an abstract
+member. Reach XState's own implementation with
+`Actor.prototype.send.call(this, event)` instead. Making this concrete
+would allow `super.send()` but would force every existing subclass to add
+an `override` modifier — a breaking change for adapters outside this repo.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `event`   | `TEvent` |
+
+#### Returns
+
+`void`
 
 #### Overrides
 
@@ -265,7 +250,7 @@ Actor.send;
 start(): this;
 ```
 
-Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:119
+Defined in: `xstate`
 
 Starts the Actor from the initial state
 
@@ -287,7 +272,7 @@ Actor.start;
 stop(): this;
 ```
 
-Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:123
+Defined in: `xstate`
 
 Stops the Actor and unsubscribe all listeners.
 
@@ -311,19 +296,19 @@ Actor.stop;
 subscribe(observer): Subscription;
 ```
 
-Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:113
+Defined in: `xstate`
 
 Subscribe an observer to an actor’s snapshot values.
 
 ##### Parameters
 
-| Parameter  | Type                                     | Description                                                                                                                                  |
-| ---------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| `observer` | `Observer`\<`SnapshotFrom`\<`TLogic`\>\> | Either a plain function that receives the latest snapshot, or an observer object whose `.next(snapshot)` method receives the latest snapshot |
+| Parameter  | Type                                                                                                                                           | Description                                                                                                                                  |
+| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| `observer` | [`Observer`](https://www.jsdocs.io/package/xstate#Observer)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>\> | Either a plain function that receives the latest snapshot, or an observer object whose `.next(snapshot)` method receives the latest snapshot |
 
 ##### Returns
 
-`Subscription`
+[`Subscription`](https://www.jsdocs.io/package/xstate#Subscription)
 
 ##### Remarks
 
@@ -389,7 +374,7 @@ subscribe(
    completeListener?): Subscription;
 ```
 
-Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:114
+Defined in: `xstate`
 
 Subscribe an observer to an actor’s snapshot values.
 
@@ -403,7 +388,7 @@ Subscribe an observer to an actor’s snapshot values.
 
 ##### Returns
 
-`Subscription`
+[`Subscription`](https://www.jsdocs.io/package/xstate#Subscription)
 
 ##### Remarks
 
@@ -468,16 +453,16 @@ Actor.subscribe;
 toJSON(): object;
 ```
 
-Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:135
+Defined in: `xstate`
 
 #### Returns
 
 `object`
 
-| Name           | Type     | Defined in                                                     |
-| -------------- | -------- | -------------------------------------------------------------- |
-| `id`           | `string` | node_modules/xstate/dist/declarations/src/createActor.d.ts:137 |
-| `xstate$$type` | `number` | node_modules/xstate/dist/declarations/src/createActor.d.ts:136 |
+| Name           | Type     | Defined in |
+| -------------- | -------- | ---------- |
+| `id`           | `string` | -          |
+| `xstate$$type` | `number` | -          |
 
 #### Inherited from
 

package/api/@xmachines/play-solid-router/interfaces/PlayActor.md

@@ -0,0 +1,68 @@
+[API](../../../README.md) / [@xmachines/play-solid-router](../README.md) / PlayActor
+
+# Interface: PlayActor
+
+Defined in: [packages/play-router/src/types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L297)
+
+Full actor shape used by `PlayRouterProvider` components across all framework
+adapters (`play-solid-router`, `play-vue-router`, `play-react-router`, and the
+adapters built on the shared framework-router bridge bases).
+
+Extends `RoutableActor` with `currentView` — the provider renders the current
+view spec in addition to synchronizing routes, so it needs both capabilities.
+
+- Use `RoutableActor` when only routing is needed (e.g. `RouterBridgeBase` subclasses,
+  `connectRouter`).
+- Use `PlayActor` when the component also renders the current view spec
+  (e.g. `PlayRouterProvider` renderer callback parameter, `PlayRenderer`).
+
+All `AbstractActor` subclasses that implement both `Routable` and `Viewable`
+satisfy this interface structurally.
+
+## Example
+
+```typescript
+import type { PlayActor } from "@xmachines/play-router";
+
+function MyRouterProvider({ actor }: { actor: PlayActor }) {
+	// access actor.currentRoute (routing) and actor.currentView (rendering)
+}
+```
+
+## Extends
+
+- [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md)
+
+## Properties
+
+| Property                                          | Modifier   | Type                                                                                                                                | Description                                                                                                                                                                                                   | Inherited from                                                                                                                                                 | Defined in                                                                                                                               |
+| ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\>                                        | TC39 Signal exposing the actor's current URL path (or state ID).                                                                                                                                              | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [packages/play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L261) |
+| <a id="property-currentview"></a> `currentView`   | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive.                                                                                                                                  | -                                                                                                                                                              | [packages/play-router/src/types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L299) |
+| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                                                                  | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [packages/play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L267) |
+
+## Methods
+
+### send()
+
+```ts
+send(event): void;
+```
+
+Defined in: [packages/play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L269)
+
+Send a route navigation event to the actor.
+
+#### Parameters
+
+| Parameter | Type                                  |
+| --------- | ------------------------------------- |
+| `event`   | [`PlayRouteEvent`](PlayRouteEvent.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`send`](../../play-dom-router/interfaces/RoutableActor.md#send)

package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-solid-router](../README.md) / PlayRouteEvent
+[API](../../../README.md) / [@xmachines/play-solid-router](../README.md) / PlayRouteEvent
 
 # Interface: PlayRouteEvent
 
-Defined in: packages/play-router/dist/types.d.ts:182
+Defined in: [packages/play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L225)
 
 Enhanced routing event with parameter and query support
 
@@ -22,22 +22,32 @@ via `play.route` events, Actor decides via state machine transitions.
 
 ## Param
 
+**type**
+
 Event discriminator (always "play.route")
 
 ## Param
 
+**to**
+
 Target state ID with # prefix (e.g., '#home', '#profile')
 
 ## Param
 
-Merged path + query parameters (path parameters win conflicts)
+**params**
+
+Path-only route parameters extracted from the URL path (e.g., `{ userId: '123' }` from `/profile/123`). Query parameters are kept separate in `query`.
 
 ## Param
 
+**query**
+
 Query parameters only (isolated from path params)
 
 ## Param
 
+**match**
+
 Full URLPattern match result for debugging/observability (optional)
 
 ## Examples
@@ -85,7 +95,7 @@ import type { PlayRouteEvent } from "@xmachines/play-router";
 const event: PlayRouteEvent = {
 	type: "play.route",
 	to: "#settings",
-	params: { section: "profile" }, // Merged: path + query
+	params: { section: "profile" }, // Path-only route parameter
 	query: { tab: "security" }, // Query-only
 };
 actor.send(event);
@@ -94,7 +104,7 @@ actor.send(event);
 
 ## See
 
-[RFC Play v1](https://gitlab.com/xmachin-es/rfc/-/blob/main/src/play-v1.md)
+[Play RFC](../../../../rfc/play.md)
 
 ## Remarks
 
@@ -110,10 +120,10 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
 
 ## Properties
 
-| Property                               | Modifier   | Type                           | Defined in                               |
-| -------------------------------------- | ---------- | ------------------------------ | ---------------------------------------- |
-| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                      | packages/play-router/dist/types.d.ts:187 |
-| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | packages/play-router/dist/types.d.ts:185 |
-| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\> | packages/play-router/dist/types.d.ts:186 |
-| <a id="property-to"></a> `to`          | `readonly` | `string`                       | packages/play-router/dist/types.d.ts:184 |
-| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                 | packages/play-router/dist/types.d.ts:183 |
+| Property                               | Modifier   | Type                           | Defined in                                                                                                                               |
+| -------------------------------------- | ---------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                      | [packages/play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L230) |
+| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L228) |
+| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L229) |
+| <a id="property-to"></a> `to`          | `readonly` | `string`                       | [packages/play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L227) |
+| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                 | [packages/play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L226) |

package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md

@@ -0,0 +1,30 @@
+[API](../../../README.md) / [@xmachines/play-solid-router](../README.md) / PlayRouterProviderBaseProps
+
+# Interface: PlayRouterProviderBaseProps\<TRouter, TActor\>
+
+Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L37)
+
+Props shared by every factory-created Solid `PlayRouterProvider`.
+
+Adapter packages re-export a concrete alias with `TRouter` bound to their
+router type (e.g. `SolidRouterHooks` in `@xmachines/play-solid-router`).
+
+## Extended by
+
+- [`PlayRouterProviderProps`](PlayRouterProviderProps.md)
+
+## Type Parameters
+
+| Type Parameter                                 | Default type                |
+| ---------------------------------------------- | --------------------------- |
+| `TRouter`                                      | -                           |
+| `TActor` _extends_ [`PlayActor`](PlayActor.md) | [`PlayActor`](PlayActor.md) |
+
+## Properties
+
+| Property                                  | Type                                 | Description                                                                 | Defined in                                                                                                                                                                                       |
+| ----------------------------------------- | ------------------------------------ | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-actor"></a> `actor`       | `TActor`                             | The actor to sync with the router.                                          | [packages/play-solid-router/src/create-play-router-provider.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L39) |
+| <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any`         | Renderer callback receives the same concrete actor type that was passed in. | [packages/play-solid-router/src/create-play-router-provider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L45) |
+| <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups.                    | [packages/play-solid-router/src/create-play-router-provider.tsx:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L43) |
+| <a id="property-router"></a> `router`     | `TRouter`                            | The router the bridge synchronizes with.                                    | [packages/play-solid-router/src/create-play-router-provider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L41) |