@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
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: BaseRouteMap
4
4
 
5
- Defined in: [base-route-map.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/base-route-map.ts#L99)
5
+ Defined in: [base-route-map.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/base-route-map.ts#L99)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -45,6 +45,8 @@ map.getPathByStateId("missing"); // null
45
45
 
46
46
  - [`RouteMap`](../../play-react-router/classes/RouteMap.md)
47
47
  - [`RouteMap`](../../play-solid-router/classes/RouteMap.md)
48
+ - [`RouteMap`](../../play-sveltekit-router/classes/RouteMap.md)
49
+ - [`RouteMap`](../../play-svelte-spa-router/classes/RouteMap.md)
48
50
  - [`RouteMap`](../../play-tanstack-react-router/classes/RouteMap.md)
49
51
  - [`RouteMap`](../../play-tanstack-solid-router/classes/RouteMap.md)
50
52
  - [`VueBaseRouteMap`](../../play-vue-router/classes/VueBaseRouteMap.md)
@@ -57,7 +59,7 @@ map.getPathByStateId("missing"); // null
57
59
  new BaseRouteMap(mappings): BaseRouteMap;
58
60
  ```
59
61
 
60
- Defined in: [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)
62
+ Defined in: [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)
61
63
 
62
64
  Build a route map from an array of state ID ↔ path mappings.
63
65
 
@@ -83,7 +85,7 @@ buckets for efficient candidate selection.
83
85
  getPathByStateId(stateId): string | null;
84
86
  ```
85
87
 
86
- Defined in: [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)
88
+ Defined in: [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)
87
89
 
88
90
  Look up the path pattern registered for a state ID.
89
91
 
@@ -114,7 +116,7 @@ map.getPathByStateId("missing"); // null
114
116
  getStateIdByPath(path): string | null;
115
117
  ```
116
118
 
117
- Defined in: [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)
119
+ Defined in: [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)
118
120
 
119
121
  Resolve a URL path to its mapped state ID.
120
122
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Abstract Class: RouterBridgeBase
4
4
 
5
- Defined in: [router-bridge-base.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L87)
5
+ Defined in: [router-bridge-base.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L87)
6
6
 
7
7
  Abstract base class for all `@xmachines` router adapter bridges.
8
8
 
@@ -30,7 +30,7 @@ between frameworks.
30
30
  new RouterBridgeBase(actor, routeMap): RouterBridgeBase;
31
31
  ```
32
32
 
33
- Defined in: [router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L101)
33
+ Defined in: [router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L101)
34
34
 
35
35
  #### Parameters
36
36
 
@@ -49,15 +49,15 @@ Defined in: [router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-
49
49
 
50
50
  | Property | Modifier | Type | Default value | Description | Defined in |
51
51
  | --------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
52
- | <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`. | [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) |
53
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [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) |
54
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [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) |
55
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [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) |
56
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [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) |
57
- | <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. | [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) |
58
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [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) |
59
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [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) |
60
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | [`RouteWatcherHandle`](../interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [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) |
52
+ | <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`. | [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) |
53
+ | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [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) |
54
+ | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [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) |
55
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [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) |
56
+ | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [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) |
57
+ | <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. | [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) |
58
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [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) |
59
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [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) |
60
+ | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | [`RouteWatcherHandle`](../interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [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) |
61
61
 
62
62
  ## Methods
63
63
 
@@ -67,7 +67,7 @@ Defined in: [router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-
67
67
  connect(): void;
68
68
  ```
69
69
 
70
- Defined in: [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)
70
+ Defined in: [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)
71
71
 
72
72
  Connect the router bridge to the Actor.
73
73
 
@@ -99,7 +99,7 @@ Adapters that need custom initial-sync behavior should override
99
99
  disconnect(): void;
100
100
  ```
101
101
 
102
- Defined in: [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)
102
+ Defined in: [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)
103
103
 
104
104
  Disconnect the router bridge from the Actor.
105
105
 
@@ -121,7 +121,7 @@ Stops signal watching and unregisters framework-specific router listener.
121
121
  protected extractParams(pathname, stateId): Record<string, string>;
122
122
  ```
123
123
 
124
- Defined in: [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)
124
+ Defined in: [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)
125
125
 
126
126
  Extract path parameters from URL using the URLPattern API.
127
127
 
@@ -151,7 +151,7 @@ Extracted path parameters, or empty object if URLPattern is unavailable or no ma
151
151
  protected extractQuery(search): Record<string, string>;
152
152
  ```
153
153
 
154
- Defined in: [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)
154
+ Defined in: [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)
155
155
 
156
156
  Extract query parameters from URL search string.
157
157
 
@@ -175,7 +175,7 @@ Extracted query parameters or empty object
175
175
  protected getInitialRouterPath(): string | null | undefined;
176
176
  ```
177
177
 
178
- Defined in: [router-bridge-base.ts:368](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L368)
178
+ Defined in: [router-bridge-base.ts:368](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L368)
179
179
 
180
180
  Return the router's current pathname at connect() time.
181
181
 
@@ -207,7 +207,7 @@ bridges that have not yet implemented this hook.
207
207
  abstract protected navigateRouter(path): void;
208
208
  ```
209
209
 
210
- Defined in: [router-bridge-base.ts:333](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L333)
210
+ Defined in: [router-bridge-base.ts:333](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L333)
211
211
 
212
212
  Navigate the framework router to the given path.
213
213
 
@@ -232,7 +232,7 @@ Must trigger the framework router's navigation (e.g., router.navigate(path)).
232
232
  protected syncActorFromRouter(pathname, search?): void;
233
233
  ```
234
234
 
235
- Defined in: [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)
235
+ Defined in: [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)
236
236
 
237
237
  Sync actor state when router location changes.
238
238
 
@@ -258,7 +258,7 @@ Prevents circular updates via isProcessingNavigation flag.
258
258
  protected syncRouterFromActor(route): void;
259
259
  ```
260
260
 
261
- Defined in: [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)
261
+ Defined in: [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)
262
262
 
263
263
  Sync router location when actor route signal changes.
264
264
 
@@ -287,7 +287,7 @@ suppressed as circular echoes.
287
287
  abstract protected unwatchRouterChanges(): void;
288
288
  ```
289
289
 
290
- Defined in: [router-bridge-base.ts:348](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L348)
290
+ Defined in: [router-bridge-base.ts:348](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L348)
291
291
 
292
292
  Stop watching for router location changes.
293
293
 
@@ -305,7 +305,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
305
305
  abstract protected watchRouterChanges(): void;
306
306
  ```
307
307
 
308
- Defined in: [router-bridge-base.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L341)
308
+ Defined in: [router-bridge-base.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L341)
309
309
 
310
310
  Start watching for router location changes.
311
311
 
@@ -9,7 +9,7 @@ function buildPlayRouteEvent(options): {
9
9
  } | null;
10
10
  ```
11
11
 
12
- Defined in: [router-sync.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-sync.ts#L93)
12
+ Defined in: [router-sync.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-sync.ts#L93)
13
13
 
14
14
  Build a normalized `play.route` event from raw router/browser input.
15
15
 
@@ -6,7 +6,7 @@
6
6
  function buildRouteTree(routes): RouteTree;
7
7
  ```
8
8
 
9
- Defined in: [build-tree.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/build-tree.ts#L13)
9
+ Defined in: [build-tree.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/build-tree.ts#L13)
10
10
 
11
11
  Build hierarchical route tree from flat route list
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(routeTree): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [create-route-map.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/create-route-map.ts#L74)
9
+ Defined in: [create-route-map.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/create-route-map.ts#L74)
10
10
 
11
11
  Create a RouteMap from a RouteTree for efficient path lookups.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function detectDuplicateRoutes(routes): void;
7
7
  ```
8
8
 
9
- Defined in: [validate-routes.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/validate-routes.ts#L51)
9
+ Defined in: [validate-routes.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/validate-routes.ts#L51)
10
10
 
11
11
  Detect duplicate route paths
12
12
 
@@ -6,7 +6,7 @@
6
6
  function extractMachineRoutes(machine): RouteTree;
7
7
  ```
8
8
 
9
- Defined in: [extract-routes.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/extract-routes.ts#L93)
9
+ Defined in: [extract-routes.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/extract-routes.ts#L93)
10
10
 
11
11
  Extract complete route tree from state machine graph
12
12
 
@@ -6,7 +6,7 @@
6
6
  function extractQuery(search): Record<string, string>;
7
7
  ```
8
8
 
9
- Defined in: [router-sync.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-sync.ts#L74)
9
+ Defined in: [router-sync.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-sync.ts#L74)
10
10
 
11
11
  Parse a URL search string into the plain object shape expected by
12
12
  `play.route` events.
@@ -6,7 +6,7 @@
6
6
  function findRouteById(tree, id): RouteNode | undefined;
7
7
  ```
8
8
 
9
- Defined in: [find-route.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/find-route.ts#L52)
9
+ Defined in: [find-route.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/find-route.ts#L52)
10
10
 
11
11
  Find route node by state ID
12
12
 
@@ -6,7 +6,7 @@
6
6
  function findRouteByPath(tree, path): RouteNode | undefined;
7
7
  ```
8
8
 
9
- Defined in: [find-route.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/find-route.ts#L77)
9
+ Defined in: [find-route.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/find-route.ts#L77)
10
10
 
11
11
  Find route node by URL path
12
12
 
@@ -6,7 +6,7 @@
6
6
  function getNavigableRoutes(tree, stateId): RouteNode[];
7
7
  ```
8
8
 
9
- Defined in: [query.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/query.ts#L22)
9
+ Defined in: [query.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/query.ts#L22)
10
10
 
11
11
  Get all routes navigable from given state
12
12
 
@@ -6,7 +6,7 @@
6
6
  function getRoutableRoutes(tree): RouteNode[];
7
7
  ```
8
8
 
9
- Defined in: [query.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/query.ts#L67)
9
+ Defined in: [query.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/query.ts#L67)
10
10
 
11
11
  Get all routable routes from tree as flat array
12
12
 
@@ -6,7 +6,7 @@
6
6
  function getTransitionReachableRoutes(graph, stateId): string[];
7
7
  ```
8
8
 
9
- Defined in: [query.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/query.ts#L113)
9
+ Defined in: [query.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/query.ts#L113)
10
10
 
11
11
  Get routes reachable via transitions from current state
12
12
 
@@ -6,7 +6,7 @@
6
6
  function isRouteReachable(graph, fromStateId, toStateId): boolean;
7
7
  ```
8
8
 
9
- Defined in: [query.ts:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/query.ts#L149)
9
+ Defined in: [query.ts:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/query.ts#L149)
10
10
 
11
11
  Check if a route is reachable from current state via transitions
12
12
 
@@ -6,7 +6,7 @@
6
6
  function machineToGraph(machine): MachineGraph;
7
7
  ```
8
8
 
9
- Defined in: [machine-to-graph.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/machine-to-graph.ts#L70)
9
+ Defined in: [machine-to-graph.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/machine-to-graph.ts#L70)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  function routeExists(tree, path): boolean;
7
7
  ```
8
8
 
9
- Defined in: [query.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/query.ts#L89)
9
+ Defined in: [query.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/query.ts#L89)
10
10
 
11
11
  Validate route path exists in tree
12
12
 
@@ -6,7 +6,7 @@
6
6
  function sanitizePathname(pathname): string | null;
7
7
  ```
8
8
 
9
- Defined in: [router-sync.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-sync.ts#L63)
9
+ Defined in: [router-sync.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-sync.ts#L63)
10
10
 
11
11
  Normalize a pathname before route-map lookup.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function validateRouteFormat(routePath, stateId): void;
7
7
  ```
8
8
 
9
- Defined in: [validate-routes.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/validate-routes.ts#L14)
9
+ Defined in: [validate-routes.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/validate-routes.ts#L14)
10
10
 
11
11
  Validate route path format
12
12
 
@@ -6,7 +6,7 @@
6
6
  function validateStateExists(stateId, stateIds): void;
7
7
  ```
8
8
 
9
- Defined in: [validate-routes.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/validate-routes.ts#L32)
9
+ Defined in: [validate-routes.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/validate-routes.ts#L32)
10
10
 
11
11
  Validate state exists in state ID set
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BaseRouteMapping
4
4
 
5
- Defined in: [base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/base-route-map.ts#L57)
5
+ Defined in: [base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/base-route-map.ts#L57)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: BaseRouteMapping = { stateId: "settings", path: "/setting
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/base-route-map.ts#L61) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/base-route-map.ts#L59) |
26
+ | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/base-route-map.ts#L61) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/base-route-map.ts#L59) |
@@ -2,12 +2,12 @@
2
2
 
3
3
  # Interface: BuildPlayRouteEventOptions
4
4
 
5
- Defined in: [router-sync.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-sync.ts#L8)
5
+ Defined in: [router-sync.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-sync.ts#L8)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Type | Defined in |
10
10
  | ----------------------------------------- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-pathname"></a> `pathname` | `string` | [router-sync.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-sync.ts#L9) |
12
- | <a id="property-resolve"></a> `resolve` | (`sanitizedPathname`) => [`RouteMatch`](RouteMatch.md) | [router-sync.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-sync.ts#L11) |
13
- | <a id="property-search"></a> `search?` | `string` | [router-sync.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-sync.ts#L10) |
11
+ | <a id="property-pathname"></a> `pathname` | `string` | [router-sync.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-sync.ts#L9) |
12
+ | <a id="property-resolve"></a> `resolve` | (`sanitizedPathname`) => [`RouteMatch`](RouteMatch.md) | [router-sync.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-sync.ts#L11) |
13
+ | <a id="property-search"></a> `search?` | `string` | [router-sync.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-sync.ts#L10) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: MachineEdgeData
4
4
 
5
- Defined in: [types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L22)
5
+ Defined in: [types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L22)
6
6
 
7
7
  Data attached to each edge in the machine graph representation.
8
8
  Captures transition event and guard information.
@@ -11,5 +11,5 @@ Captures transition event and guard information.
11
11
 
12
12
  | Property | Type | Description | Defined in |
13
13
  | -------------------------------------------- | -------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
14
- | <a id="property-eventtype"></a> `eventType` | `string` | The event type that triggers this transition | [types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L24) |
15
- | <a id="property-guardtype"></a> `guardType?` | `string` | String representation of guard (if any) | [types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L26) |
14
+ | <a id="property-eventtype"></a> `eventType` | `string` | The event type that triggers this transition | [types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L24) |
15
+ | <a id="property-guardtype"></a> `guardType?` | `string` | String representation of guard (if any) | [types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L26) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: MachineNodeData
4
4
 
5
- Defined in: [types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L7)
5
+ Defined in: [types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L7)
6
6
 
7
7
  Data attached to each node in the machine graph representation.
8
8
  Captures the essential state metadata needed for route extraction and queries.
@@ -11,7 +11,7 @@ Captures the essential state metadata needed for route extraction and queries.
11
11
 
12
12
  | Property | Type | Description | Defined in |
13
13
  | --------------------------------------- | ---------------------------------------------------------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
14
- | <a id="property-meta"></a> `meta?` | `Record`\<`string`, `unknown`\> | Original state meta object | [types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L13) |
15
- | <a id="property-route"></a> `route?` | `string` | Extracted route path from meta.route (string form) | [types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L15) |
16
- | <a id="property-stateid"></a> `stateId` | `string` | XState state ID (e.g., "test.dashboard.overview") | [types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L9) |
17
- | <a id="property-type"></a> `type` | `"atomic"` \| `"compound"` \| `"parallel"` \| `"final"` \| `"history"` | State type from XState | [types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L11) |
14
+ | <a id="property-meta"></a> `meta?` | `Record`\<`string`, `unknown`\> | Original state meta object | [types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L13) |
15
+ | <a id="property-route"></a> `route?` | `string` | Extracted route path from meta.route (string form) | [types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L15) |
16
+ | <a id="property-stateid"></a> `stateId` | `string` | XState state ID (e.g., "test.dashboard.overview") | [types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L9) |
17
+ | <a id="property-type"></a> `type` | `"atomic"` \| `"compound"` \| `"parallel"` \| `"final"` \| `"history"` | State type from XState | [types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L11) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [types.ts:216](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L216)
5
+ Defined in: [types.ts:216](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L216)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -112,8 +112,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
112
112
 
113
113
  | Property | Modifier | Type | Defined in |
114
114
  | -------------------------------------- | ---------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
115
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L221) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L219) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [types.ts:220](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L220) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [types.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L218) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [types.ts:217](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L217) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L221) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L219) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [types.ts:220](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L220) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [types.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L218) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [types.ts:217](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L217) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteInfo
4
4
 
5
- Defined in: [types.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L54)
5
+ Defined in: [types.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L54)
6
6
 
7
7
  Extracted route information from a state node
8
8
 
@@ -10,10 +10,10 @@ Extracted route information from a state node
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | --------------------------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-isabsolute"></a> `isAbsolute` | `boolean` | Whether route path is absolute (starts with /) | [types.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L64) |
14
- | <a id="property-metadata"></a> `metadata` | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | Original route metadata | [types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L71) |
15
- | <a id="property-pattern"></a> `pattern?` | `string` | Route pattern with parameters (e.g., /profile/:userId) if routePath contains params | [types.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L62) |
16
- | <a id="property-routable"></a> `routable` | `boolean` | Whether this state is routable (has meta.route) true = has meta.route, can receive play.route events | [types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L69) |
17
- | <a id="property-routepath"></a> `routePath` | `string` | Route path extracted from meta.route | [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L60) |
18
- | <a id="property-stateid"></a> `stateId` | `string` | State identifier (node.id or path.join('.')) | [types.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L56) |
19
- | <a id="property-statepath"></a> `statePath` | `string`[] | State path segments from root | [types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L58) |
13
+ | <a id="property-isabsolute"></a> `isAbsolute` | `boolean` | Whether route path is absolute (starts with /) | [types.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L64) |
14
+ | <a id="property-metadata"></a> `metadata` | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | Original route metadata | [types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L71) |
15
+ | <a id="property-pattern"></a> `pattern?` | `string` | Route pattern with parameters (e.g., /profile/:userId) if routePath contains params | [types.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L62) |
16
+ | <a id="property-routable"></a> `routable` | `boolean` | Whether this state is routable (has meta.route) true = has meta.route, can receive play.route events | [types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L69) |
17
+ | <a id="property-routepath"></a> `routePath` | `string` | Route path extracted from meta.route | [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L60) |
18
+ | <a id="property-stateid"></a> `stateId` | `string` | State identifier (node.id or path.join('.')) | [types.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L56) |
19
+ | <a id="property-statepath"></a> `statePath` | `string`[] | State path segments from root | [types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L58) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMap
4
4
 
5
- Defined in: [create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/create-route-map.ts#L20)
5
+ Defined in: [create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/create-route-map.ts#L20)
6
6
 
7
7
  Bidirectional route resolution interface returned by `createRouteMap()`.
8
8
 
@@ -23,7 +23,7 @@ events into `play.route` actor events.
23
23
  resolve(path): object;
24
24
  ```
25
25
 
26
- Defined in: [create-route-map.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/create-route-map.ts#L37)
26
+ Defined in: [create-route-map.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/create-route-map.ts#L37)
27
27
 
28
28
  Resolve a URL path to a state ID and params.
29
29
 
@@ -52,5 +52,5 @@ if (to) {
52
52
 
53
53
  | Name | Type | Defined in |
54
54
  | -------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
55
- | `params` | `Record`\<`string`, `string`\> | [create-route-map.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/create-route-map.ts#L39) |
56
- | `to` | `string` \| `null` | [create-route-map.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/create-route-map.ts#L38) |
55
+ | `params` | `Record`\<`string`, `string`\> | [create-route-map.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/create-route-map.ts#L39) |
56
+ | `to` | `string` \| `null` | [create-route-map.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/create-route-map.ts#L38) |
@@ -2,11 +2,11 @@
2
2
 
3
3
  # Interface: RouteMatch
4
4
 
5
- Defined in: [router-sync.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-sync.ts#L3)
5
+ Defined in: [router-sync.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-sync.ts#L3)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Type | Defined in |
10
10
  | -------------------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-params"></a> `params?` | `Record`\<`string`, `string`\> | [router-sync.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-sync.ts#L5) |
12
- | <a id="property-to"></a> `to` | `string` \| `null` \| `undefined` | [router-sync.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-sync.ts#L4) |
11
+ | <a id="property-params"></a> `params?` | `Record`\<`string`, `string`\> | [router-sync.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-sync.ts#L5) |
12
+ | <a id="property-to"></a> `to` | `string` \| `null` \| `undefined` | [router-sync.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-sync.ts#L4) |