npm - @xmachines/docs - Versions diffs - 1.0.0-beta.43 → 1.0.0-beta.45 - Mend

@xmachines/docs 1.0.0-beta.43 → 1.0.0-beta.45

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (432) hide show

package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md CHANGED Viewed

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / WindowLike
+[API](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / WindowLike
 # Interface: WindowLike
-Defined in: [play-router/src/types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L324)
+Defined in: [play-router/src/types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L324)
 Minimal window interface required by adapters that subscribe to DOM events
 (e.g. `hashchange`). Injectable for SSR and testing — pass a mock instead of
@@ -30,7 +30,7 @@ connectRouter({ actor, routeMap, window: mockWin });
 addEventListener(type, listener): void;
 ```
-Defined in: [play-router/src/types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L325)
+Defined in: [play-router/src/types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L325)
 #### Parameters
@@ -51,7 +51,7 @@ Defined in: [play-router/src/types.ts:325](https://gitlab.com/xmachin-es/xmachin
 removeEventListener(type, listener): void;
 ```
-Defined in: [play-router/src/types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L326)
+Defined in: [play-router/src/types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L326)
 #### Parameters

package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / RoutableActor
+[API](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / RoutableActor
 # Type Alias: RoutableActor
@@ -6,4 +6,4 @@
 type RoutableActor = AbstractActor<AnyActorLogic> & Routable;
 ```
-Defined in: [play-svelte-spa-router/src/types.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-svelte-spa-router/src/types.ts#L6)
+Defined in: [play-svelte-spa-router/src/types.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-svelte-spa-router/src/types.ts#L6)

package/api/@xmachines/play-sveltekit-router/README.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[Documentation](../../README.md) / @xmachines/play-sveltekit-router
+[API](../../README.md) / @xmachines/play-sveltekit-router
 # @xmachines/play-sveltekit-router
@@ -8,7 +8,7 @@ Thin SvelteKit adapter for XMachines Play.
 - Keeps `actor.currentRoute` and SvelteKit navigation in sync.
 - Exposes a local `RouteMap` plus `createRouteMap(machine)` helper.
-- No intermediate shared package — all shared logic lives in `@xmachines/play-router`.
+- No intermediate shared package — all shared logic lives in.
 - Extracts route params and query values when browser navigation enters through SvelteKit.
 ## Usage
@@ -32,6 +32,11 @@ onDestroy(disconnect);
 `createRouteMap(machine)` reads route metadata from the machine and builds a Play route map for SvelteKit paths.
+## Learn More
+- [Demo](../../../examples/@xmachines/play-sveltekit-router-demo/README.md)
+- [Svelte renderer](../play-svelte/README.md)
 ## Classes
 - [RouteMap](classes/RouteMap.md)
@@ -41,6 +46,7 @@ onDestroy(disconnect);
 - [ConnectRouterOptions](interfaces/ConnectRouterOptions.md)
 - [LocationLike](interfaces/LocationLike.md)
 - [PlayRouteEvent](interfaces/PlayRouteEvent.md)
+- [RouteMapOptions](interfaces/RouteMapOptions.md)
 - [RouteMapping](interfaces/RouteMapping.md)
 - [RouterBridge](interfaces/RouterBridge.md)

package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md CHANGED Viewed

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / RouteMap
+[API](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / RouteMap
 # Class: RouteMap
-Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/base-route-map.ts#L100)
+Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L100)
 Shared bidirectional route map base class.
@@ -50,7 +50,7 @@ map.getPathByStateId("missing"); // null
 new RouteMap(mappings, options?): RouteMap;
 ```
-Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/base-route-map.ts#L125)
+Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L125)
 Build a route map from an array of state ID ↔ path mappings.
@@ -78,7 +78,7 @@ buckets for efficient candidate selection.
 getPathByStateId(stateId): string | null;
 ```
-Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/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/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L209)
 Look up the path pattern registered for a state ID.
@@ -109,7 +109,7 @@ map.getPathByStateId("missing"); // null
 getStateIdByPath(path): string | null;
 ```
-Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/base-route-map.ts#L174)
+Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L174)
 Resolve a URL path to its mapped state ID.

package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / connectRouter
+[API](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / connectRouter
 # Function: connectRouter()
@@ -6,7 +6,7 @@
 function connectRouter(options): () => void;
 ```
-Defined in: [play-sveltekit-router/src/connect-router.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-sveltekit-router/src/connect-router.ts#L29)
+Defined in: [play-sveltekit-router/src/connect-router.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-sveltekit-router/src/connect-router.ts#L29)
 Connect SvelteKit router to actor.

package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md CHANGED Viewed

@@ -1,12 +1,12 @@
-[Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / createRouteMap
+[API](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / createRouteMap
 # Function: createRouteMap()
 ```ts
-function createRouteMap(machine): RouteMap;
+function createRouteMap(machine, options?): RouteMap;
 ```
-Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/create-route-map-from-machine.ts#L26)
+Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map.ts#L45)
 Create a `RouteMap` from an XState state machine.
@@ -17,9 +17,10 @@ vice-versa.
 ## Parameters
-| Parameter | Type                                                                      | Description                                                      |
-| --------- | ------------------------------------------------------------------------- | ---------------------------------------------------------------- |
-| `machine` | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | XState v5 state machine with `meta.route` annotations on states. |
+| Parameter  | Type                                                                      | Description                                                                                                         |
+| ---------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| `machine`  | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | XState v5 state machine with `meta.route` annotations on states.                                                    |
+| `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md)                     | Optional configuration. Pass `{ cacheSize }` to override the default LRU cache size for parameterized path lookups. |
 ## Returns
@@ -30,9 +31,9 @@ A `RouteMap` for passing to any `RouterBridgeBase`-based adapter.
 ## Example
 ```typescript
-import { createRouteMapFromMachine } from "@xmachines/play-router";
+import { createRouteMap } from "@xmachines/play-router";
 import { connectRouter } from "@xmachines/play-dom-router";
-const routeMap = createRouteMapFromMachine(myMachine);
+const routeMap = createRouteMap(myMachine);
 const disconnect = connectRouter({ actor, router, routeMap });
 ```

package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md CHANGED Viewed

@@ -1,13 +1,13 @@
-[Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / ConnectRouterOptions
+[API](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / ConnectRouterOptions
 # Interface: ConnectRouterOptions
-Defined in: [play-sveltekit-router/src/connect-router.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-sveltekit-router/src/connect-router.ts#L6)
+Defined in: [play-sveltekit-router/src/connect-router.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-sveltekit-router/src/connect-router.ts#L6)
 ## Properties
 | Property                                   | Modifier   | Type                                                                                                                                                                                                                                                             | Description                                                                                                                        | Defined in                                                                                                                                                                  |
 | ------------------------------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`        | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | -                                                                                                                                  | [play-sveltekit-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-sveltekit-router/src/connect-router.ts#L7)   |
-| <a id="property-location"></a> `location?` | `readonly` | [`LocationLike`](LocationLike.md) \| `null`                                                                                                                                                                                                                      | Location-like object for initial URL reads. Defaults to `globalThis.location`. Pass a mock in tests or a stub in SSR environments. | [play-sveltekit-router/src/connect-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-sveltekit-router/src/connect-router.ts#L13) |
-| <a id="property-routemap"></a> `routeMap`  | `readonly` | [`RouteMap`](../classes/RouteMap.md)                                                                                                                                                                                                                             | -                                                                                                                                  | [play-sveltekit-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-sveltekit-router/src/connect-router.ts#L8)   |
+| <a id="property-actor"></a> `actor`        | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | -                                                                                                                                  | [play-sveltekit-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-sveltekit-router/src/connect-router.ts#L7)   |
+| <a id="property-location"></a> `location?` | `readonly` | [`LocationLike`](LocationLike.md) \| `null`                                                                                                                                                                                                                      | Location-like object for initial URL reads. Defaults to `globalThis.location`. Pass a mock in tests or a stub in SSR environments. | [play-sveltekit-router/src/connect-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-sveltekit-router/src/connect-router.ts#L13) |
+| <a id="property-routemap"></a> `routeMap`  | `readonly` | [`RouteMap`](../classes/RouteMap.md)                                                                                                                                                                                                                             | -                                                                                                                                  | [play-sveltekit-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-sveltekit-router/src/connect-router.ts#L8)   |

package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md CHANGED Viewed

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / LocationLike
+[API](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / LocationLike
 # Interface: LocationLike
-Defined in: [play-router/src/types.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L344)
+Defined in: [play-router/src/types.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L344)
 Minimal location interface required by adapters that read the current URL at
 `connect()` time. Injectable for SSR and testing — pass a mock instead of the
@@ -23,5 +23,5 @@ connectRouter({ actor, routeMap, location: mockLoc });
 | Property                                  | Modifier   | Type     | Defined in                                                                                                                              |
 | ----------------------------------------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:345](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L345) |
-| <a id="property-search"></a> `search`     | `readonly` | `string` | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L346) |
+| <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:345](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L345) |
+| <a id="property-search"></a> `search`     | `readonly` | `string` | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L346) |

package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md CHANGED Viewed

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / PlayRouteEvent
+[API](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / PlayRouteEvent
 # Interface: PlayRouteEvent
-Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L223)
+Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L223)
 Enhanced routing event with parameter and query support
@@ -94,7 +94,7 @@ actor.send(event);
 ## See
-[Play RFC](../../docs/rfc/play.md)
+[Play RFC](../../../../rfc/play.md)
 ## Remarks
@@ -112,8 +112,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
 | Property                               | Modifier   | Type                           | Defined in                                                                                                                              |
 | -------------------------------------- | ---------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                      | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L228) |
-| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L226) |
-| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L227) |
-| <a id="property-to"></a> `to`          | `readonly` | `string`                       | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L225) |
-| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                 | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L224) |
+| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                      | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L228) |
+| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L226) |
+| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L227) |
+| <a id="property-to"></a> `to`          | `readonly` | `string`                       | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L225) |
+| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                 | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L224) |

package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md ADDED Viewed

@@ -0,0 +1,13 @@
+[API](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / RouteMapOptions
+# Interface: RouteMapOptions
+Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map.ts#L9)
+Options for `createRouteMap` and `createRouteMapFromTree`.
+## Properties
+| Property                                     | Type     | Description                                                                                                                                                                                                                                                                                                                                                                                | Defined in                                                                                                                                                  |
+| -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map.ts#L20) |

package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md CHANGED Viewed

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / RouteMapping
+[API](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / RouteMapping
 # Interface: RouteMapping
-Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/base-route-map.ts#L57)
+Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L57)
 A single state ID ↔ path mapping entry.
@@ -23,5 +23,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
 | Property                                | Modifier   | Type     | Description                                                                   | Defined in                                                                                                                                              |
 | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-path"></a> `path`       | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/base-route-map.ts#L61) |
-| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`)                         | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/base-route-map.ts#L59) |
+| <a id="property-path"></a> `path`       | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L61) |
+| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`)                         | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L59) |

package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md CHANGED Viewed

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / RouterBridge
+[API](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / RouterBridge
 # Interface: RouterBridge
-Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L271)
+Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L271)
 RouterBridge interface for runtime infrastructure adapters
@@ -44,7 +44,7 @@ class TanStackRouterBridge implements RouterBridge {
 ## See
-[Play RFC](../../docs/rfc/play.md) - Invariant INV-04
+[Play RFC](../../../../rfc/play.md) - Invariant INV-04
 ## Methods
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
-Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L287)
+Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L287)
 Connect the router bridge to the Actor
@@ -83,7 +83,7 @@ await bridge.connect();
 disconnect(): void | Promise<void>;
 ```
-Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L303)
+Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L303)
 Disconnect the router bridge from the Actor

package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / RoutableActor
+[API](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / RoutableActor
 # Type Alias: RoutableActor
@@ -6,4 +6,4 @@
 type RoutableActor = AbstractActor<AnyActorLogic> & Routable;
 ```
-Defined in: [play-sveltekit-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-sveltekit-router/src/types.ts#L10)
+Defined in: [play-sveltekit-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-sveltekit-router/src/types.ts#L10)

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

@@ -1,4 +1,4 @@
-[Documentation](../../README.md) / @xmachines/play-tanstack-react-router
+[API](../../README.md) / @xmachines/play-tanstack-react-router
 # @xmachines/play-tanstack-react-router
@@ -8,7 +8,7 @@
 `@xmachines/play-tanstack-react-router` connects a Play actor to TanStack Router through `TanStackReactRouterBridge`.
-The bridge extends `RouterBridgeBase` from `@xmachines/play-router`, so adapter behavior stays consistent across frameworks:
+The bridge extends `RouterBridgeBase` from, so adapter behavior stays consistent across frameworks:
 - Actor route signal (`actor.currentRoute`) drives router navigation.
 - Router history events send `play.route` intents back to the actor.
@@ -37,9 +37,9 @@ Peer dependencies:
 ## URLPattern Support
-This package uses the [URLPattern API](https://developer.mozilla.org/en-US/docs/Web/API/URLPattern) for route pattern matching via `@xmachines/play-router`.
+This package uses the [URLPattern API](https://developer.mozilla.org/en-US/docs/Web/API/URLPattern) for route pattern matching via.
-URLPattern is available natively on Node.js 24+ and modern browsers (Chrome 95+, Firefox 117+, Safari 16.4+). On older environments, load a polyfill **before** importing this package — see [`@xmachines/play-router`](../play-router) for details.
+URLPattern is available natively on Node.js 24+ and modern browsers (Chrome 95+, Firefox 117+, Safari 16.4+). On older environments, load a polyfill **before** importing this package — see [`@xmachines/play-router`](../play-router/README.md) for details.
 ## Quick Start
@@ -106,7 +106,7 @@ class TanStackReactRouterBridge implements RouterBridge {
 Map state IDs to URL paths and resolve URLs back to state IDs.
-`RouteMap` extends `BaseRouteMap` from `@xmachines/play-router`, inheriting bucket-indexed
+`RouteMap` extends `BaseRouteMap` from, inheriting bucket-indexed
 bidirectional route matching. No routing logic lives in the adapter itself.
 ```ts
@@ -158,7 +158,7 @@ interface PlayRouterProviderProps {
 ### Utilities and re-exports
 - `extractParams`, `extractQueryParams`
-- `extractMachineRoutes`, `createRouteMap` (re-exported from `@xmachines/play-router`)
+- `extractMachineRoutes`, `createRouteMap` (re-exported from)
 - `RouterBridge`, `PlayRouteEvent` types
 ## Examples
@@ -179,9 +179,14 @@ This keeps routing infrastructure passive while preserving business-logic contro
 ## Related Packages
-- [@xmachines/play-router](../play-router)
-- [@xmachines/play-xstate](../play-xstate)
-- [@xmachines/play-react](../play-react)
+- [@xmachines/play-router](../play-router/README.md)
+- [@xmachines/play-xstate](../play-xstate/README.md)
+- [@xmachines/play-react](../play-react/README.md)
+## Learn More
+- [Demo](../../../examples/@xmachines/play-tanstack-react-router-demo/README.md)
+- [React renderer](../play-react/README.md)
 ## License
@@ -204,6 +209,7 @@ Synchronizes browser URL with actor state through passive infrastructure.
 - [PlayRouteEvent](interfaces/PlayRouteEvent.md)
 - [PlayRouterProviderProps](interfaces/PlayRouterProviderProps.md)
+- [RouteMapOptions](interfaces/RouteMapOptions.md)
 - [RouteMapping](interfaces/RouteMapping.md)
 - [RouteNavigateEvent](interfaces/RouteNavigateEvent.md)
 - [RouterBridge](interfaces/RouterBridge.md)

package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md CHANGED Viewed

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / RouteMap
+[API](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / RouteMap
 # Class: RouteMap
-Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/base-route-map.ts#L100)
+Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L100)
 Shared bidirectional route map base class.
@@ -50,7 +50,7 @@ map.getPathByStateId("missing"); // null
 new RouteMap(mappings, options?): RouteMap;
 ```
-Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/base-route-map.ts#L125)
+Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L125)
 Build a route map from an array of state ID ↔ path mappings.
@@ -78,7 +78,7 @@ buckets for efficient candidate selection.
 getPathByStateId(stateId): string | null;
 ```
-Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/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/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L209)
 Look up the path pattern registered for a state ID.
@@ -109,7 +109,7 @@ map.getPathByStateId("missing"); // null
 getStateIdByPath(path): string | null;
 ```
-Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/base-route-map.ts#L174)
+Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L174)
 Resolve a URL path to its mapped state ID.