@xmachines/docs 1.0.0-beta.24 → 1.0.0-beta.25

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 (194) hide show
  1. package/api/@xmachines/play/classes/PlayError.md +4 -4
  2. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  3. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  4. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  5. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  6. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  7. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  8. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  9. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  10. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  11. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  12. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +7 -7
  13. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +3 -3
  14. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  15. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  16. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  17. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  18. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  19. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  20. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  21. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  22. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  23. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  24. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  25. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  26. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  27. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  28. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +7 -7
  29. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  30. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  31. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +21 -21
  32. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  33. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  34. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  35. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  36. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  37. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  38. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  39. package/api/@xmachines/play-router/classes/BaseRouteMap.md +6 -4
  40. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +21 -21
  41. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  42. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  43. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  44. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  45. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  46. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  47. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  48. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  49. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  50. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  51. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  52. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  53. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  54. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  55. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  56. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  57. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  58. package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +3 -3
  59. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  60. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  61. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  62. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  63. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  64. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  65. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  66. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  67. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  68. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  69. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +6 -6
  70. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  71. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  72. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  73. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  74. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  75. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  76. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  77. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  78. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  79. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  80. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  81. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +7 -7
  82. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  83. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  84. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  85. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +22 -22
  86. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  87. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  88. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  89. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  90. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  91. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  92. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  93. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  94. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  95. package/api/@xmachines/play-svelte/README.md +91 -0
  96. package/api/@xmachines/play-svelte/functions/defineRegistry.md +52 -0
  97. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +27 -0
  98. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +27 -0
  99. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +22 -0
  100. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +16 -0
  101. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +7 -0
  102. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +7 -0
  103. package/api/@xmachines/play-svelte/variables/getBoundProp.md +7 -0
  104. package/api/@xmachines/play-svelte-spa-router/README.md +53 -0
  105. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +150 -0
  106. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +19 -0
  107. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +19 -0
  108. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +16 -0
  109. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +119 -0
  110. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +12 -0
  111. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +104 -0
  112. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +9 -0
  113. package/api/@xmachines/play-svelte-spa-router-demo/README.md +23 -0
  114. package/api/@xmachines/play-sveltekit-router/README.md +53 -0
  115. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +115 -0
  116. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +19 -0
  117. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +19 -0
  118. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +12 -0
  119. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +119 -0
  120. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +12 -0
  121. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +104 -0
  122. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +9 -0
  123. package/api/@xmachines/play-sveltekit-router-demo/README.md +23 -0
  124. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  125. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +21 -21
  126. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  127. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  128. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  129. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  130. package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
  131. package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
  132. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  133. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  134. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  135. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  136. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  137. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  138. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  139. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  140. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +22 -22
  141. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  142. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  143. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  144. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  145. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  146. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  147. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  148. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  149. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  150. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  151. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  152. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  153. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  154. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  155. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  156. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  157. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  158. package/api/@xmachines/play-vue-router/classes/RouteMap.md +7 -7
  159. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +7 -7
  160. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +22 -22
  161. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  162. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  163. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  164. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  165. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  166. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  167. package/api/@xmachines/play-xstate/classes/PlayerActor.md +11 -11
  168. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  169. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  170. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  171. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  172. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  173. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  174. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  175. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  176. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  177. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  178. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  179. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  180. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  181. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  182. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  183. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  184. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  185. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  186. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  187. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  188. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  189. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
  190. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  191. package/api/README.md +5 -0
  192. package/api/llms.txt +3 -0
  193. package/examples/multi-router-integration.md +34 -6
  194. package/package.json +2 -2
@@ -0,0 +1,115 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / RouteMap
2
+
3
+ # Class: RouteMap
4
+
5
+ Defined in: [play-sveltekit-router/src/route-map.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-sveltekit-router/src/route-map.ts#L6)
6
+
7
+ SvelteKit route map backed by the shared Play router base class.
8
+
9
+ ## Extends
10
+
11
+ - [`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md)
12
+
13
+ ## Constructors
14
+
15
+ ### Constructor
16
+
17
+ ```ts
18
+ new RouteMap(mappings): RouteMap;
19
+ ```
20
+
21
+ Defined in: play-router/dist/base-route-map.d.ts:82
22
+
23
+ Build a route map from an array of state ID ↔ path mappings.
24
+
25
+ Static paths (no `:param`) are indexed in an O(1) `Map`.
26
+ Parameterized paths are compiled to `URLPattern` and grouped into first-segment
27
+ buckets for efficient candidate selection.
28
+
29
+ #### Parameters
30
+
31
+ | Parameter | Type | Description |
32
+ | ---------- | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
33
+ | `mappings` | [`BaseRouteMapping`](../../play-router/interfaces/BaseRouteMapping.md)[] | Array of `{ stateId, path }` entries. Order determines priority when multiple patterns could match the same path. |
34
+
35
+ #### Returns
36
+
37
+ `RouteMap`
38
+
39
+ #### Inherited from
40
+
41
+ [`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md).[`constructor`](../../play-router/classes/BaseRouteMap.md#constructor)
42
+
43
+ ## Methods
44
+
45
+ ### getPathByStateId()
46
+
47
+ ```ts
48
+ getPathByStateId(stateId): string | null;
49
+ ```
50
+
51
+ Defined in: play-router/dist/base-route-map.d.ts:112
52
+
53
+ Look up the path pattern registered for a state ID.
54
+
55
+ #### Parameters
56
+
57
+ | Parameter | Type | Description |
58
+ | --------- | -------- | --------------------------------------------------------- |
59
+ | `stateId` | `string` | State machine state ID (e.g., `"profile"`, `"#settings"`) |
60
+
61
+ #### Returns
62
+
63
+ `string` \| `null`
64
+
65
+ The registered path pattern, or `null` if the state ID is unknown
66
+
67
+ #### Example
68
+
69
+ ```typescript
70
+ map.getPathByStateId("profile"); // "/profile/:userId"
71
+ map.getPathByStateId("missing"); // null
72
+ ```
73
+
74
+ #### Inherited from
75
+
76
+ [`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md).[`getPathByStateId`](../../play-router/classes/BaseRouteMap.md#getpathbystateid)
77
+
78
+ ---
79
+
80
+ ### getStateIdByPath()
81
+
82
+ ```ts
83
+ getStateIdByPath(path): string | null;
84
+ ```
85
+
86
+ Defined in: play-router/dist/base-route-map.d.ts:99
87
+
88
+ Resolve a URL path to its mapped state ID.
89
+
90
+ Strips query strings and hash fragments before matching. Tries an O(1) exact
91
+ lookup first, then falls back to bucket-indexed pattern matching. Results are
92
+ cached after the first pattern match.
93
+
94
+ #### Parameters
95
+
96
+ | Parameter | Type | Description |
97
+ | --------- | -------- | ------------------------------------------------------------------------------ |
98
+ | `path` | `string` | URL pathname, optionally including query/hash (e.g., `"/profile/123?ref=nav"`) |
99
+
100
+ #### Returns
101
+
102
+ `string` \| `null`
103
+
104
+ The mapped state ID, or `null` if no route matches
105
+
106
+ #### Example
107
+
108
+ ```typescript
109
+ map.getStateIdByPath("/profile/123"); // "profile"
110
+ map.getStateIdByPath("/unknown"); // null
111
+ ```
112
+
113
+ #### Inherited from
114
+
115
+ [`BaseRouteMap`](../../play-router/classes/BaseRouteMap.md).[`getStateIdByPath`](../../play-router/classes/BaseRouteMap.md#getstateidbypath)
@@ -0,0 +1,19 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / connectRouter
2
+
3
+ # Function: connectRouter()
4
+
5
+ ```ts
6
+ function connectRouter(options): () => void;
7
+ ```
8
+
9
+ Defined in: [play-sveltekit-router/src/connect-router.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-sveltekit-router/src/connect-router.ts#L28)
10
+
11
+ ## Parameters
12
+
13
+ | Parameter | Type |
14
+ | --------- | --------------------------------------------------------------- |
15
+ | `options` | [`ConnectRouterOptions`](../interfaces/ConnectRouterOptions.md) |
16
+
17
+ ## Returns
18
+
19
+ () => `void`
@@ -0,0 +1,19 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / createRouteMap
2
+
3
+ # Function: createRouteMap()
4
+
5
+ ```ts
6
+ function createRouteMap(machine): RouteMap;
7
+ ```
8
+
9
+ Defined in: [play-sveltekit-router/src/create-route-map.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-sveltekit-router/src/create-route-map.ts#L5)
10
+
11
+ ## Parameters
12
+
13
+ | Parameter | Type |
14
+ | --------- | ------------------------------------------------------------------------- |
15
+ | `machine` | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
16
+
17
+ ## Returns
18
+
19
+ [`RouteMap`](../classes/RouteMap.md)
@@ -0,0 +1,12 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / ConnectRouterOptions
2
+
3
+ # Interface: ConnectRouterOptions
4
+
5
+ Defined in: [play-sveltekit-router/src/connect-router.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-sveltekit-router/src/connect-router.ts#L12)
6
+
7
+ ## Properties
8
+
9
+ | Property | Modifier | Type | Defined in |
10
+ | ----------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
+ | <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:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-sveltekit-router/src/connect-router.ts#L13) |
12
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | [play-sveltekit-router/src/connect-router.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-sveltekit-router/src/connect-router.ts#L14) |
@@ -0,0 +1,119 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / PlayRouteEvent
2
+
3
+ # Interface: PlayRouteEvent
4
+
5
+ Defined in: play-router/dist/types.d.ts:207
6
+
7
+ Enhanced routing event with parameter and query support
8
+
9
+ Unified routing event used throughout the Play architecture. Supports parameter-aware
10
+ navigation patterns (e.g., `/profile/:userId`) for dynamic route segments.
11
+
12
+ **Architectural Context:** Implements **Passive Infrastructure (INV-04)** by representing
13
+ user navigation intent that the Actor evaluates through guards. Infrastructure proposes
14
+ via `play.route` events, Actor decides via state machine transitions.
15
+
16
+ **Browser Navigation Flow:**
17
+
18
+ 1. Browser fires `popstate`
19
+ 2. Router adapter resolves URL to route target
20
+ 3. Adapter sends `PlayRouteEvent` to Actor
21
+ 4. Actor validates transition via state machine guards
22
+
23
+ ## Param
24
+
25
+ Event discriminator (always "play.route")
26
+
27
+ ## Param
28
+
29
+ Target state ID with # prefix (e.g., '#home', '#profile')
30
+
31
+ ## Param
32
+
33
+ Merged path + query parameters (path parameters win conflicts)
34
+
35
+ ## Param
36
+
37
+ Query parameters only (isolated from path params)
38
+
39
+ ## Param
40
+
41
+ Full URLPattern match result for debugging/observability (optional)
42
+
43
+ ## Examples
44
+
45
+ Combining base and routing events
46
+
47
+ ```typescript
48
+ import type { PlayEvent } from "@xmachines/play";
49
+ import type { PlayRouteEvent } from "@xmachines/play-router";
50
+
51
+ type AppEvent = PlayEvent | PlayRouteEvent;
52
+ ```
53
+
54
+ Basic navigation to a route
55
+
56
+ ```typescript
57
+ import type { PlayRouteEvent } from "@xmachines/play-router";
58
+
59
+ const event: PlayRouteEvent = {
60
+ type: "play.route",
61
+ to: "#home",
62
+ };
63
+ actor.send(event);
64
+ ```
65
+
66
+ Navigation with route parameters
67
+
68
+ ```typescript
69
+ import type { PlayRouteEvent } from "@xmachines/play-router";
70
+
71
+ const event: PlayRouteEvent = {
72
+ type: "play.route",
73
+ to: "#profile",
74
+ params: { userId: "123" },
75
+ };
76
+ actor.send(event);
77
+ // Resolves to route: /profile/123
78
+ ```
79
+
80
+ Navigation with query parameters
81
+
82
+ ```typescript
83
+ import type { PlayRouteEvent } from "@xmachines/play-router";
84
+
85
+ const event: PlayRouteEvent = {
86
+ type: "play.route",
87
+ to: "#settings",
88
+ params: { section: "profile" }, // Merged: path + query
89
+ query: { tab: "security" }, // Query-only
90
+ };
91
+ actor.send(event);
92
+ // Resolves to route: /settings/profile?tab=security
93
+ ```
94
+
95
+ ## See
96
+
97
+ [Play RFC](../../../../rfc/play.md)
98
+
99
+ ## Remarks
100
+
101
+ Use `play.route` when you need parameter-aware navigation with the `route: {}`
102
+ config pattern on your state machine nodes. The `match` field exposes the full
103
+ URLPatternResult for advanced use cases (debugging, pattern analysis).
104
+
105
+ ## Indexable
106
+
107
+ ```ts
108
+ [key: string]: unknown
109
+ ```
110
+
111
+ ## Properties
112
+
113
+ | Property | Modifier | Type | Defined in |
114
+ | -------------------------------------- | ---------- | ------------------------------ | ------------------------------- |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | play-router/dist/types.d.ts:212 |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | play-router/dist/types.d.ts:210 |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | play-router/dist/types.d.ts:211 |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | play-router/dist/types.d.ts:209 |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | play-router/dist/types.d.ts:208 |
@@ -0,0 +1,12 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / RouteMapping
2
+
3
+ # Interface: RouteMapping
4
+
5
+ Defined in: [play-sveltekit-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-sveltekit-router/src/types.ts#L10)
6
+
7
+ ## Properties
8
+
9
+ | Property | Modifier | Type | Description | Defined in |
10
+ | --------------------------------------- | ---------- | -------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
+ | <a id="property-path"></a> `path` | `readonly` | `string` | SvelteKit pathname pattern. | [play-sveltekit-router/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-sveltekit-router/src/types.ts#L14) |
12
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | XMachines state ID (for example `#home` or `dashboard.home`). | [play-sveltekit-router/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-sveltekit-router/src/types.ts#L12) |
@@ -0,0 +1,104 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / RouterBridge
2
+
3
+ # Interface: RouterBridge
4
+
5
+ Defined in: play-router/dist/types.d.ts:254
6
+
7
+ RouterBridge interface for runtime infrastructure adapters
8
+
9
+ Defines the lifecycle connection between Infrastructure (e.g., TanStack Router) and
10
+ the Actor. Infrastructure "bridges" to the Actor by observing its signals and
11
+ managing its own lifecycle accordingly.
12
+
13
+ **Architectural Context:** Implements **Passive Infrastructure (INV-04)** by establishing
14
+ a unidirectional observation pattern. Infrastructure connects to observe Actor signals
15
+ (currentRoute, currentView, state) and reflects changes without making state decisions.
16
+
17
+ ## Example
18
+
19
+ TanStack Router bridge implementation
20
+
21
+ ```typescript
22
+ import type { RouterBridge } from "@xmachines/play-router";
23
+ import { Signal } from "@xmachines/play-signals";
24
+
25
+ class TanStackRouterBridge implements RouterBridge {
26
+ private watcher: Signal.Watcher | null = null;
27
+
28
+ async connect(): Promise<void> {
29
+ // Start observing actor.currentRoute signal
30
+ this.watcher = new Signal.subtle.Watcher(() => {
31
+ const route = actor.currentRoute.get();
32
+ if (route) router.navigate(route);
33
+ });
34
+ this.watcher.watch(actor.currentRoute);
35
+ }
36
+
37
+ async disconnect(): Promise<void> {
38
+ // Stop observing, cleanup watchers
39
+ this.watcher?.unwatch(actor.currentRoute);
40
+ this.watcher = null;
41
+ }
42
+ }
43
+ ```
44
+
45
+ ## See
46
+
47
+ [Play RFC](../../../../rfc/play.md) - Invariant INV-04
48
+
49
+ ## Methods
50
+
51
+ ### connect()
52
+
53
+ ```ts
54
+ connect(): void | Promise<void>;
55
+ ```
56
+
57
+ Defined in: play-router/dist/types.d.ts:270
58
+
59
+ Connect the router bridge to the Actor
60
+
61
+ Called when Infrastructure should begin observing Actor signals and
62
+ synchronizing its state (e.g., browser URL) with Actor state.
63
+
64
+ #### Returns
65
+
66
+ `void` \| `Promise`\<`void`\>
67
+
68
+ Promise that resolves when connection is established, or void for synchronous connection
69
+
70
+ #### Example
71
+
72
+ ```typescript
73
+ const bridge: RouterBridge = createBridge(actor, router);
74
+ await bridge.connect();
75
+ // Bridge now observing actor.currentRoute signal
76
+ ```
77
+
78
+ ---
79
+
80
+ ### disconnect()
81
+
82
+ ```ts
83
+ disconnect(): void | Promise<void>;
84
+ ```
85
+
86
+ Defined in: play-router/dist/types.d.ts:285
87
+
88
+ Disconnect the router bridge from the Actor
89
+
90
+ Called when Infrastructure should stop observing and clean up resources
91
+ (e.g., signal watchers, event listeners).
92
+
93
+ #### Returns
94
+
95
+ `void` \| `Promise`\<`void`\>
96
+
97
+ Promise that resolves when disconnection is complete, or void for synchronous disconnection
98
+
99
+ #### Example
100
+
101
+ ```typescript
102
+ await bridge.disconnect();
103
+ // Bridge stopped observing, resources cleaned up
104
+ ```
@@ -0,0 +1,9 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / RoutableActor
2
+
3
+ # Type Alias: RoutableActor
4
+
5
+ ```ts
6
+ type RoutableActor = AbstractActor<AnyActorLogic> & Routable;
7
+ ```
8
+
9
+ Defined in: [play-sveltekit-router/src/types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-sveltekit-router/src/types.ts#L17)
@@ -0,0 +1,23 @@
1
+ [Documentation](../../README.md) / @xmachines/play-sveltekit-router-demo
2
+
3
+ # @xmachines/play-sveltekit-router demo
4
+
5
+ Compact browser demo for the SvelteKit router adapter.
6
+
7
+ ## Imports
8
+
9
+ - `@xmachines/play-svelte` for the Svelte renderer and registry helpers
10
+ - `@xmachines/play-sveltekit-router` for URL ↔ actor sync
11
+
12
+ ## Commands
13
+
14
+ ```bash
15
+ npm run dev -w @xmachines/play-sveltekit-router-demo
16
+ npm run build -w @xmachines/play-sveltekit-router-demo
17
+ npm run test:browser -w @xmachines/play-sveltekit-router-demo
18
+ ```
19
+
20
+ ## What it proves
21
+
22
+ - Clicking a navigation control updates the rendered view
23
+ - The browser pathname follows the active route
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-tanstack-react-router/src/route-map.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-tanstack-react-router/src/route-map.ts#L54)
5
+ Defined in: [play-tanstack-react-router/src/route-map.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-tanstack-react-router/src/route-map.ts#L54)
6
6
 
7
7
  Bidirectional route mapper for TanStack React Router.
8
8
 
@@ -40,7 +40,7 @@ routeMap.getPathByStateId("home"); // "/"
40
40
  new RouteMap(mappings): RouteMap;
41
41
  ```
42
42
 
43
- Defined in: [play-router/src/base-route-map.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/base-route-map.ts#L118)
43
+ Defined in: [play-router/src/base-route-map.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/base-route-map.ts#L118)
44
44
 
45
45
  Build a route map from an array of state ID ↔ path mappings.
46
46
 
@@ -70,7 +70,7 @@ buckets for efficient candidate selection.
70
70
  getPathByStateId(stateId): string | null;
71
71
  ```
72
72
 
73
- Defined in: [play-router/src/base-route-map.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/base-route-map.ts#L202)
73
+ Defined in: [play-router/src/base-route-map.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/base-route-map.ts#L202)
74
74
 
75
75
  Look up the path pattern registered for a state ID.
76
76
 
@@ -105,7 +105,7 @@ map.getPathByStateId("missing"); // null
105
105
  getStateIdByPath(path): string | null;
106
106
  ```
107
107
 
108
- Defined in: [play-router/src/base-route-map.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/base-route-map.ts#L167)
108
+ Defined in: [play-router/src/base-route-map.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/base-route-map.ts#L167)
109
109
 
110
110
  Resolve a URL path to its mapped state ID.
111
111
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: TanStackReactRouterBridge
4
4
 
5
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L80)
5
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L80)
6
6
 
7
7
  TanStack React Router adapter implementing RouterBridge protocol via RouterBridgeBase
8
8
 
@@ -47,7 +47,7 @@ new TanStackReactRouterBridge(
47
47
  routeMap): TanStackReactRouterBridge;
48
48
  ```
49
49
 
50
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L90)
50
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L90)
51
51
 
52
52
  Create TanStack React Router bridge
53
53
 
@@ -71,15 +71,15 @@ Create TanStack React Router bridge
71
71
 
72
72
  | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
73
73
  | --------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
74
- | <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) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L102) |
75
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L90) |
76
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L89) |
77
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L92) |
78
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L91) |
79
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L103) |
80
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L105) |
81
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L104) |
82
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L93) |
74
+ | <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) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L102) |
75
+ | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L90) |
76
+ | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L89) |
77
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L92) |
78
+ | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L91) |
79
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L103) |
80
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L105) |
81
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L104) |
82
+ | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L93) |
83
83
 
84
84
  ## Methods
85
85
 
@@ -89,7 +89,7 @@ Create TanStack React Router bridge
89
89
  connect(): void;
90
90
  ```
91
91
 
92
- Defined in: [play-router/src/router-bridge-base.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L129)
92
+ Defined in: [play-router/src/router-bridge-base.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L129)
93
93
 
94
94
  Connect the router bridge to the Actor.
95
95
 
@@ -121,7 +121,7 @@ Adapters that need custom initial-sync behavior should override
121
121
  disconnect(): void;
122
122
  ```
123
123
 
124
- Defined in: [play-router/src/router-bridge-base.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L197)
124
+ Defined in: [play-router/src/router-bridge-base.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L197)
125
125
 
126
126
  Disconnect the router bridge from the Actor.
127
127
 
@@ -143,7 +143,7 @@ Stops signal watching and unregisters framework-specific router listener.
143
143
  protected extractParams(pathname, stateId): Record<string, string>;
144
144
  ```
145
145
 
146
- Defined in: [play-router/src/router-bridge-base.ts:300](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L300)
146
+ Defined in: [play-router/src/router-bridge-base.ts:300](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L300)
147
147
 
148
148
  Extract path parameters from URL using the URLPattern API.
149
149
 
@@ -177,7 +177,7 @@ Extracted path parameters, or empty object if URLPattern is unavailable or no ma
177
177
  protected extractQuery(search): Record<string, string>;
178
178
  ```
179
179
 
180
- Defined in: [play-router/src/router-bridge-base.ts:321](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L321)
180
+ Defined in: [play-router/src/router-bridge-base.ts:321](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L321)
181
181
 
182
182
  Extract query parameters from URL search string.
183
183
 
@@ -205,7 +205,7 @@ Extracted query parameters or empty object
205
205
  protected getInitialRouterPath(): string | null;
206
206
  ```
207
207
 
208
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L123)
208
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L123)
209
209
 
210
210
  Read the router's current pathname for initial sync.
211
211
 
@@ -240,7 +240,7 @@ The base class `connect()` uses `actor.initialRoute` to distinguish:
240
240
  protected navigateRouter(path): void;
241
241
  ```
242
242
 
243
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L102)
243
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L102)
244
244
 
245
245
  Navigate the framework router to the given path.
246
246
 
@@ -269,7 +269,7 @@ Must trigger the framework router's navigation (e.g., router.navigate(path)).
269
269
  protected syncActorFromRouter(pathname, search?): void;
270
270
  ```
271
271
 
272
- Defined in: [play-router/src/router-bridge-base.ts:248](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L248)
272
+ Defined in: [play-router/src/router-bridge-base.ts:248](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L248)
273
273
 
274
274
  Sync actor state when router location changes.
275
275
 
@@ -299,7 +299,7 @@ Prevents circular updates via isProcessingNavigation flag.
299
299
  protected syncRouterFromActor(route): void;
300
300
  ```
301
301
 
302
- Defined in: [play-router/src/router-bridge-base.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L228)
302
+ Defined in: [play-router/src/router-bridge-base.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L228)
303
303
 
304
304
  Sync router location when actor route signal changes.
305
305
 
@@ -332,7 +332,7 @@ suppressed as circular echoes.
332
332
  protected unwatchRouterChanges(): void;
333
333
  ```
334
334
 
335
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L148)
335
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L148)
336
336
 
337
337
  Stop watching for router location changes.
338
338
 
@@ -354,7 +354,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
354
354
  protected watchRouterChanges(): void;
355
355
  ```
356
356
 
357
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:140](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L140)
357
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:140](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L140)
358
358
 
359
359
  Subscribe to ALL navigation events via router.history.
360
360