@xmachines/docs 6.0.0 → 7.0.0

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

@@ -2,7 +2,7 @@
 
 # Interface: RouterBridge
 
-Defined in: [play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/types.ts#L436)
+Defined in: [play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L436)
 
 The RouterBridge interface of a runtime infrastructure adapter
 
@@ -54,7 +54,7 @@ class MyRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/types.ts#L453)
+Defined in: [play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L453)
 
 Connects the router bridge to the Actor
 
@@ -84,7 +84,7 @@ await bridge.connect();
 disconnect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/types.ts#L469)
+Defined in: [play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L469)
 
 Disconnects the router bridge from the Actor
 

package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md

@@ -11,7 +11,7 @@ type PlayRouterBridgeConstructor<TRouter, TActor> = (
 ) => RouterBridge;
 ```
 
-Defined in: [play-router/src/provider-lifecycle.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/provider-lifecycle.ts#L118)
+Defined in: [play-router/src/provider-lifecycle.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/provider-lifecycle.ts#L118)
 
 The constructor shape that a bridge class must satisfy for a provider factory: `(router, actor, routeMap, options?) → RouterBridge`.
 

package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md

@@ -10,7 +10,7 @@ type PlayRouterProviderBaseProps<TRouter, TActor> = PlayRouterProviderBaseProps<
 >;
 ```
 
-Defined in: [play-tanstack-react-router/src/create-play-router-provider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L35)
+Defined in: [play-tanstack-react-router/src/create-play-router-provider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L35)
 
 The props of a React `PlayRouterProvider`.
 

package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md

@@ -6,4 +6,4 @@
 type TanStackRouterInstance = ConstructorParameters<typeof TanStackReactRouterBridge>[0];
 ```
 
-Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-react-router/src/play-router-provider.tsx#L36)
+Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-react-router/src/play-router-provider.tsx#L36)

package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md

@@ -6,7 +6,7 @@
 type TanStackRouterLike = object;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L40)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L40)
 
 The type-only interface of the TanStack Router surface that
 `TanStackRouterBridgeBase` uses. An instance of `@tanstack/react-router` and an
@@ -20,7 +20,7 @@ instance of `@tanstack/solid-router` both satisfy it.
 history: object;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L73)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L73)
 
 #### location
 
@@ -69,7 +69,7 @@ subscribe(handler): () => void;
 optional options?: object;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L59)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L59)
 
 The options of the router. The bridge reads `parseSearch` only.
 
@@ -103,7 +103,7 @@ optional parseSearch(search): Record<string, unknown>;
 optional load(): void | Promise<void>;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L72)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L72)
 
 Runs the TanStack route matching and the loaders again for the current location.
 This method is optional. The bridge calls it after every navigation. The matching
@@ -128,7 +128,7 @@ bridge then synchronizes synchronously.
 navigate(args): void;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L49)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L49)
 
 Navigates to a location. `search` carries the query of the target.
 

package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md

@@ -6,7 +6,7 @@
 const PlayRouterProvider: <TActor>(__namedParameters) => Element;
 ```
 
-Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-react-router/src/play-router-provider.tsx#L60)
+Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-react-router/src/play-router-provider.tsx#L60)
 
 Connects a `PlayerActor` to TanStack React Router. It keeps the actor state and the
 browser URL in step, in both directions.

package/api/@xmachines/play-tanstack-router/README.md

@@ -4,7 +4,7 @@
 
 Shared, framework-agnostic TanStack Router bridge base for XMachines Play.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-6.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-tanstack-router)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-7.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-tanstack-router)
 
 TanStack Router gives React and Solid the same `navigate`, `load`, and `history`
 surface. Therefore the complete bridge implementation lives here, in
@@ -37,7 +37,7 @@ import { createMachine } from "xstate";
 import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
 import { formatPlayRouteTransitions, withRouting } from "@xmachines/play-xstate/routing";
 import { createRouteMap } from "@xmachines/play-router/xstate";
-import { TanStackRouterBridgeBase } from "@xmachines/play-tanstack-router";
+import { TanStackRouterBridgeBase, type TanStackRouterLike } from "@xmachines/play-tanstack-router";
 
 const machine = createMachine(
 	formatPlayRouteTransitions({
@@ -58,7 +58,9 @@ const routeMap = createRouteMap(machine);
 
 export class MyTanStackBridge extends TanStackRouterBridgeBase {}
 
-// router: your TanStack Router instance (from the React or Solid createRouter)
+// Your TanStack Router instance (from the React or Solid createRouter)
+declare const router: TanStackRouterLike;
+
 const bridge = new MyTanStackBridge(router, actor, routeMap);
 bridge.connect();
 // Disconnect the bridge at teardown

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

@@ -2,7 +2,7 @@
 
 # Class: TanStackRouterBridgeBase
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L134)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L134)
 
 The shared TanStack Router adapter. It implements the RouterBridge protocol through RouterBridgeBase
 
@@ -56,7 +56,7 @@ new TanStackRouterBridgeBase(
 ): TanStackRouterBridgeBase;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L152)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L152)
 
 Creates a TanStack Router bridge
 
@@ -87,7 +87,7 @@ Creates a TanStack Router bridge
 get basePath(): string;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L282)
+Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L282)
 
 The resolved URL prefix that the machine of this bridge is mounted under, or `""`
 when the machine owns the complete router.
@@ -112,7 +112,7 @@ The resolved URL prefix of the mount, or `""` when the machine owns the complete
 get basePathParams(): Readonly<Record<string, string>>;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L311)
+Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L311)
 
 The resolved values of the `:param` segments of the mount, or `{}` for a prefix
 without a param.
@@ -163,7 +163,7 @@ mount while the machine stays on the same route, and no event goes out.
 connect(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L533)
+Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L533)
 
 Connects the router bridge to the Actor.
 
@@ -197,7 +197,7 @@ An adapter that needs a different behavior of the first synchronization override
 disconnect(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:791](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L791)
+Defined in: [play-router/src/router-bridge-base.ts:795](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L795)
 
 Disconnects the router bridge from the Actor.
 
@@ -220,7 +220,7 @@ framework.
 setBasePath(basePath?, basePathParams?): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L351)
+Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L351)
 
 Moves the machine to a different mount point, while it stays connected.
 

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

@@ -6,7 +6,7 @@
 type TanStackRouteMapLike = object;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L96)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L96)
 
 The narrow route-map surface that `TanStackRouterBridgeBase` requires.
 `RouteMap` from `@xmachines/play-router` satisfies it. The bridge converts a
@@ -24,7 +24,7 @@ that holds one form only still resolves the path.
 getPathByStateId(id): string | null | undefined;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L98)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L98)
 
 #### Parameters
 
@@ -44,7 +44,7 @@ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:98](https:/
 getStateIdByPath(path): string | null | undefined;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L97)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L97)
 
 #### Parameters
 

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

@@ -6,7 +6,7 @@
 type TanStackRouterLike = object;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L40)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L40)
 
 The type-only interface of the TanStack Router surface that
 `TanStackRouterBridgeBase` uses. An instance of `@tanstack/react-router` and an
@@ -20,7 +20,7 @@ instance of `@tanstack/solid-router` both satisfy it.
 history: object;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L73)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L73)
 
 #### location
 
@@ -69,7 +69,7 @@ subscribe(handler): () => void;
 optional options?: object;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L59)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L59)
 
 The options of the router. The bridge reads `parseSearch` only.
 
@@ -103,7 +103,7 @@ optional parseSearch(search): Record<string, unknown>;
 optional load(): void | Promise<void>;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L72)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L72)
 
 Runs the TanStack route matching and the loaders again for the current location.
 This method is optional. The bridge calls it after every navigation. The matching
@@ -128,7 +128,7 @@ bridge then synchronizes synchronously.
 navigate(args): void;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L49)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L49)
 
 Navigates to a location. `search` carries the query of the target.
 

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

@@ -4,7 +4,7 @@
 
 **TanStack Solid Router adapter for XMachines Universal Player Architecture**
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-6.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-tanstack-solid-router)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-7.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-tanstack-solid-router)
 
 This package integrates TanStack Solid Router with the atoms. The logic then drives the navigation through the Solid.js reactivity.
 
@@ -40,10 +40,11 @@ pnpm add @xmachines/play-tanstack-solid-router @xmachines/play-router @xmachines
 - `PlayRouterProviderProps`, `TanStackRouterInstance` (types)
 - `RoutableActor` — `currentRoute`, `initialRoute` and `send`, from [`@xmachines/play-router`](../play-router/README.md). It names no view: routing implies no rendering. A renderer callback that reads `currentView` declares its own actor type, and the constraint keeps it whole
 - `RouteMap`, `RouteMapping`, `RouteMapOptions` (re-exported from [`@xmachines/play-router`](../play-router/README.md))
-- `createRouteMap` (re-exported from [`@xmachines/play-router/xstate`](../play-router/README.md))
 - `TanStackRouterLike` (type)
 - `RouterBridge`, `PlayRouteEvent` (types)
 
+This package does not export `createRouteMap`. Import it from [`@xmachines/play-router/xstate`](../play-router/README.md).
+
 ## Quick Start
 
 ```tsx
@@ -94,17 +95,23 @@ bridge.disconnect();
 Use `PlayRouterProvider` when you want a component to manage the bridge lifecycle:
 
 ```tsx
-import { PlayRouterProvider } from "@xmachines/play-tanstack-solid-router";
-import { RouterProvider } from "@tanstack/solid-router";
+import { RouterProvider, type AnyRouter } from "@tanstack/solid-router";
+import {
+	PlayRouterProvider,
+	type RoutableActor,
+	type RouteMap,
+} from "@xmachines/play-tanstack-solid-router";
 
 // actor, router, and routeMap from the Quick Start above
+declare const actor: RoutableActor;
+declare const router: AnyRouter;
+declare const routeMap: RouteMap;
+
 <PlayRouterProvider
 	actor={actor}
 	router={router}
 	routeMap={routeMap}
-	renderer={(currentActor, currentRouter) => (
-		<RouterProvider router={currentRouter}>{/* your app here */}</RouterProvider>
-	)}
+	renderer={() => <RouterProvider router={router}>{/* your app here */}</RouterProvider>}
 />;
 ```
 
@@ -115,7 +122,13 @@ import { RouterProvider } from "@tanstack/solid-router";
 The primary adapter class. It extends `RouterBridgeBase`.
 
 ```ts
-class TanStackSolidRouterBridge {
+import type {
+	RoutableActor,
+	RouteMap,
+	TanStackRouterLike,
+} from "@xmachines/play-tanstack-solid-router";
+
+declare class TanStackSolidRouterBridge {
 	constructor(router: TanStackRouterLike, actor: RoutableActor, routeMap: RouteMap);
 	connect(): void;
 	disconnect(): void;
@@ -135,6 +148,13 @@ class TanStackSolidRouterBridge {
 This Solid component creates a `TanStackSolidRouterBridge`, connects it, and cleans it up for you.
 
 ```ts
+import type { JSX } from "solid-js";
+import type {
+	RoutableActor,
+	RouteMap,
+	TanStackRouterInstance,
+} from "@xmachines/play-tanstack-solid-router";
+
 interface PlayRouterProviderProps<TActor extends RoutableActor = RoutableActor> {
 	/** The actor to sync with TanStack Solid Router. */
 	actor: TActor;
@@ -142,6 +162,10 @@ interface PlayRouterProviderProps<TActor extends RoutableActor = RoutableActor>
 	router: TanStackRouterInstance;
 	/** Bidirectional route map for state ID ↔ URL path lookups. */
 	routeMap: RouteMap;
+	/** Optional URL prefix that the host owns. The routes of the machine mount under it. */
+	basePath?: string;
+	/** The values of the `:param` segments of `basePath`. */
+	basePathParams?: Record<string, string | number>;
 	/** Renderer callback receives the same concrete actor type that was passed in. */
 	renderer: (actor: TActor, router: TanStackRouterInstance) => JSX.Element;
 }
@@ -154,6 +178,8 @@ The component creates the bridge synchronously, during its own evaluation, becau
 They map each state ID to a URL path, and each URL back to a state ID. This package exports `RouteMap`, and it re-exports `createRouteMap` never: the barrel names no state machine.
 
 ```ts
+import { RouteMap } from "@xmachines/play-tanstack-solid-router";
+
 const routeMap = new RouteMap([
 	{ stateId: "home", path: "/" },
 	{ stateId: "profile", path: "/profile/:userId" },
@@ -169,7 +195,11 @@ Or build from a machine directly:
 
 ```ts
 import { createRouteMap } from "@xmachines/play-router/xstate";
-const routeMap = createRouteMap(machine); // machine: your routable machine (states carry meta.route)
+import type { AnyStateMachine } from "xstate";
+
+declare const machine: AnyStateMachine; // your routable machine (states carry meta.route)
+
+const routeMap = createRouteMap(machine);
 ```
 
 `getStateIdByPath` returns `null`, not `undefined`, for a path that it cannot match.
@@ -179,6 +209,8 @@ const routeMap = createRouteMap(machine); // machine: your routable machine (sta
 ### Dynamic Routes with Parameters
 
 ```ts
+import { RouteMap } from "@xmachines/play-tanstack-solid-router";
+
 const routeMap = new RouteMap([
 	{ stateId: "post", path: "/users/:userId/posts/:postId" },
 	{ stateId: "settings", path: "/settings/:section?" },
@@ -192,7 +224,7 @@ const routeMap = new RouteMap([
 
 The auth guards are inside the state machine only. Unauthorized content therefore never appears, not even for a moment:
 
-```ts
+```ts fragment
 const machineConfig = {
 	states: {
 		dashboard: {
@@ -224,7 +256,9 @@ import { createRouteMap } from "@xmachines/play-router/xstate";
 import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
 import { withRouting } from "@xmachines/play-xstate/routing";
 import { extractMachineRoutes, getRoutableRoutes } from "@xmachines/play-router/xstate";
-import { authMachine } from "./auth-machine.js"; // your routable machine (states carry meta.route)
+import type { AnyStateMachine } from "xstate";
+
+declare const authMachine: AnyStateMachine; // your routable machine (states carry meta.route)
 
 const createPlayer = definePlayer({
 	machine: authMachine,

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

@@ -2,7 +2,7 @@
 
 # Class: RouteMap
 
-Defined in: [play-router/src/base-route-map.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/base-route-map.ts#L176)
+Defined in: [play-router/src/base-route-map.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/base-route-map.ts#L176)
 
 The shared base class of the route map for both directions.
 
@@ -64,7 +64,7 @@ map.getPathByStateId("missing"); // null
 new RouteMap(mappings, options?): RouteMap;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/base-route-map.ts#L209)
+Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/base-route-map.ts#L209)
 
 Builds a route map from an array of the mappings between a state ID and a path.
 
@@ -92,7 +92,7 @@ candidates is therefore efficient.
 getPathByStateId(stateId): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/base-route-map.ts#L322)
+Defined in: [play-router/src/base-route-map.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/base-route-map.ts#L322)
 
 Returns the path pattern of a state ID.
 
@@ -128,7 +128,7 @@ map.getPathByStateId("missing"); // null
 getStateIdByPath(path): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/base-route-map.ts#L277)
+Defined in: [play-router/src/base-route-map.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/base-route-map.ts#L277)
 
 Resolves a URL path to its state ID.
 

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

@@ -2,7 +2,7 @@
 
 # Class: TanStackSolidRouterBridge
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L134)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L134)
 
 The shared TanStack Router adapter. It implements the RouterBridge protocol through RouterBridgeBase
 
@@ -56,7 +56,7 @@ new TanStackSolidRouterBridge(
 ): TanStackRouterBridgeBase;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L152)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L152)
 
 Creates a TanStack Router bridge
 
@@ -87,7 +87,7 @@ Creates a TanStack Router bridge
 get basePath(): string;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L282)
+Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L282)
 
 The resolved URL prefix that the machine of this bridge is mounted under, or `""`
 when the machine owns the complete router.
@@ -112,7 +112,7 @@ The resolved URL prefix of the mount, or `""` when the machine owns the complete
 get basePathParams(): Readonly<Record<string, string>>;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L311)
+Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L311)
 
 The resolved values of the `:param` segments of the mount, or `{}` for a prefix
 without a param.
@@ -163,7 +163,7 @@ mount while the machine stays on the same route, and no event goes out.
 connect(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L533)
+Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L533)
 
 Connects the router bridge to the Actor.
 
@@ -197,7 +197,7 @@ An adapter that needs a different behavior of the first synchronization override
 disconnect(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:791](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L791)
+Defined in: [play-router/src/router-bridge-base.ts:795](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L795)
 
 Disconnects the router bridge from the Actor.
 
@@ -220,7 +220,7 @@ framework.
 setBasePath(basePath?, basePathParams?): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L351)
+Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L351)
 
 Moves the machine to a different mount point, while it stays connected.
 

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

@@ -6,7 +6,7 @@
 function createPlayRouterProvider<TRouter, TActorBase>(BridgeCtor): <TActor>(props) => any;
 ```
 
-Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L51)
+Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L51)
 
 Builds a `PlayRouterProvider` for one Solid bridge class.
 

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

@@ -2,7 +2,7 @@
 
 # Interface: PlayRouteEvent
 
-Defined in: [play-router/src/types.ts:336](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/types.ts#L336)
+Defined in: [play-router/src/types.ts:336](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L336)
 
 The routing event, with its parameters and its query
 
@@ -122,9 +122,9 @@ analysis of the pattern.
 
 | Property                               | Modifier   | Type                                                             | Description                                                                                                                                                                                                                                                                           | Defined in                                                                                                                      |
 | -------------------------------------- | ---------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-data"></a> `data?`     | `readonly` | [`RouteData`](../../play-router/index/type-aliases/RouteData.md) | The extra data that the SENDER of this event supplies: a router bridge, or the code of an application. It is not what the target state declares — that is [RouteObject.data](../../play-router/index/interfaces/RouteObject.md#property-data), and a resolver there reads this field. | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/types.ts#L346) |
-| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                                                        | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:347](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/types.ts#L347) |
-| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\>                                   | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:339](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/types.ts#L339) |
-| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\>                                   | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/types.ts#L340) |
-| <a id="property-to"></a> `to`          | `readonly` | `string`                                                         | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/types.ts#L338) |
-| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                                                   | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:337](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/types.ts#L337) |
+| <a id="property-data"></a> `data?`     | `readonly` | [`RouteData`](../../play-router/index/type-aliases/RouteData.md) | The extra data that the SENDER of this event supplies: a router bridge, or the code of an application. It is not what the target state declares — that is [RouteObject.data](../../play-router/index/interfaces/RouteObject.md#property-data), and a resolver there reads this field. | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L346) |
+| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                                                        | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:347](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L347) |
+| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\>                                   | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:339](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L339) |
+| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\>                                   | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L340) |
+| <a id="property-to"></a> `to`          | `readonly` | `string`                                                         | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L338) |
+| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                                                   | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:337](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/types.ts#L337) |