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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (432) hide show
  1. package/api/@xmachines/play/README.md +5 -5
  2. package/api/@xmachines/play/classes/NonNullableError.md +5 -5
  3. package/api/@xmachines/play/classes/PlayError.md +5 -5
  4. package/api/@xmachines/play/functions/assertNonNullable.md +2 -2
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +4 -4
  6. package/api/@xmachines/play-actor/README.md +7 -7
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +4 -4
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +2 -2
  9. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +6 -6
  10. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +6 -6
  11. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Routable.md +4 -4
  13. package/api/@xmachines/play-actor/interfaces/Viewable.md +3 -3
  14. package/api/@xmachines/play-dom/README.md +3 -2
  15. package/api/@xmachines/play-dom/classes/PlayRenderer.md +5 -5
  16. package/api/@xmachines/play-dom/functions/connectRenderer.md +2 -2
  17. package/api/@xmachines/play-dom/functions/createPlayUI.md +2 -2
  18. package/api/@xmachines/play-dom/functions/createRenderer.md +2 -2
  19. package/api/@xmachines/play-dom/functions/defineRegistry.md +2 -2
  20. package/api/@xmachines/play-dom/functions/renderSpec.md +2 -2
  21. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +8 -8
  22. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +14 -14
  23. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +7 -7
  24. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +5 -5
  25. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +13 -13
  26. package/api/@xmachines/play-dom/interfaces/EventHandle.md +5 -5
  27. package/api/@xmachines/play-dom/interfaces/MountOptions.md +4 -4
  28. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +6 -6
  29. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +6 -6
  30. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +2 -2
  31. package/api/@xmachines/play-dom/type-aliases/Actions.md +2 -2
  32. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +8 -8
  33. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +2 -2
  34. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +2 -2
  35. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +2 -2
  36. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +3 -3
  37. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +2 -2
  38. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +2 -2
  39. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +2 -2
  40. package/api/@xmachines/play-dom/type-aliases/MountFn.md +2 -2
  41. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/SetState.md +2 -2
  43. package/api/@xmachines/play-dom/variables/schema.md +2 -2
  44. package/api/@xmachines/play-dom-router/README.md +13 -11
  45. package/api/@xmachines/play-dom-router/functions/connectRouter.md +2 -2
  46. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +2 -2
  47. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +9 -8
  48. package/api/@xmachines/play-dom-router/functions/createRouter.md +3 -3
  49. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +15 -15
  50. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +15 -15
  51. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +5 -5
  52. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +8 -8
  53. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +4 -4
  54. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +4 -4
  55. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +13 -0
  56. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +4 -4
  57. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +5 -5
  58. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +5 -5
  59. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +2 -2
  60. package/api/@xmachines/play-react/README.md +10 -4
  61. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
  62. package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
  63. package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
  64. package/api/@xmachines/play-react/functions/Renderer.md +1 -1
  65. package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
  66. package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
  67. package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
  68. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  69. package/api/@xmachines/play-react/functions/useActor.md +2 -2
  70. package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
  71. package/api/@xmachines/play-react/functions/usePlayView.md +2 -2
  72. package/api/@xmachines/play-react/functions/useSignalEffect.md +2 -2
  73. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
  74. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +9 -9
  75. package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
  76. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +1 -1
  77. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +5 -5
  78. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
  79. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +9 -9
  80. package/api/@xmachines/play-react/interfaces/RendererProps.md +1 -1
  81. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
  82. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
  83. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +6 -6
  84. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
  85. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
  86. package/api/@xmachines/play-react/type-aliases/PlayActor.md +2 -2
  87. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
  88. package/api/@xmachines/play-react/variables/ActorProvider.md +2 -2
  89. package/api/@xmachines/play-react/variables/PlayRenderer.md +2 -2
  90. package/api/@xmachines/play-react/variables/PlayUIProvider.md +2 -2
  91. package/api/@xmachines/play-react-router/README.md +13 -7
  92. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +34 -30
  93. package/api/@xmachines/play-react-router/classes/RouteMap.md +5 -5
  94. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +2 -2
  95. package/api/@xmachines/play-react-router/functions/createRouteMap.md +25 -7
  96. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +12 -11
  97. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +8 -8
  98. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +8 -8
  99. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +13 -0
  100. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +4 -4
  101. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +5 -5
  102. package/api/@xmachines/play-router/README.md +14 -13
  103. package/api/@xmachines/play-router/classes/RouteMap.md +5 -5
  104. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +38 -34
  105. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +2 -2
  106. package/api/@xmachines/play-router/functions/buildRouteTree.md +2 -2
  107. package/api/@xmachines/play-router/functions/createRouteMap.md +22 -36
  108. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +12 -11
  109. package/api/@xmachines/play-router/functions/createRouteMatcher.md +53 -0
  110. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +2 -2
  111. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +2 -2
  112. package/api/@xmachines/play-router/functions/extractQuery.md +2 -2
  113. package/api/@xmachines/play-router/functions/extractRouteParams.md +2 -2
  114. package/api/@xmachines/play-router/functions/findRouteById.md +2 -2
  115. package/api/@xmachines/play-router/functions/findRouteByPath.md +2 -2
  116. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +2 -2
  117. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +2 -2
  118. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +2 -2
  119. package/api/@xmachines/play-router/functions/isRouteReachable.md +2 -2
  120. package/api/@xmachines/play-router/functions/machineToGraph.md +2 -2
  121. package/api/@xmachines/play-router/functions/routeExists.md +2 -2
  122. package/api/@xmachines/play-router/functions/sanitizePathname.md +2 -2
  123. package/api/@xmachines/play-router/functions/validateRouteFormat.md +2 -2
  124. package/api/@xmachines/play-router/functions/validateStateExists.md +2 -2
  125. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +5 -5
  126. package/api/@xmachines/play-router/interfaces/LocationLike.md +4 -4
  127. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +4 -4
  128. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +6 -6
  129. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +8 -8
  130. package/api/@xmachines/play-router/interfaces/RouteInfo.md +9 -9
  131. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +13 -0
  132. package/api/@xmachines/play-router/interfaces/RouteMapping.md +4 -4
  133. package/api/@xmachines/play-router/interfaces/RouteMatch.md +4 -4
  134. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +9 -9
  135. package/api/@xmachines/play-router/interfaces/RouteNode.md +13 -13
  136. package/api/@xmachines/play-router/interfaces/RouteObject.md +3 -3
  137. package/api/@xmachines/play-router/interfaces/RouteTree.md +6 -6
  138. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +4 -4
  139. package/api/@xmachines/play-router/interfaces/RouterBridge.md +5 -5
  140. package/api/@xmachines/play-router/interfaces/WindowLike.md +4 -4
  141. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +2 -2
  142. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +2 -2
  143. package/api/@xmachines/play-signals/README.md +3 -3
  144. package/api/@xmachines/play-signals/functions/watchSignal.md +2 -2
  145. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +3 -3
  146. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +3 -3
  147. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +3 -3
  148. package/api/@xmachines/play-signals/interfaces/SignalState.md +4 -4
  149. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +5 -5
  150. package/api/@xmachines/play-signals/namespaces/Signal/README.md +1 -1
  151. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +1 -1
  152. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +1 -1
  153. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
  154. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/README.md +1 -1
  155. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +1 -1
  156. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
  157. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
  158. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
  159. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
  160. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
  161. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
  162. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
  163. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
  164. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
  165. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
  166. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
  167. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +2 -2
  168. package/api/@xmachines/play-solid/README.md +11 -5
  169. package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
  170. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
  171. package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
  172. package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
  173. package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
  174. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
  175. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  176. package/api/@xmachines/play-solid/functions/useAction.md +1 -1
  177. package/api/@xmachines/play-solid/functions/useActions.md +1 -1
  178. package/api/@xmachines/play-solid/functions/useActor.md +2 -2
  179. package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
  180. package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
  181. package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
  182. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
  183. package/api/@xmachines/play-solid/functions/usePlayView.md +2 -2
  184. package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
  185. package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
  186. package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
  187. package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
  188. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
  189. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +9 -9
  190. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
  191. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
  192. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +1 -1
  193. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +9 -9
  194. package/api/@xmachines/play-solid/interfaces/RendererProps.md +1 -1
  195. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
  196. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
  197. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +6 -6
  198. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
  199. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -1
  200. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +2 -2
  201. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
  202. package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
  203. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
  204. package/api/@xmachines/play-solid/variables/ActorContext.md +2 -2
  205. package/api/@xmachines/play-solid/variables/ActorProvider.md +2 -2
  206. package/api/@xmachines/play-solid/variables/PlayRenderer.md +2 -2
  207. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +2 -2
  208. package/api/@xmachines/play-solid-router/README.md +18 -13
  209. package/api/@xmachines/play-solid-router/classes/RouteMap.md +5 -5
  210. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +35 -31
  211. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +2 -2
  212. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +9 -8
  213. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +4 -4
  214. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +8 -8
  215. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +6 -6
  216. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +13 -0
  217. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +4 -4
  218. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +5 -5
  219. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +2 -2
  220. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +5 -5
  221. package/api/@xmachines/play-svelte/README.md +9 -2
  222. package/api/@xmachines/play-svelte/functions/defineRegistry.md +2 -2
  223. package/api/@xmachines/play-svelte/functions/getActorContext.md +2 -2
  224. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +2 -2
  225. package/api/@xmachines/play-svelte/functions/setActorContext.md +2 -2
  226. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +13 -9
  227. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +1 -1
  228. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
  229. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +5 -5
  230. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +43 -0
  231. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +6 -6
  232. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +1 -1
  233. package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
  234. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
  235. package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +2 -2
  236. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
  237. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +1 -1
  238. package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
  239. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
  240. package/api/@xmachines/play-svelte-spa-router/README.md +7 -1
  241. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +5 -5
  242. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +2 -2
  243. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +9 -8
  244. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +5 -5
  245. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +8 -8
  246. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +13 -0
  247. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +4 -4
  248. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +5 -5
  249. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +4 -4
  250. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +2 -2
  251. package/api/@xmachines/play-sveltekit-router/README.md +8 -2
  252. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +5 -5
  253. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +2 -2
  254. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +9 -8
  255. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +5 -5
  256. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +4 -4
  257. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +8 -8
  258. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +13 -0
  259. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +4 -4
  260. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +5 -5
  261. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +2 -2
  262. package/api/@xmachines/play-tanstack-react-router/README.md +15 -9
  263. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +5 -5
  264. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +34 -30
  265. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +2 -2
  266. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +25 -7
  267. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +12 -11
  268. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +2 -2
  269. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +8 -8
  270. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +8 -8
  271. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +13 -0
  272. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +4 -4
  273. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +4 -4
  274. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +5 -5
  275. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +2 -2
  276. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  277. package/api/@xmachines/play-tanstack-solid-router/README.md +17 -11
  278. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +5 -5
  279. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +35 -31
  280. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +2 -2
  281. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +9 -8
  282. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +8 -8
  283. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +6 -6
  284. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +13 -0
  285. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +4 -4
  286. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +5 -5
  287. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +2 -2
  288. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +2 -2
  289. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  290. package/api/@xmachines/play-vue/README.md +12 -6
  291. package/api/@xmachines/play-vue/functions/defineRegistry.md +2 -2
  292. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +2 -2
  293. package/api/@xmachines/play-vue/functions/useActor.md +2 -2
  294. package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
  295. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
  296. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +6 -6
  297. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
  298. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
  299. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +1 -1
  300. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +9 -9
  301. package/api/@xmachines/play-vue/interfaces/RendererProps.md +1 -1
  302. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
  303. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
  304. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +6 -6
  305. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +5 -0
  306. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +2 -2
  307. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
  308. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +2 -2
  309. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +3 -3
  310. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +2 -2
  311. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
  312. package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
  313. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +1 -1
  314. package/api/@xmachines/play-vue/variables/PlayRenderer.md +2 -2
  315. package/api/@xmachines/play-vue/variables/Renderer.md +1 -1
  316. package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
  317. package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
  318. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
  319. package/api/@xmachines/play-vue-router/README.md +18 -13
  320. package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
  321. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +41 -31
  322. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +26 -6
  323. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +8 -8
  324. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +13 -0
  325. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  326. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +5 -5
  327. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +2 -2
  328. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +2 -2
  329. package/api/@xmachines/play-xstate/README.md +11 -11
  330. package/api/@xmachines/play-xstate/classes/PlayerActor.md +14 -14
  331. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +2 -2
  332. package/api/@xmachines/play-xstate/functions/composeGuards.md +2 -2
  333. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +2 -2
  334. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +5 -3
  335. package/api/@xmachines/play-xstate/functions/definePlayer.md +3 -3
  336. package/api/@xmachines/play-xstate/functions/deriveRoute.md +3 -3
  337. package/api/@xmachines/play-xstate/functions/eventMatches.md +2 -2
  338. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +2 -2
  339. package/api/@xmachines/play-xstate/functions/hasContext.md +2 -2
  340. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +2 -2
  341. package/api/@xmachines/play-xstate/functions/negateGuard.md +2 -2
  342. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +4 -4
  343. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +3 -3
  344. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
  345. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +6 -6
  346. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +2 -2
  347. package/api/@xmachines/play-xstate/type-aliases/Guard.md +2 -2
  348. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +2 -2
  349. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +2 -2
  350. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +5 -5
  351. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +5 -5
  352. package/api/@xmachines/shared/README.md +1 -1
  353. package/api/@xmachines/shared/vite-aliases/README.md +1 -1
  354. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +2 -2
  355. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +2 -2
  356. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +2 -2
  357. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +2 -2
  358. package/api/@xmachines/shared/vitest/README.md +1 -1
  359. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +2 -2
  360. package/api/llms.txt +2 -2
  361. package/examples/@xmachines/play-dom-demo/README.md +4 -4
  362. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +2 -2
  363. package/examples/@xmachines/play-dom-demo/functions/initShell.md +2 -2
  364. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +2 -2
  365. package/examples/@xmachines/play-dom-demo/variables/About.md +2 -2
  366. package/examples/@xmachines/play-dom-demo/variables/Contact.md +2 -2
  367. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +2 -2
  368. package/examples/@xmachines/play-dom-demo/variables/Home.md +2 -2
  369. package/examples/@xmachines/play-dom-demo/variables/Login.md +2 -2
  370. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +2 -2
  371. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +2 -2
  372. package/examples/@xmachines/play-dom-demo/variables/Overview.md +2 -2
  373. package/examples/@xmachines/play-dom-demo/variables/Profile.md +2 -2
  374. package/examples/@xmachines/play-dom-demo/variables/Settings.md +2 -2
  375. package/examples/@xmachines/play-dom-demo/variables/Stats.md +2 -2
  376. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +2 -2
  377. package/examples/@xmachines/play-dom-router-demo/README.md +5 -5
  378. package/examples/@xmachines/play-react-demo/README.md +4 -4
  379. package/examples/@xmachines/play-react-demo/functions/App.md +2 -2
  380. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +2 -2
  381. package/examples/@xmachines/play-react-demo/variables/About.md +2 -2
  382. package/examples/@xmachines/play-react-demo/variables/Contact.md +2 -2
  383. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +2 -2
  384. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +2 -2
  385. package/examples/@xmachines/play-react-demo/variables/Home.md +2 -2
  386. package/examples/@xmachines/play-react-demo/variables/Login.md +2 -2
  387. package/examples/@xmachines/play-react-demo/variables/NavBar.md +2 -2
  388. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +2 -2
  389. package/examples/@xmachines/play-react-demo/variables/Navigation.md +2 -2
  390. package/examples/@xmachines/play-react-demo/variables/Overview.md +2 -2
  391. package/examples/@xmachines/play-react-demo/variables/Profile.md +2 -2
  392. package/examples/@xmachines/play-react-demo/variables/Settings.md +2 -2
  393. package/examples/@xmachines/play-react-demo/variables/Shell.md +2 -2
  394. package/examples/@xmachines/play-react-demo/variables/Stats.md +2 -2
  395. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +2 -2
  396. package/examples/@xmachines/play-react-router-demo/README.md +4 -4
  397. package/examples/@xmachines/play-solid-demo/README.md +4 -4
  398. package/examples/@xmachines/play-solid-demo/functions/App.md +2 -2
  399. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +2 -2
  400. package/examples/@xmachines/play-solid-demo/variables/About.md +2 -2
  401. package/examples/@xmachines/play-solid-demo/variables/Contact.md +2 -2
  402. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +2 -2
  403. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +2 -2
  404. package/examples/@xmachines/play-solid-demo/variables/Home.md +2 -2
  405. package/examples/@xmachines/play-solid-demo/variables/Login.md +2 -2
  406. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +2 -2
  407. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +2 -2
  408. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +2 -2
  409. package/examples/@xmachines/play-solid-demo/variables/Overview.md +2 -2
  410. package/examples/@xmachines/play-solid-demo/variables/Profile.md +2 -2
  411. package/examples/@xmachines/play-solid-demo/variables/Settings.md +2 -2
  412. package/examples/@xmachines/play-solid-demo/variables/Shell.md +2 -2
  413. package/examples/@xmachines/play-solid-demo/variables/Stats.md +2 -2
  414. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +2 -2
  415. package/examples/@xmachines/play-solid-router-demo/README.md +5 -5
  416. package/examples/@xmachines/play-svelte-demo/README.md +3 -3
  417. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
  418. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +2 -2
  419. package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
  420. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +2 -2
  421. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +4 -4
  422. package/examples/@xmachines/play-sveltekit-router-demo/README.md +4 -4
  423. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +5 -5
  424. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +6 -6
  425. package/examples/@xmachines/play-vue-demo/README.md +4 -4
  426. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +2 -2
  427. package/examples/@xmachines/play-vue-demo/variables/App.md +2 -2
  428. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +2 -2
  429. package/examples/@xmachines/play-vue-router-demo/README.md +4 -4
  430. package/package.json +2 -2
  431. package/rfc/play.md +1 -1
  432. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +0 -38
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / extractRouteParams
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / extractRouteParams
2
2
 
3
3
  # Function: extractRouteParams()
4
4
 
@@ -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.45/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
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / findRouteById
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / findRouteById
2
2
 
3
3
  # Function: findRouteById()
4
4
 
@@ -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.45/packages/play-router/src/find-route.ts#L52)
10
10
 
11
11
  Find route node by state ID
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / findRouteByPath
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / findRouteByPath
2
2
 
3
3
  # Function: findRouteByPath()
4
4
 
@@ -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.45/packages/play-router/src/find-route.ts#L77)
10
10
 
11
11
  Find route node by URL path
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / getNavigableRoutes
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / getNavigableRoutes
2
2
 
3
3
  # Function: getNavigableRoutes()
4
4
 
@@ -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.45/packages/play-router/src/query.ts#L22)
10
10
 
11
11
  Get all routes navigable from given state
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / getRoutableRoutes
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / getRoutableRoutes
2
2
 
3
3
  # Function: getRoutableRoutes()
4
4
 
@@ -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.45/packages/play-router/src/query.ts#L67)
10
10
 
11
11
  Get all routable routes from tree as flat array
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / getTransitionReachableRoutes
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / getTransitionReachableRoutes
2
2
 
3
3
  # Function: getTransitionReachableRoutes()
4
4
 
@@ -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.45/packages/play-router/src/query.ts#L113)
10
10
 
11
11
  Get routes reachable via transitions from current state
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / isRouteReachable
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / isRouteReachable
2
2
 
3
3
  # Function: isRouteReachable()
4
4
 
@@ -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.45/packages/play-router/src/query.ts#L149)
10
10
 
11
11
  Check if a route is reachable from current state via transitions
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / machineToGraph
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / machineToGraph
2
2
 
3
3
  # Function: machineToGraph()
4
4
 
@@ -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.45/packages/play-router/src/machine-to-graph.ts#L71)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / routeExists
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / routeExists
2
2
 
3
3
  # Function: routeExists()
4
4
 
@@ -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.45/packages/play-router/src/query.ts#L89)
10
10
 
11
11
  Validate route path exists in tree
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / sanitizePathname
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / sanitizePathname
2
2
 
3
3
  # Function: sanitizePathname()
4
4
 
@@ -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.45/packages/play-router/src/router-sync.ts#L69)
10
10
 
11
11
  Normalize a pathname before route-map lookup.
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / validateRouteFormat
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / validateRouteFormat
2
2
 
3
3
  # Function: validateRouteFormat()
4
4
 
@@ -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.45/packages/play-router/src/validate-routes.ts#L15)
10
10
 
11
11
  Validate route path format
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / validateStateExists
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / validateStateExists
2
2
 
3
3
  # Function: validateStateExists()
4
4
 
@@ -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.45/packages/play-router/src/validate-routes.ts#L31)
10
10
 
11
11
  Validate state exists in state ID set
12
12
 
@@ -1,13 +1,13 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / BuildPlayRouteEventOptions
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / BuildPlayRouteEventOptions
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.45/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.45/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.45/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.45/packages/play-router/src/router-sync.ts#L16) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / LocationLike
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / LocationLike
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.45/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.45/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.45/packages/play-router/src/types.ts#L346) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / MachineEdgeData
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / MachineEdgeData
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.45/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.45/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.45/packages/play-router/src/types.ts#L26) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / MachineNodeData
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / MachineNodeData
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.45/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.45/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.45/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.45/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.45/packages/play-router/src/types.ts#L11) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / PlayRouteEvent
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / PlayRouteEvent
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.45/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.45/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.45/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.45/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.45/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.45/packages/play-router/src/types.ts#L224) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / RouteInfo
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteInfo
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.45/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.45/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.45/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.45/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.45/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.45/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.45/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.45/packages/play-router/src/types.ts#L58) |
@@ -0,0 +1,13 @@
1
+ [API](../../../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.45/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.45/packages/play-router/src/create-route-map.ts#L20) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMapping
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMapping
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.45/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.45/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.45/packages/play-router/src/base-route-map.ts#L59) |
@@ -1,12 +1,12 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMatch
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMatch
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.45/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.45/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.45/packages/play-router/src/router-sync.ts#L10) |
@@ -1,10 +1,10 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMatcher
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMatcher
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.45/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.45/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.45/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.45/packages/play-router/src/create-route-matcher.ts#L38) |
@@ -1,21 +1,21 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / RouteNode
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteNode
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.45/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.45/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.45/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.45/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.45/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.45/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.45/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.45/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.45/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.45/packages/play-router/src/types.ts#L94) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / RouteObject
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteObject
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.45/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.45/packages/play-router/src/types.ts#L41) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / RouteTree
1
+ [API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteTree
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.45/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.45/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.45/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.45/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.45/packages/play-router/src/types.ts#L117) |