@xmachines/docs 1.0.0-beta.10

package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md

@@ -0,0 +1,343 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / SolidRouterBridge
+
+# Class: SolidRouterBridge
+
+Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L45)
+
+TanStack Solid Router integration bridge extending RouterBridgeBase
+
+Uses router.subscribe("onBeforeLoad", fn) for router→actor sync.
+This mirrors the TanStack React Router bridge pattern and uses the
+public router events API instead of the internal \_\_store.
+
+## Extends
+
+- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new SolidRouterBridge(
+   router,
+   actor,
+   routeMap): SolidRouterBridge;
+```
+
+Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L55)
+
+Create a TanStack Solid Router bridge
+
+#### Parameters
+
+| Parameter  | Type                                                                                                                                    | Description                                  |
+| ---------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
+| `router`   | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md)                                                                           | TanStack Router instance (from createRouter) |
+| `actor`    | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`AnyActorLogic`\> & [`Routable`](../../play-actor/interfaces/Routable.md) | XMachines actor instance                     |
+| `routeMap` | [`RouteMap`](RouteMap.md)                                                                                                               | Bidirectional state ID ↔ path mapping        |
+
+#### Returns
+
+`SolidRouterBridge`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`constructor`](../../play-router/classes/RouterBridgeBase.md#constructor)
+
+## Properties
+
+| Property                                                              | Modifier    | Type                                                                                                                                    | Description                                           | Inherited from                                                                                                                                                                | Defined in                                  |
+| --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
+| <a id="property-actor"></a> `actor`                                   | `readonly`  | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`AnyActorLogic`\> & [`Routable`](../../play-actor/interfaces/Routable.md) | Actor with currentRoute signal and send method        | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor)                                   | play-router/dist/router-bridge-base.d.ts:55 |
+| <a id="property-hasconnectedonce"></a> `hasConnectedOnce`             | `protected` | `boolean`                                                                                                                               | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce)             | play-router/dist/router-bridge-base.d.ts:61 |
+| <a id="property-isconnected"></a> `isConnected`                       | `protected` | `boolean`                                                                                                                               | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected)                       | play-router/dist/router-bridge-base.d.ts:60 |
+| <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean`                                                                                                                               | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | play-router/dist/router-bridge-base.d.ts:63 |
+| <a id="property-lastsyncedpath"></a> `lastSyncedPath`                 | `protected` | `string`                                                                                                                                | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath)                 | play-router/dist/router-bridge-base.d.ts:62 |
+| <a id="property-routemap"></a> `routeMap`                             | `readonly`  | `object`                                                                                                                                | Bidirectional route map for stateId ↔ path resolution | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap)                             | play-router/dist/router-bridge-base.d.ts:56 |
+| `routeMap.getPathByStateId`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                       | -                                                     | -                                                                                                                                                                             | play-router/dist/router-bridge-base.d.ts:58 |
+| `routeMap.getStateIdByPath`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                       | -                                                     | -                                                                                                                                                                             | play-router/dist/router-bridge-base.d.ts:57 |
+| <a id="property-routewatcher"></a> `routeWatcher`                     | `protected` | \| [`Watcher`](../../play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md) \| `null`                                     | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher)                     | play-router/dist/router-bridge-base.d.ts:64 |
+
+## Methods
+
+### connect()
+
+```ts
+connect(): void;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:81
+
+Connect the router bridge to the Actor.
+
+Sets up the TC39 Signal watcher for actor → router direction and
+starts watching router changes (framework-specific).
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`connect`](../../play-router/classes/RouterBridgeBase.md#connect)
+
+---
+
+### disconnect()
+
+```ts
+disconnect(): void;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:87
+
+Disconnect the router bridge from the Actor.
+
+Stops signal watching and unregisters framework-specific router listener.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`disconnect`](../../play-router/classes/RouterBridgeBase.md#disconnect)
+
+---
+
+### dispose()
+
+```ts
+dispose(): void;
+```
+
+Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L120)
+
+Dispose the bridge (alias for disconnect).
+
+#### Returns
+
+`void`
+
+---
+
+### extractParams()
+
+```ts
+protected extractParams(pathname, stateId): Record<string, string>;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:134
+
+Extract path parameters from URL using the URLPattern API.
+
+Accesses `globalThis.URLPattern` at runtime — no polyfill is imported by this
+library. If `URLPattern` is unavailable (Node.js < 24, older browsers without a
+polyfill), this method returns `{}` silently (graceful degradation — routing still
+works, params will be empty).
+
+#### Parameters
+
+| Parameter  | Type     | Description                                       |
+| ---------- | -------- | ------------------------------------------------- |
+| `pathname` | `string` | The actual URL path (e.g., '/profile/john')       |
+| `stateId`  | `string` | The matched state ID for looking up route pattern |
+
+#### Returns
+
+`Record`\<`string`, `string`\>
+
+Extracted path parameters, or empty object if URLPattern is unavailable or no match
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`extractParams`](../../play-router/classes/RouterBridgeBase.md#extractparams)
+
+---
+
+### extractQuery()
+
+```ts
+protected extractQuery(search): Record<string, string>;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:141
+
+Extract query parameters from URL search string.
+
+#### Parameters
+
+| Parameter | Type     | Description                                      |
+| --------- | -------- | ------------------------------------------------ |
+| `search`  | `string` | URL search string (e.g., '?tab=security&page=1') |
+
+#### Returns
+
+`Record`\<`string`, `string`\>
+
+Extracted query parameters or empty object
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`extractQuery`](../../play-router/classes/RouterBridgeBase.md#extractquery)
+
+---
+
+### getInitialRouterPath()
+
+```ts
+protected getInitialRouterPath(): string | null;
+```
+
+Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L80)
+
+Get the router's current path at connect() time for initial sync.
+
+TanStack Router exposes router.state.location.pathname synchronously,
+so we can read it here to drive the actor to the correct initial state
+when the user cold-loads on a deep-link URL.
+
+#### Returns
+
+`string` \| `null`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`getInitialRouterPath`](../../play-router/classes/RouterBridgeBase.md#getinitialrouterpath)
+
+---
+
+### navigateRouter()
+
+```ts
+protected navigateRouter(path): void;
+```
+
+Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L69)
+
+Navigate TanStack Solid Router to the given path.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `path`    | `string` |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`navigateRouter`](../../play-router/classes/RouterBridgeBase.md#navigaterouter)
+
+---
+
+### syncActorFromRouter()
+
+```ts
+protected syncActorFromRouter(pathname, search?): void;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:101
+
+Sync actor state when router location changes.
+
+Sends play.route event to actor with resolved stateId, params, and query.
+Prevents circular updates via isProcessingNavigation flag.
+
+#### Parameters
+
+| Parameter  | Type     |
+| ---------- | -------- |
+| `pathname` | `string` |
+| `search?`  | `string` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`syncActorFromRouter`](../../play-router/classes/RouterBridgeBase.md#syncactorfromrouter)
+
+---
+
+### syncRouterFromActor()
+
+```ts
+protected syncRouterFromActor(route): void;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:94
+
+Sync router location when actor route signal changes.
+
+Calls navigateRouter() for framework-specific navigation.
+Prevents circular updates via isProcessingNavigation flag.
+
+#### Parameters
+
+| Parameter | Type      |
+| --------- | --------- |
+| `route`   | `unknown` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`syncRouterFromActor`](../../play-router/classes/RouterBridgeBase.md#syncrouterfromactor)
+
+---
+
+### unwatchRouterChanges()
+
+```ts
+protected unwatchRouterChanges(): void;
+```
+
+Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L112)
+
+Stop watching TanStack Router changes.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`unwatchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#unwatchrouterchanges)
+
+---
+
+### watchRouterChanges()
+
+```ts
+protected watchRouterChanges(): void;
+```
+
+Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L98)
+
+Subscribe to ALL navigation events via router.history.
+
+router.history.subscribe fires for PUSH, POP, BACK, FORWARD, REPLACE, and GO —
+covering both link clicks and browser back/forward button presses.
+
+The subscriber callback receives { location, action } where location is the
+new history location with pathname and search already updated.
+
+Using router.history rather than router.subscribe("onBeforeLoad") ensures
+back/forward works regardless of whether <RouterProvider> is mounted.
+
+Also registers onCleanup() so Solid automatically disconnects on unmount.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`watchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#watchrouterchanges)

package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md

@@ -0,0 +1,19 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / PlayRouterProvider
+
+# Function: PlayRouterProvider()
+
+```ts
+function PlayRouterProvider(props): any;
+```
+
+Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L17)
+
+## Parameters
+
+| Parameter | Type                                                                  |
+| --------- | --------------------------------------------------------------------- |
+| `props`   | [`PlayRouterProviderProps`](../interfaces/PlayRouterProviderProps.md) |
+
+## Returns
+
+`any`

package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md

@@ -0,0 +1,32 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / createRouteMap
+
+# Function: createRouteMap()
+
+```ts
+function createRouteMap(machine): RouteMap;
+```
+
+Defined in: [play-tanstack-solid-router/src/create-route-map.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/create-route-map.ts#L27)
+
+Create a RouteMap from an XState machine
+
+## Parameters
+
+| Parameter | Type              | Description                                    |
+| --------- | ----------------- | ---------------------------------------------- |
+| `machine` | `AnyStateMachine` | XState machine with route: {} config on states |
+
+## Returns
+
+[`RouteMap`](../classes/RouteMap.md)
+
+RouteMap for bidirectional state ID ↔ path resolution
+
+## Example
+
+```typescript
+import { createRouteMap } from "@xmachines/play-tanstack-solid-router";
+import { authMachine } from "./machine.js";
+
+const routeMap = createRouteMap(authMachine);
+```

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

@@ -0,0 +1,119 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / PlayRouteEvent
+
+# Interface: PlayRouteEvent
+
+Defined in: play-router/dist/types.d.ts:182
+
+Enhanced routing event with parameter and query support
+
+Unified routing event used throughout the Play architecture. Supports parameter-aware
+navigation patterns (e.g., `/profile/:userId`) for dynamic route segments.
+
+**Architectural Context:** Implements **Passive Infrastructure (INV-04)** by representing
+user navigation intent that the Actor evaluates through guards. Infrastructure proposes
+via `play.route` events, Actor decides via state machine transitions.
+
+**Browser Navigation Flow:**
+
+1. Browser fires `popstate`
+2. Router adapter resolves URL to route target
+3. Adapter sends `PlayRouteEvent` to Actor
+4. Actor validates transition via state machine guards
+
+## Param
+
+Event discriminator (always "play.route")
+
+## Param
+
+Target state ID with # prefix (e.g., '#home', '#profile')
+
+## Param
+
+Merged path + query parameters (path parameters win conflicts)
+
+## Param
+
+Query parameters only (isolated from path params)
+
+## Param
+
+Full URLPattern match result for debugging/observability (optional)
+
+## Examples
+
+Combining base and routing events
+
+```typescript
+import type { PlayEvent } from "@xmachines/play";
+import type { PlayRouteEvent } from "@xmachines/play-router";
+
+type AppEvent = PlayEvent | PlayRouteEvent;
+```
+
+Basic navigation to a route
+
+```typescript
+import type { PlayRouteEvent } from "@xmachines/play-router";
+
+const event: PlayRouteEvent = {
+	type: "play.route",
+	to: "#home",
+};
+actor.send(event);
+```
+
+Navigation with route parameters
+
+```typescript
+import type { PlayRouteEvent } from "@xmachines/play-router";
+
+const event: PlayRouteEvent = {
+	type: "play.route",
+	to: "#profile",
+	params: { userId: "123" },
+};
+actor.send(event);
+// Resolves to route: /profile/123
+```
+
+Navigation with query parameters
+
+```typescript
+import type { PlayRouteEvent } from "@xmachines/play-router";
+
+const event: PlayRouteEvent = {
+	type: "play.route",
+	to: "#settings",
+	params: { section: "profile" }, // Merged: path + query
+	query: { tab: "security" }, // Query-only
+};
+actor.send(event);
+// Resolves to route: /settings/profile?tab=security
+```
+
+## See
+
+[RFC Play v1](https://gitlab.com/xmachin-es/rfc/-/blob/main/src/play-v1.md)
+
+## Remarks
+
+Use `play.route` when you need parameter-aware navigation with the `route: {}`
+config pattern on your state machine nodes. The `match` field exposes the full
+URLPatternResult for advanced use cases (debugging, pattern analysis).
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+## Properties
+
+| Property                               | Modifier   | Type                           | Defined in                      |
+| -------------------------------------- | ---------- | ------------------------------ | ------------------------------- |
+| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                      | play-router/dist/types.d.ts:187 |
+| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | play-router/dist/types.d.ts:185 |
+| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\> | play-router/dist/types.d.ts:186 |
+| <a id="property-to"></a> `to`          | `readonly` | `string`                       | play-router/dist/types.d.ts:184 |
+| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                 | play-router/dist/types.d.ts:183 |

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

@@ -0,0 +1,14 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / PlayRouterProviderProps
+
+# Interface: PlayRouterProviderProps
+
+Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L10)
+
+## Properties
+
+| Property                                  | Type                                                          | Defined in                                                                                                                                                                                                                    |
+| ----------------------------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`       | [`RoutableActor`](../type-aliases/RoutableActor.md)           | [play-tanstack-solid-router/src/play-router-provider.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L11) |
+| <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any`                                  | [play-tanstack-solid-router/src/play-router-provider.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L14) |
+| <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md)                          | [play-tanstack-solid-router/src/play-router-provider.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L13) |
+| <a id="property-router"></a> `router`     | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | [play-tanstack-solid-router/src/play-router-provider.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L12) |

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

@@ -0,0 +1,23 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / RouteMapping
+
+# Interface: RouteMapping
+
+Defined in: [play-tanstack-solid-router/src/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/types.ts#L19)
+
+A single state ID ↔ path mapping entry for the TanStack Solid Router adapter.
+
+Structurally compatible with `BaseRouteMapping` from `@xmachines/play-router`.
+Fields are `readonly` — entries are immutable once passed to `RouteMap`.
+
+## Example
+
+```typescript
+const mapping: RouteMapping = { stateId: "#profile", path: "/profile/:userId" };
+```
+
+## Properties
+
+| Property                                | Modifier   | Type     | Description                                                                               | Defined in                                                                                                                                                                                    |
+| --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-path"></a> `path`       | `readonly` | `string` | TanStack Router path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-tanstack-solid-router/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/types.ts#L23) |
+| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | XMachines state ID (e.g., `"#home"`, `"#profile"`)                                        | [play-tanstack-solid-router/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/types.ts#L21) |

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

@@ -0,0 +1,104 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / RouterBridge
+
+# Interface: RouterBridge
+
+Defined in: play-router/dist/types.d.ts:229
+
+RouterBridge interface for runtime infrastructure adapters
+
+Defines the lifecycle connection between Infrastructure (e.g., TanStack Router) and
+the Actor. Infrastructure "bridges" to the Actor by observing its signals and
+managing its own lifecycle accordingly.
+
+**Architectural Context:** Implements **Passive Infrastructure (INV-04)** by establishing
+a unidirectional observation pattern. Infrastructure connects to observe Actor signals
+(currentRoute, currentView, state) and reflects changes without making state decisions.
+
+## Example
+
+TanStack Router bridge implementation
+
+```typescript
+import type { RouterBridge } from "@xmachines/play-router";
+import { Signal } from "@xmachines/play-signals";
+
+class TanStackRouterBridge implements RouterBridge {
+	private watcher: Signal.Watcher | null = null;
+
+	async connect(): Promise<void> {
+		// Start observing actor.currentRoute signal
+		this.watcher = new Signal.subtle.Watcher(() => {
+			const route = actor.currentRoute.get();
+			if (route) router.navigate(route);
+		});
+		this.watcher.watch(actor.currentRoute);
+	}
+
+	async disconnect(): Promise<void> {
+		// Stop observing, cleanup watchers
+		this.watcher?.unwatch(actor.currentRoute);
+		this.watcher = null;
+	}
+}
+```
+
+## See
+
+[RFC Play v1 - Invariant INV-04](https://gitlab.com/xmachin-es/rfc/-/blob/main/src/play-v1.md)
+
+## Methods
+
+### connect()
+
+```ts
+connect(): void | Promise<void>;
+```
+
+Defined in: play-router/dist/types.d.ts:245
+
+Connect the router bridge to the Actor
+
+Called when Infrastructure should begin observing Actor signals and
+synchronizing its state (e.g., browser URL) with Actor state.
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+Promise that resolves when connection is established, or void for synchronous connection
+
+#### Example
+
+```typescript
+const bridge: RouterBridge = createBridge(actor, router);
+await bridge.connect();
+// Bridge now observing actor.currentRoute signal
+```
+
+---
+
+### disconnect()
+
+```ts
+disconnect(): void | Promise<void>;
+```
+
+Defined in: play-router/dist/types.d.ts:260
+
+Disconnect the router bridge from the Actor
+
+Called when Infrastructure should stop observing and clean up resources
+(e.g., signal watchers, event listeners).
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+Promise that resolves when disconnection is complete, or void for synchronous disconnection
+
+#### Example
+
+```typescript
+await bridge.disconnect();
+// Bridge stopped observing, resources cleaned up
+```

package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / RoutableActor
+
+# Type Alias: RoutableActor
+
+```ts
+type RoutableActor = AbstractActor<AnyActorLogic> & Routable & Viewable;
+```
+
+Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L7)