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

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 (324) hide show
  1. package/api/@xmachines/play/README.md +1 -1
  2. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  3. package/api/@xmachines/play/classes/PlayError.md +4 -4
  4. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +3 -3
  6. package/api/@xmachines/play-actor/README.md +2 -2
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  9. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  10. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  11. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  12. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  13. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  14. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  15. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  16. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  17. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  18. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  19. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  20. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  21. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +13 -13
  22. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +6 -6
  23. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  24. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +12 -12
  25. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  26. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  27. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +5 -5
  28. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +5 -5
  29. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  31. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  32. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  36. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  41. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  42. package/api/@xmachines/play-dom-router/README.md +1 -0
  43. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  44. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  45. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +8 -7
  46. package/api/@xmachines/play-dom-router/functions/createRouter.md +2 -2
  47. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  48. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  49. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  50. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  51. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  52. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  53. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +13 -0
  54. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  55. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +4 -4
  56. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  57. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  58. package/api/@xmachines/play-react/README.md +1 -1
  59. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  60. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  61. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  62. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  63. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  64. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  65. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  66. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  67. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  68. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  69. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  70. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  71. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  72. package/api/@xmachines/play-react-router/README.md +1 -0
  73. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +33 -29
  74. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  75. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  76. package/api/@xmachines/play-react-router/functions/createRouteMap.md +24 -6
  77. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +11 -10
  78. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  79. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  80. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +13 -0
  81. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  82. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +4 -4
  83. package/api/@xmachines/play-router/README.md +9 -8
  84. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  85. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +37 -33
  86. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  87. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  88. package/api/@xmachines/play-router/functions/createRouteMap.md +21 -35
  89. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +11 -10
  90. package/api/@xmachines/play-router/functions/createRouteMatcher.md +53 -0
  91. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  92. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  93. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  94. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  95. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  96. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  97. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  98. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  99. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  100. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  101. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  102. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  103. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  104. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  105. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  106. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  107. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  108. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  109. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  110. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +7 -7
  111. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  112. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +13 -0
  113. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  114. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  115. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +8 -8
  116. package/api/@xmachines/play-router/interfaces/RouteNode.md +12 -12
  117. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  118. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  119. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  120. package/api/@xmachines/play-router/interfaces/RouterBridge.md +4 -4
  121. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  122. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  123. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  124. package/api/@xmachines/play-signals/README.md +2 -2
  125. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  126. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  127. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  128. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  129. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  130. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  131. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  132. package/api/@xmachines/play-solid/README.md +1 -1
  133. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  134. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  135. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  136. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  137. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  138. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  139. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  140. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  141. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  142. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  143. package/api/@xmachines/play-solid-router/README.md +2 -1
  144. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  145. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +34 -30
  146. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  147. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +8 -7
  148. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  149. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  150. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  151. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +13 -0
  152. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  153. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +4 -4
  154. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  155. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  156. package/api/@xmachines/play-svelte/README.md +1 -0
  157. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  158. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  159. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  160. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  161. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +12 -8
  162. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  163. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +43 -0
  164. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  165. package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +1 -1
  166. package/api/@xmachines/play-svelte-spa-router/README.md +1 -0
  167. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  168. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  169. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +8 -7
  170. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  171. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  172. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +13 -0
  173. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  174. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +4 -4
  175. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  176. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  177. package/api/@xmachines/play-sveltekit-router/README.md +1 -0
  178. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  179. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  180. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +8 -7
  181. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  182. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  183. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  184. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +13 -0
  185. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  186. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +4 -4
  187. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  188. package/api/@xmachines/play-tanstack-react-router/README.md +1 -0
  189. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  190. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +33 -29
  191. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  192. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +24 -6
  193. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +11 -10
  194. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  195. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  196. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  197. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +13 -0
  198. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  199. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  200. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +4 -4
  201. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  202. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  203. package/api/@xmachines/play-tanstack-solid-router/README.md +2 -1
  204. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  205. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +34 -30
  206. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  207. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +8 -7
  208. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  209. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  210. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +13 -0
  211. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  212. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +4 -4
  213. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  214. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  215. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  216. package/api/@xmachines/play-vue/README.md +2 -1
  217. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  218. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  219. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  220. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  221. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  222. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  223. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +5 -0
  224. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  225. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  226. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  227. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  228. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  229. package/api/@xmachines/play-vue-router/README.md +2 -1
  230. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  231. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +40 -30
  232. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +25 -5
  233. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +7 -7
  234. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +13 -0
  235. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  236. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +4 -4
  237. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  238. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  239. package/api/@xmachines/play-xstate/README.md +1 -1
  240. package/api/@xmachines/play-xstate/classes/PlayerActor.md +13 -13
  241. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  242. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  243. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  244. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +4 -2
  245. package/api/@xmachines/play-xstate/functions/definePlayer.md +2 -2
  246. package/api/@xmachines/play-xstate/functions/deriveRoute.md +2 -2
  247. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  248. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  249. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  250. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  251. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  252. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  253. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  254. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  255. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  256. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  257. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  258. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  259. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  260. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  261. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  262. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  263. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  264. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  265. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  266. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  267. package/api/llms.txt +2 -2
  268. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  269. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  270. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  271. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  272. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  273. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  274. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  275. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  276. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  277. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  278. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  279. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  280. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  281. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  282. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  283. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  284. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  285. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  286. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  287. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  288. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  289. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  290. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  291. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  292. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  293. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  294. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  295. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  296. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  297. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  298. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  299. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  300. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  301. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  302. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  303. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  304. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  305. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  306. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  307. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  308. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  309. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  310. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  311. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  312. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  313. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  314. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  315. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  316. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  317. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  318. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  319. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  320. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  321. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  322. package/package.json +2 -2
  323. package/rfc/play.md +1 -1
  324. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +0 -38
@@ -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.43/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.44/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:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-sync.ts#L121)
9
+ Defined in: [router-sync.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L121)
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 extractRouteParams(pathname, pattern): Record<string, string>;
7
7
  ```
8
8
 
9
- Defined in: [router-sync.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-sync.ts#L101)
9
+ Defined in: [router-sync.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L101)
10
10
 
11
11
  Extract named path parameters from a URL using the URLPattern API.
12
12
 
@@ -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.43/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.44/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.43/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.44/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.43/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.44/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.43/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.44/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.43/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.44/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.43/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.44/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:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/machine-to-graph.ts#L71)
9
+ Defined in: [machine-to-graph.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/machine-to-graph.ts#L71)
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.43/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.44/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:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-sync.ts#L69)
9
+ Defined in: [router-sync.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L69)
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:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/validate-routes.ts#L15)
9
+ Defined in: [validate-routes.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/validate-routes.ts#L15)
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:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/validate-routes.ts#L31)
9
+ Defined in: [validate-routes.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/validate-routes.ts#L31)
10
10
 
11
11
  Validate state exists in state ID set
12
12
 
@@ -2,12 +2,12 @@
2
2
 
3
3
  # Interface: BuildPlayRouteEventOptions
4
4
 
5
- Defined in: [router-sync.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-sync.ts#L14)
5
+ Defined in: [router-sync.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L14)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Type | Defined in |
10
10
  | ----------------------------------------- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-match"></a> `match` | (`sanitizedPathname`) => [`RouteMatch`](RouteMatch.md) | [router-sync.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-sync.ts#L17) |
12
- | <a id="property-pathname"></a> `pathname` | `string` | [router-sync.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-sync.ts#L15) |
13
- | <a id="property-search"></a> `search?` | `string` | [router-sync.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-sync.ts#L16) |
11
+ | <a id="property-match"></a> `match` | (`sanitizedPathname`) => [`RouteMatch`](RouteMatch.md) | [router-sync.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L17) |
12
+ | <a id="property-pathname"></a> `pathname` | `string` | [router-sync.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L15) |
13
+ | <a id="property-search"></a> `search?` | `string` | [router-sync.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L16) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: LocationLike
4
4
 
5
- Defined in: [types.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L344)
5
+ Defined in: [types.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L344)
6
6
 
7
7
  Minimal location interface required by adapters that read the current URL at
8
8
  `connect()` time. Injectable for SSR and testing — pass a mock instead of the
@@ -23,5 +23,5 @@ connectRouter({ actor, routeMap, location: mockLoc });
23
23
 
24
24
  | Property | Modifier | Type | Defined in |
25
25
  | ----------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [types.ts:345](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L345) |
27
- | <a id="property-search"></a> `search` | `readonly` | `string` | [types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L346) |
26
+ | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [types.ts:345](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L345) |
27
+ | <a id="property-search"></a> `search` | `readonly` | `string` | [types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L346) |
@@ -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.43/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.44/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.43/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.43/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.44/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.44/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.43/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.44/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.43/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.43/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.43/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.43/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.44/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.44/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.44/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.44/packages/play-router/src/types.ts#L11) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L223)
5
+ Defined in: [types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L223)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -94,7 +94,7 @@ actor.send(event);
94
94
 
95
95
  ## See
96
96
 
97
- [Play RFC](../../docs/rfc/play.md)
97
+ [Play RFC](../../../../rfc/play.md)
98
98
 
99
99
  ## Remarks
100
100
 
@@ -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:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L228) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L226) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L227) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L225) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L224) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L228) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L226) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L227) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L225) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L224) |
@@ -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.43/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.44/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.43/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.43/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.43/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.43/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.43/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.43/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.43/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.44/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.44/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.44/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.44/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.44/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.44/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.44/packages/play-router/src/types.ts#L58) |
@@ -0,0 +1,13 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMapOptions
2
+
3
+ # Interface: RouteMapOptions
4
+
5
+ Defined in: [create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/create-route-map.ts#L9)
6
+
7
+ Options for `createRouteMap` and `createRouteMapFromTree`.
8
+
9
+ ## Properties
10
+
11
+ | Property | Type | Description | Defined in |
12
+ | -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
13
+ | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/create-route-map.ts#L20) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/base-route-map.ts#L57)
5
+ Defined in: [base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/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: RouteMapping = { stateId: "settings", path: "/settings/:s
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.43/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.43/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.44/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.44/packages/play-router/src/base-route-map.ts#L59) |
@@ -2,11 +2,11 @@
2
2
 
3
3
  # Interface: RouteMatch
4
4
 
5
- Defined in: [router-sync.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-sync.ts#L9)
5
+ Defined in: [router-sync.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L9)
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:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-sync.ts#L11) |
12
- | <a id="property-to"></a> `to` | `string` \| `null` \| `undefined` | [router-sync.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-sync.ts#L10) |
11
+ | <a id="property-params"></a> `params?` | `Record`\<`string`, `string`\> | [router-sync.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L11) |
12
+ | <a id="property-to"></a> `to` | `string` \| `null` \| `undefined` | [router-sync.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-sync.ts#L10) |
@@ -2,9 +2,9 @@
2
2
 
3
3
  # Interface: RouteMatcher
4
4
 
5
- Defined in: [create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/create-route-map.ts#L20)
5
+ Defined in: [create-route-matcher.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/create-route-matcher.ts#L20)
6
6
 
7
- URL route matcher interface returned by `createRouteMap()`.
7
+ URL route matcher interface returned by `createRouteMatcher()`.
8
8
 
9
9
  Matches incoming URL paths to state IDs (with `#` prefix) and extracts
10
10
  route parameters. Used by `RouterBridgeBase` to translate router navigation
@@ -12,7 +12,7 @@ events into `play.route` actor events.
12
12
 
13
13
  ## See
14
14
 
15
- - [createRouteMap](../functions/createRouteMap.md) for the factory function
15
+ - [createRouteMatcher](../functions/createRouteMatcher.md) for the factory function
16
16
  - [RouteMap](../classes/RouteMap.md) for direct state ID ↔ path lookups without params extraction
17
17
 
18
18
  ## Methods
@@ -23,7 +23,7 @@ events into `play.route` actor events.
23
23
  match(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.43/packages/play-router/src/create-route-map.ts#L37)
26
+ Defined in: [create-route-matcher.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/create-route-matcher.ts#L37)
27
27
 
28
28
  Match a URL path to a state ID and params.
29
29
 
@@ -50,7 +50,7 @@ if (to) {
50
50
  }
51
51
  ```
52
52
 
53
- | Name | Type | Defined in |
54
- | -------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
55
- | `params` | `Record`\<`string`, `string`\> | [create-route-map.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/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.43/packages/play-router/src/create-route-map.ts#L38) |
53
+ | Name | Type | Defined in |
54
+ | -------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
55
+ | `params` | `Record`\<`string`, `string`\> | [create-route-matcher.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/create-route-matcher.ts#L39) |
56
+ | `to` | `string` \| `null` | [create-route-matcher.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/create-route-matcher.ts#L38) |
@@ -2,20 +2,20 @@
2
2
 
3
3
  # Interface: RouteNode
4
4
 
5
- Defined in: [types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L77)
5
+ Defined in: [types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L77)
6
6
 
7
7
  Node in the route tree representing a single route
8
8
 
9
9
  ## Properties
10
10
 
11
- | Property | Type | Description | Defined in |
12
- | ----------------------------------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-children"></a> `children` | `RouteNode`[] | Child routes | [types.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L101) |
14
- | <a id="property-fullpath"></a> `fullPath` | `string` | The fully resolved absolute path from the root (e.g. `"/dashboard/overview"`). Always use `fullPath` for browser URL matching and route map construction. `createRouteMapFromTree` and `createRouteMapFromMachine` both use this field. | [types.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L90) |
15
- | <a id="property-id"></a> `id` | `string` | Unique identifier (state ID) | [types.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L79) |
16
- | <a id="property-metadata"></a> `metadata` | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | Original meta.route metadata | [types.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L105) |
17
- | <a id="property-parent"></a> `parent` | `RouteNode` \| `null` | Parent route (null for root) | [types.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L103) |
18
- | <a id="property-path"></a> `path` | `string` | The raw route path segment as declared in `meta.route` — may be relative (e.g. `"overview"`) or absolute (e.g. `"/dashboard"`). Do not use this for URL matching; use `fullPath` instead. | [types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L84) |
19
- | <a id="property-pattern"></a> `pattern?` | `string` | Route pattern with parameters (e.g., /profile/:userId) if path contains params | [types.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L92) |
20
- | <a id="property-routable"></a> `routable` | `boolean` | Whether this state is routable (has meta.route) States with meta.route can receive play.route events | [types.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L99) |
21
- | <a id="property-stateid"></a> `stateId` | `string` | XState state ID this route maps to | [types.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L94) |
11
+ | Property | Type | Description | Defined in |
12
+ | ----------------------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
13
+ | <a id="property-children"></a> `children` | `RouteNode`[] | Child routes | [types.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L101) |
14
+ | <a id="property-fullpath"></a> `fullPath` | `string` | The fully resolved absolute path from the root (e.g. `"/dashboard/overview"`). Always use `fullPath` for browser URL matching and route map construction. `createRouteMapFromTree` and `createRouteMap` both use this field. | [types.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L90) |
15
+ | <a id="property-id"></a> `id` | `string` | Unique identifier (state ID) | [types.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L79) |
16
+ | <a id="property-metadata"></a> `metadata` | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | Original meta.route metadata | [types.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L105) |
17
+ | <a id="property-parent"></a> `parent` | `RouteNode` \| `null` | Parent route (null for root) | [types.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L103) |
18
+ | <a id="property-path"></a> `path` | `string` | The raw route path segment as declared in `meta.route` — may be relative (e.g. `"overview"`) or absolute (e.g. `"/dashboard"`). Do not use this for URL matching; use `fullPath` instead. | [types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L84) |
19
+ | <a id="property-pattern"></a> `pattern?` | `string` | Route pattern with parameters (e.g., /profile/:userId) if path contains params | [types.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L92) |
20
+ | <a id="property-routable"></a> `routable` | `boolean` | Whether this state is routable (has meta.route) States with meta.route can receive play.route events | [types.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L99) |
21
+ | <a id="property-stateid"></a> `stateId` | `string` | XState state ID this route maps to | [types.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L94) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteObject
4
4
 
5
- Defined in: [types.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L39)
5
+ Defined in: [types.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L39)
6
6
 
7
7
  Route object with additional metadata.
8
8
 
@@ -18,4 +18,4 @@ Additional route metadata (title, breadcrumb, etc.)
18
18
 
19
19
  | Property | Type | Description | Defined in |
20
20
  | --------------------------------- | -------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
21
- | <a id="property-path"></a> `path` | `string` | Route path template (e.g., '/user/:id') | [types.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L41) |
21
+ | <a id="property-path"></a> `path` | `string` | Route path template (e.g., '/user/:id') | [types.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L41) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteTree
4
4
 
5
- Defined in: [types.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L115)
5
+ Defined in: [types.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L115)
6
6
 
7
7
  Complete route tree with lookup maps
8
8
 
@@ -15,7 +15,7 @@ Provides bidirectional mapping between state IDs and URL paths:
15
15
 
16
16
  | Property | Type | Description | Defined in |
17
17
  | ------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
18
- | <a id="property-bypath"></a> `byPath` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | Map full path -> route node Used to look up state ID from URL path for play.route event targeting | [types.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L127) |
19
- | <a id="property-bystateid"></a> `byStateId` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | Map state ID -> route node Used to look up URL path from state ID for browser URL sync | [types.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L122) |
20
- | <a id="property-graph"></a> `graph?` | `Graph`\<[`MachineNodeData`](MachineNodeData.md), [`MachineEdgeData`](MachineEdgeData.md), `any`, `any`\> | Graph representation of the state machine for advanced queries. Populated by extractMachineRoutes() — use for hierarchy queries, reachability checks, and transition-aware navigation via @statelyai/graph algorithms. **Example** `import { getSuccessors, hasPath } from "@statelyai/graph"; const successors = getSuccessors(tree.graph!, "myMachine.home");` | [types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L139) |
21
- | <a id="property-root"></a> `root` | [`RouteNode`](RouteNode.md) | Root route node | [types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L117) |
18
+ | <a id="property-bypath"></a> `byPath` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | Map full path -> route node Used to look up state ID from URL path for play.route event targeting | [types.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L127) |
19
+ | <a id="property-bystateid"></a> `byStateId` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | Map state ID -> route node Used to look up URL path from state ID for browser URL sync | [types.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L122) |
20
+ | <a id="property-graph"></a> `graph?` | `Graph`\<[`MachineNodeData`](MachineNodeData.md), [`MachineEdgeData`](MachineEdgeData.md), `any`, `any`\> | Graph representation of the state machine for advanced queries. Populated by extractMachineRoutes() — use for hierarchy queries, reachability checks, and transition-aware navigation via @statelyai/graph algorithms. **Example** `import { getSuccessors, hasPath } from "@statelyai/graph"; const successors = getSuccessors(tree.graph!, "myMachine.home");` | [types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L139) |
21
+ | <a id="property-root"></a> `root` | [`RouteNode`](RouteNode.md) | Root route node | [types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L117) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteWatcherHandle
4
4
 
5
- Defined in: [router-bridge-base.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L70)
5
+ Defined in: [router-bridge-base.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L71)
6
6
 
7
7
  Narrow interface for the TC39 Signal watcher used by `RouterBridgeBase` to
8
8
  monitor `actor.currentRoute` changes.
@@ -24,7 +24,7 @@ created and managed internally by `RouterBridgeBase`.
24
24
  unwatch(): void;
25
25
  ```
26
26
 
27
- Defined in: [router-bridge-base.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L74)
27
+ Defined in: [router-bridge-base.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L75)
28
28
 
29
29
  Stop observing and release the watcher.
30
30
 
@@ -40,7 +40,7 @@ Stop observing and release the watcher.
40
40
  watch(signal): void;
41
41
  ```
42
42
 
43
- Defined in: [router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L72)
43
+ Defined in: [router-bridge-base.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L73)
44
44
 
45
45
  Arm the watcher to observe the given signal.
46
46
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L271)
5
+ Defined in: [types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L271)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -44,7 +44,7 @@ class TanStackRouterBridge implements RouterBridge {
44
44
 
45
45
  ## See
46
46
 
47
- [Play RFC](../../docs/rfc/play.md) - Invariant INV-04
47
+ [Play RFC](../../../../rfc/play.md) - Invariant INV-04
48
48
 
49
49
  ## Methods
50
50
 
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L287)
57
+ Defined in: [types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L287)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L303)
86
+ Defined in: [types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L303)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: WindowLike
4
4
 
5
- Defined in: [types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L324)
5
+ Defined in: [types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L324)
6
6
 
7
7
  Minimal window interface required by adapters that subscribe to DOM events
8
8
  (e.g. `hashchange`). Injectable for SSR and testing — pass a mock instead of
@@ -30,7 +30,7 @@ connectRouter({ actor, routeMap, window: mockWin });
30
30
  addEventListener(type, listener): void;
31
31
  ```
32
32
 
33
- Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L325)
33
+ Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L325)
34
34
 
35
35
  #### Parameters
36
36
 
@@ -51,7 +51,7 @@ Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.
51
51
  removeEventListener(type, listener): void;
52
52
  ```
53
53
 
54
- Defined in: [types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L326)
54
+ Defined in: [types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L326)
55
55
 
56
56
  #### Parameters
57
57