@xmachines/docs 1.0.0-beta.9 → 1.0.0

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

@@ -1,32 +1,40 @@
-[Documentation](../../../README.md) / [@xmachines/play-solid-router](../README.md) / RouteMap
+[API](../../../README.md) / [@xmachines/play-solid-router](../README.md) / RouteMap
 
 # Class: RouteMap
 
-Defined in: [packages/play-solid-router/src/route-map.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid-router/src/route-map.ts#L26)
+Defined in: [packages/play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L101)
 
 Shared bidirectional route map base class.
 
-All framework adapter `RouteMap` classes extend this — they add no logic of their
+All framework adapters use this class as their route map — they add no logic of their
 own and inherit the full public API from here.
 
 **Lookup strategy:**
 
 - Static paths (no `:param`) → O(1) `Map` lookup
-- Dynamic paths → O(k) bucket-indexed scan using `RegExp`, where `k` is the number
+- Dynamic paths → O(k) bucket-indexed scan using `URLPattern`, where `k` is the number
   of routes sharing the same first path segment
-- Results are cached after the first match
+- Results are cached after the first match in an LRU cache (default 500 entries,
+  configurable via the `cacheSize` constructor option)
 
-**Pattern syntax** (`:param` / `:param?`):
+**Pattern syntax** (`:param` / `:param?` / `*`):
 
 - `:param` — required segment, matches exactly one non-`/` segment
 - `:param?` — optional segment, matches zero or one non-`/` segment
+- `*` — wildcard, matches any number of segments (URLPattern semantics)
+
+**StateId forms:** stateIds may be registered and looked up in either
+`"#stateId"` or `"stateId"` form — `RouteMap` canonicalizes internally.
+`getStateIdByPath` returns the stateId exactly as registered;
+`getPathByStateId` accepts both forms. Registering the same stateId in both
+forms refers to one entry (the later registration wins for reverse lookup).
 
 ## Example
 
 ```typescript
-import { BaseRouteMap } from "@xmachines/play-router";
+import { RouteMap } from "@xmachines/play-router";
 
-const map = new BaseRouteMap([
+const map = new RouteMap([
 	{ stateId: "home", path: "/" },
 	{ stateId: "profile", path: "/profile/:userId" },
 	{ stateId: "settings", path: "/settings/:section?" },
@@ -41,40 +49,34 @@ map.getPathByStateId("profile"); // "/profile/:userId"
 map.getPathByStateId("missing"); // null
 ```
 
-## Extends
-
-- [`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md)
-
 ## Constructors
 
 ### Constructor
 
 ```ts
-new RouteMap(mappings): RouteMap;
+new RouteMap(mappings, options?): RouteMap;
 ```
 
-Defined in: packages/play-router/dist/base-route-map.d.ts:81
+Defined in: [packages/play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L127)
 
 Build a route map from an array of state ID ↔ path mappings.
 
 Static paths (no `:param`) are indexed in an O(1) `Map`.
-Parameterized paths are compiled to `RegExp` and grouped into first-segment
+Parameterized paths are compiled to `URLPattern` and grouped into first-segment
 buckets for efficient candidate selection.
 
 #### Parameters
 
-| Parameter  | Type                                                                     | Description                                                                                                       |
-| ---------- | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
-| `mappings` | [`BaseRouteMapping`](../../play-router/interfaces/BaseRouteMapping.md)[] | Array of `{ stateId, path }` entries. Order determines priority when multiple patterns could match the same path. |
+| Parameter            | Type                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                  |
+| -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `mappings`           | [`RouteMapping`](../interfaces/RouteMapping.md)[] | Array of `{ stateId, path }` entries. Order determines priority when multiple patterns could match the same path.                                                                                                                                                                                                                                                                                            |
+| `options`            | \{ `cacheSize?`: `number`; \}                     | Optional configuration. `options.cacheSize`: Maximum number of resolved parameterized path lookups to cache. Defaults to `500`. Increase for applications with many unique parameterized URL values (e.g. user profile pages with thousands of distinct IDs). After eviction the path falls back to the O(k) bucket pattern scan — correct but slower. Minimum effective value is `1` (QuickLRU constraint). |
+| `options.cacheSize?` | `number`                                          | -                                                                                                                                                                                                                                                                                                                                                                                                            |
 
 #### Returns
 
 `RouteMap`
 
-#### Inherited from
-
-[`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md).[`constructor`](../../play-router/classes/BaseRouteMap.md#constructor)
-
 ## Methods
 
 ### getPathByStateId()
@@ -83,10 +85,14 @@ buckets for efficient candidate selection.
 getPathByStateId(stateId): string | null;
 ```
 
-Defined in: packages/play-router/dist/base-route-map.d.ts:111
+Defined in: [packages/play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L218)
 
 Look up the path pattern registered for a state ID.
 
+Accepts the stateId in either `"#stateId"` or `"stateId"` form regardless of
+which form was used at registration — lookups are canonicalized internally,
+so consumers never need to try both forms.
+
 #### Parameters
 
 | Parameter | Type     | Description                                               |
@@ -103,13 +109,10 @@ The registered path pattern, or `null` if the state ID is unknown
 
 ```typescript
 map.getPathByStateId("profile"); // "/profile/:userId"
+map.getPathByStateId("#profile"); // "/profile/:userId" (same entry)
 map.getPathByStateId("missing"); // null
 ```
 
-#### Inherited from
-
-[`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md).[`getPathByStateId`](../../play-router/classes/BaseRouteMap.md#getpathbystateid)
-
 ---
 
 ### getStateIdByPath()
@@ -118,7 +121,7 @@ map.getPathByStateId("missing"); // null
 getStateIdByPath(path): string | null;
 ```
 
-Defined in: packages/play-router/dist/base-route-map.d.ts:98
+Defined in: [packages/play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L178)
 
 Resolve a URL path to its mapped state ID.
 
@@ -144,7 +147,3 @@ The mapped state ID, or `null` if no route matches
 map.getStateIdByPath("/profile/123"); // "profile"
 map.getStateIdByPath("/unknown"); // null
 ```
-
-#### Inherited from
-
-[`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md).[`getStateIdByPath`](../../play-router/classes/BaseRouteMap.md#getstateidbypath)

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

@@ -1,8 +1,8 @@
-[Documentation](../../../README.md) / [@xmachines/play-solid-router](../README.md) / SolidRouterBridge
+[API](../../../README.md) / [@xmachines/play-solid-router](../README.md) / SolidRouterBridge
 
 # Class: SolidRouterBridge
 
-Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid-router/src/solid-router-bridge.ts#L47)
+Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/solid-router-bridge.ts#L54)
 
 SolidJS Router integration bridge extending RouterBridgeBase
 
@@ -10,6 +10,10 @@ Implements RouterBridge protocol for SolidJS Router using Solid's reactive
 primitives. The actor→router direction uses TC39 Signal watcher (from base class).
 The router→actor direction uses Solid's createEffect for native reactivity.
 
+Path parameters are extracted from Solid's `useParams()` reactive proxy rather than
+re-parsing the URL with URLPattern. This means parameterized routes work without the
+URLPattern polyfill — Solid's router has already extracted the values.
+
 ## Extends
 
 - [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md)
@@ -22,12 +26,12 @@ The router→actor direction uses Solid's createEffect for native reactivity.
 new SolidRouterBridge(
    solidNavigate,
    location,
-   _params,
+   params,
    actor,
    routeMap): SolidRouterBridge;
 ```
 
-Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid-router/src/solid-router-bridge.ts#L59)
+Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/solid-router-bridge.ts#L75)
 
 Create a SolidJS Router bridge
 
@@ -35,15 +39,13 @@ Create a SolidJS Router bridge
 
 #### Parameters
 
-| Parameter           | Type                                                                                                                         | Description                           |
-| ------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
-| `solidNavigate`     | (`path`, ...`args`) => `unknown`                                                                                             | Result of useNavigate() hook          |
-| `location`          | \{ `pathname`: `string`; `search`: `string`; \}                                                                              | Result of useLocation() hook          |
-| `location.pathname` | `string`                                                                                                                     | -                                     |
-| `location.search`   | `string`                                                                                                                     | -                                     |
-| `_params`           | `Record`\<`string`, `string` \| `undefined`\>                                                                                | Result of useParams() hook            |
-| `actor`             | [`AbstractActor`](../interfaces/AbstractActor.md)\<`AnyActorLogic`\> & [`Routable`](../../play-actor/interfaces/Routable.md) | XMachines actor instance              |
-| `routeMap`          | [`RouteMap`](RouteMap.md)                                                                                                    | Bidirectional state ID ↔ path mapping |
+| Parameter       | Type                                                                 | Description                                                                                                                                     |
+| --------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| `solidNavigate` | `Navigator`                                                          | Result of useNavigate() hook                                                                                                                    |
+| `location`      | [`LocationLike`](../../play-router/interfaces/LocationLike.md)       | Result of useLocation() hook                                                                                                                    |
+| `params`        | `Params`                                                             | Result of useParams() hook — used directly for path parameter extraction, avoiding the URLPattern polyfill requirement for parameterized routes |
+| `actor`         | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | XMachines actor instance                                                                                                                        |
+| `routeMap`      | [`RouteMap`](RouteMap.md)                                            | Bidirectional state ID ↔ path mapping                                                                                                           |
 
 #### Returns
 
@@ -53,20 +55,6 @@ Create a SolidJS Router bridge
 
 [`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`](../interfaces/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)                                   | packages/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)             | packages/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)                       | packages/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) | packages/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)                 | packages/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)                             | packages/play-router/dist/router-bridge-base.d.ts:56 |
-| `routeMap.getPathByStateId`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                            | -                                                     | -                                                                                                                                                                             | packages/play-router/dist/router-bridge-base.d.ts:58 |
-| `routeMap.getStateIdByPath`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                            | -                                                     | -                                                                                                                                                                             | packages/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)                     | packages/play-router/dist/router-bridge-base.d.ts:64 |
-
 ## Methods
 
 ### connect()
@@ -75,13 +63,22 @@ Create a SolidJS Router bridge
 connect(): void;
 ```
 
-Defined in: packages/play-router/dist/router-bridge-base.d.ts:81
+Defined in: [packages/play-router/src/router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/router-bridge-base.ts#L151)
 
 Connect the router bridge to the Actor.
 
 Sets up the TC39 Signal watcher for actor → router direction and
 starts watching router changes (framework-specific).
 
+Ordering here is part of the bridge contract:
+
+- `lastSyncedPath` is seeded in the constructor from `actor.currentRoute`
+- the actor watcher is installed before adapter router subscriptions
+- initial sync then resolves deep-link vs restore using `actor.initialRoute`
+
+Adapters that need custom initial-sync behavior should override
+`getInitialRouterPath()` rather than reordering `connect()` steps.
+
 #### Returns
 
 `void`
@@ -98,7 +95,7 @@ starts watching router changes (framework-specific).
 disconnect(): void;
 ```
 
-Defined in: packages/play-router/dist/router-bridge-base.d.ts:87
+Defined in: [packages/play-router/src/router-bridge-base.ts:256](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/router-bridge-base.ts#L256)
 
 Disconnect the router bridge from the Actor.
 
@@ -120,7 +117,7 @@ Stops signal watching and unregisters framework-specific router listener.
 dispose(): void;
 ```
 
-Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid-router/src/solid-router-bridge.ts#L123)
+Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/solid-router-bridge.ts#L187)
 
 Dispose the bridge (alias for disconnect).
 
@@ -133,215 +130,3 @@ Dispose the bridge (alias for disconnect).
 ```tsx
 onCleanup(() => bridge.dispose());
 ```
-
----
-
-### extractParams()
-
-```ts
-protected extractParams(pathname, stateId): Record<string, string>;
-```
-
-Defined in: packages/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: packages/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: [packages/play-solid-router/src/solid-router-bridge.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid-router/src/solid-router-bridge.ts#L82)
-
-Get the current router pathname for initial URL -> actor sync on connect.
-
-#### 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: [packages/play-solid-router/src/solid-router-bridge.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid-router/src/solid-router-bridge.ts#L75)
-
-Navigate SolidJS 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: packages/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: packages/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: [packages/play-solid-router/src/solid-router-bridge.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid-router/src/solid-router-bridge.ts#L111)
-
-Stop watching SolidJS Router changes.
-
-Solid auto-cleans createEffect subscriptions when component unmounts.
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`unwatchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#unwatchrouterchanges)
-
----
-
-### watchRouterChanges()
-
-```ts
-protected watchRouterChanges(): void;
-```
-
-Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid-router/src/solid-router-bridge.ts#L92)
-
-Subscribe to SolidJS Router location changes using createEffect.
-
-MUST be called inside a Solid reactive owner (component/createRoot).
-Solid auto-cleans createEffect subscriptions on component unmount.
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`watchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#watchrouterchanges)

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

@@ -0,0 +1,44 @@
+[API](../../../README.md) / [@xmachines/play-solid-router](../README.md) / createPlayRouterProvider
+
+# Function: createPlayRouterProvider()
+
+```ts
+function createPlayRouterProvider<TRouter>(BridgeCtor): <TActor>(props) => any;
+```
+
+Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L68)
+
+Create a Solid `PlayRouterProvider` component bound to a specific bridge class.
+
+The returned component connects a `PlayerActor` to the framework router,
+keeping actor state and browser URL in sync bidirectionally.
+
+The bridge is created synchronously at component evaluation time (Solid's
+execution model) and torn down via `onCleanup` when the component is disposed.
+Unlike React, prop stability is not a concern — Solid's `props` accessor is
+already reactive and the bridge is created once per component instance.
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `TRouter`      |
+
+## Parameters
+
+| Parameter    | Type                                                                                         | Description                                                            |
+| ------------ | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
+| `BridgeCtor` | [`PlayRouterBridgeConstructor`](../type-aliases/PlayRouterBridgeConstructor.md)\<`TRouter`\> | Bridge class constructed as `new BridgeCtor(router, actor, routeMap)`. |
+
+## Returns
+
+A `PlayRouterProvider` component, generic over the actor type so the
+`renderer` callback receives the same concrete actor type that was passed in.
+
+\<`TActor`\>(`props`) => `any`
+
+## Example
+
+```tsx
+export const PlayRouterProvider = createPlayRouterProvider(MySolidRouterBridge);
+```

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

@@ -1,32 +1,39 @@
-[Documentation](../../../README.md) / [@xmachines/play-solid-router](../README.md) / createRouteMap
+[API](../../../README.md) / [@xmachines/play-solid-router](../README.md) / createRouteMap
 
 # Function: createRouteMap()
 
 ```ts
-function createRouteMap(machine): RouteMap;
+function createRouteMap(machine, options?): RouteMap;
 ```
 
-Defined in: [packages/play-solid-router/src/create-route-map.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid-router/src/create-route-map.ts#L27)
+Defined in: [packages/play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/create-route-map.ts#L45)
 
-Create a RouteMap from an XState machine
+Create a `RouteMap` from an XState state machine.
+
+Extracts all routable states (those with `meta.route`) and builds a bidirectional
+path ↔ stateId lookup structure. The returned map is used by `RouterBridgeBase`
+subclasses to translate browser URL changes into `play.route` actor events and
+vice-versa.
 
 ## Parameters
 
-| Parameter | Type              | Description                                    |
-| --------- | ----------------- | ---------------------------------------------- |
-| `machine` | `AnyStateMachine` | XState machine with route: {} config 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
 
 [`RouteMap`](../classes/RouteMap.md)
 
-RouteMap for bidirectional state ID ↔ path resolution
+A `RouteMap` for passing to any `RouterBridgeBase`-based adapter.
 
 ## Example
 
 ```typescript
-import { createRouteMap } from "@xmachines/play-solid-router";
-import { authMachine } from "./machine.js";
+import { createRouteMap } from "@xmachines/play-router";
+import { connectRouter } from "@xmachines/play-dom-router";
 
-const routeMap = createRouteMap(authMachine);
+const routeMap = createRouteMap(myMachine);
+const disconnect = connectRouter({ actor, router, routeMap });
 ```