@xmachines/docs 1.0.0-beta.55 → 1.0.0-beta.57

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 (467) hide show
  1. package/README.md +4 -4
  2. package/api/@xmachines/play/README.md +3 -3
  3. package/api/@xmachines/play/classes/NonNullableError.md +7 -7
  4. package/api/@xmachines/play/classes/PlayError.md +7 -7
  5. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  6. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  7. package/api/@xmachines/play-actor/README.md +7 -7
  8. package/api/@xmachines/play-actor/classes/AbstractActor.md +14 -14
  9. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  10. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  11. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  12. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +7 -7
  13. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +8 -8
  14. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +3 -3
  15. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  16. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  17. package/api/@xmachines/play-dom/README.md +13 -19
  18. package/api/@xmachines/play-dom/classes/PlayRenderer.md +12 -11
  19. package/api/@xmachines/play-dom/functions/createPlayUI.md +5 -5
  20. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  21. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  22. package/api/@xmachines/play-dom/functions/renderSpec.md +2 -2
  23. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +9 -9
  24. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +12 -11
  25. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +7 -7
  26. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +19 -18
  27. package/api/@xmachines/play-dom/interfaces/EventHandle.md +6 -6
  28. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  29. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +14 -13
  30. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +14 -13
  31. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +12 -11
  32. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +3 -3
  33. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +9 -9
  35. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +2 -2
  36. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +3 -3
  39. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +5 -5
  40. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  41. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  43. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  44. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
  45. package/api/@xmachines/play-dom/type-aliases/SetState.md +3 -3
  46. package/api/@xmachines/play-dom/variables/schema.md +26 -20
  47. package/api/@xmachines/play-dom-router/README.md +4 -4
  48. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  49. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  50. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  51. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  52. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  53. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  54. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  55. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  56. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  57. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  58. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  59. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  60. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  61. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  62. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  63. package/api/@xmachines/play-react/README.md +9 -15
  64. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +18 -18
  65. package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
  66. package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
  67. package/api/@xmachines/play-react/functions/Renderer.md +1 -1
  68. package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
  69. package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
  70. package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
  71. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  72. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  73. package/api/@xmachines/play-react/functions/useBoundProp.md +2 -2
  74. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  75. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  76. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
  77. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  78. package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
  79. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +13 -12
  80. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  81. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  82. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  83. package/api/@xmachines/play-react/interfaces/RendererProps.md +8 -8
  84. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
  85. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
  86. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  87. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
  88. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  89. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
  90. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
  91. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  92. package/api/@xmachines/play-react/variables/PlayRenderer.md +2 -2
  93. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  94. package/api/@xmachines/play-react-router/README.md +5 -5
  95. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
  96. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  97. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  98. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  99. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  100. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  101. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  102. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  103. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  104. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  105. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  106. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  107. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  108. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  109. package/api/@xmachines/play-router/README.md +5 -5
  110. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  111. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
  112. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  113. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  114. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  115. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  116. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  117. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  118. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  119. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  120. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  121. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  122. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  123. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  124. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  125. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  126. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  127. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  128. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  129. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  130. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  131. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  132. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  133. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  134. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  135. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  136. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  137. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +3 -3
  138. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  139. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  140. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  141. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  142. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  143. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  144. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  145. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  146. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  147. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  148. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  149. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  150. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  151. package/api/@xmachines/play-signals/README.md +5 -5
  152. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  153. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  154. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  155. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  156. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  157. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  158. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +3 -3
  159. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +4 -4
  160. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
  161. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +5 -5
  162. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
  163. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
  164. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
  165. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
  166. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
  167. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
  168. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
  169. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
  170. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
  171. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
  172. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
  173. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  174. package/api/@xmachines/play-solid/README.md +13 -19
  175. package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
  176. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
  177. package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
  178. package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
  179. package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
  180. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
  181. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  182. package/api/@xmachines/play-solid/functions/useAction.md +1 -1
  183. package/api/@xmachines/play-solid/functions/useActions.md +1 -1
  184. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  185. package/api/@xmachines/play-solid/functions/useBoundProp.md +2 -2
  186. package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
  187. package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
  188. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
  189. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  190. package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
  191. package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
  192. package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
  193. package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
  194. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
  195. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  196. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
  197. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
  198. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +13 -12
  199. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  200. package/api/@xmachines/play-solid/interfaces/RendererProps.md +8 -8
  201. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
  202. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
  203. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +7 -7
  204. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  205. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
  206. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +2 -8
  207. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
  208. package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
  209. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
  210. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  211. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  212. package/api/@xmachines/play-solid/variables/PlayRenderer.md +2 -2
  213. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  214. package/api/@xmachines/play-solid-router/README.md +5 -5
  215. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  216. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
  217. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  218. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  219. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +13 -13
  220. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  221. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  222. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  223. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  224. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  225. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  226. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  227. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  228. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  229. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  230. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  231. package/api/@xmachines/play-svelte/README.md +26 -31
  232. package/api/@xmachines/play-svelte/functions/defineRegistry.md +2 -2
  233. package/api/@xmachines/play-svelte/functions/getActorContext.md +2 -2
  234. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  235. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  236. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +10 -10
  237. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +1 -1
  238. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
  239. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -6
  240. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +13 -13
  241. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  242. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +1 -1
  243. package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
  244. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  245. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
  246. package/api/@xmachines/play-svelte/type-aliases/JSONUIProviderProps.md +7 -0
  247. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
  248. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +17 -1
  249. package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
  250. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
  251. package/api/@xmachines/play-svelte-spa-router/README.md +4 -4
  252. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  253. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  254. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  255. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  256. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  257. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  258. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  259. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  260. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  261. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  262. package/api/@xmachines/play-sveltekit-router/README.md +6 -6
  263. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  264. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  265. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  266. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  267. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  268. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  269. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  270. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  271. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  272. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  273. package/api/@xmachines/play-tanstack-react-router/README.md +6 -6
  274. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  275. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
  276. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  277. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  278. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  279. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  280. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  281. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  282. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  283. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  284. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  285. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  286. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  287. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  288. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  289. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  290. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  291. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  292. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
  293. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  294. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
  295. package/api/@xmachines/play-tanstack-solid-router/README.md +5 -5
  296. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  297. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
  298. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  299. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  300. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  301. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  302. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  303. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  304. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  305. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  306. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  307. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  308. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  309. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  310. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  311. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  312. package/api/@xmachines/play-vue/README.md +12 -18
  313. package/api/@xmachines/play-vue/functions/defineRegistry.md +3 -3
  314. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  315. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  316. package/api/@xmachines/play-vue/functions/useBoundProp.md +2 -2
  317. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
  318. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  319. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
  320. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
  321. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +12 -11
  322. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  323. package/api/@xmachines/play-vue/interfaces/RendererProps.md +8 -8
  324. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
  325. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
  326. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  327. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  328. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  329. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  330. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
  331. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  332. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  333. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
  334. package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
  335. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +10 -1
  336. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  337. package/api/@xmachines/play-vue/variables/Renderer.md +10 -1
  338. package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
  339. package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
  340. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
  341. package/api/@xmachines/play-vue-router/README.md +4 -4
  342. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  343. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
  344. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  345. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  346. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  347. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  348. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  349. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  350. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  351. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  352. package/api/@xmachines/play-xstate/README.md +3 -3
  353. package/api/@xmachines/play-xstate/classes/PlayerActor.md +31 -31
  354. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  355. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  356. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  357. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  358. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  359. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  360. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  361. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  362. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  363. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  364. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  365. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  366. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  367. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  368. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  369. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  370. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  371. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  372. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  373. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  374. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  375. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  376. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  377. package/api/@xmachines/shared/README.md +2 -2
  378. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  379. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  380. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +3 -3
  381. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +2 -2
  382. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  383. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  384. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  385. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  386. package/api/llms.txt +2 -2
  387. package/contributing/architecture.md +9 -9
  388. package/contributing/configuration.md +12 -12
  389. package/contributing/deployment.md +9 -9
  390. package/contributing/development.md +43 -43
  391. package/contributing/testing.md +15 -15
  392. package/examples/@xmachines/play-dom-demo/README.md +12 -12
  393. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  394. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  395. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  396. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  397. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  398. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  399. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  400. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  401. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  402. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  403. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  404. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  405. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  406. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  407. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  408. package/examples/@xmachines/play-dom-router-demo/README.md +12 -12
  409. package/examples/@xmachines/play-react-demo/README.md +13 -13
  410. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  411. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  412. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  413. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  414. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  415. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  416. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  417. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  418. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  419. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  420. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  421. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  422. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  423. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  424. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  425. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  426. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  427. package/examples/@xmachines/play-react-router-demo/README.md +12 -12
  428. package/examples/@xmachines/play-solid-demo/README.md +12 -12
  429. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  430. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  431. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  432. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  433. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  434. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  435. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  436. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  437. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  438. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  439. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  440. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  441. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  442. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  443. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  444. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  445. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  446. package/examples/@xmachines/play-solid-router-demo/README.md +12 -12
  447. package/examples/@xmachines/play-svelte-demo/README.md +12 -12
  448. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
  449. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  450. package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
  451. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  452. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +12 -12
  453. package/examples/@xmachines/play-sveltekit-router-demo/README.md +12 -12
  454. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +12 -12
  455. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +12 -12
  456. package/examples/@xmachines/play-vue-demo/README.md +14 -14
  457. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  458. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  459. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  460. package/examples/@xmachines/play-vue-router-demo/README.md +12 -12
  461. package/examples/README.md +3 -3
  462. package/examples/form-validation.md +2 -2
  463. package/guides/getting-started.md +35 -42
  464. package/guides/signals.md +2 -2
  465. package/guides/state-machines.md +1 -1
  466. package/package.json +2 -2
  467. package/rfc/play.md +16 -16
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Abstract Class: RouterBridgeBase
4
4
 
5
- Defined in: [router-bridge-base.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-bridge-base.ts#L96)
5
+ Defined in: [router-bridge-base.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-bridge-base.ts#L96)
6
6
 
7
7
  Abstract base class for all `@xmachines` router adapter bridges.
8
8
 
@@ -30,7 +30,7 @@ between frameworks.
30
30
  new RouterBridgeBase(actor, routeMap): RouterBridgeBase;
31
31
  ```
32
32
 
33
- Defined in: [router-bridge-base.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-bridge-base.ts#L123)
33
+ Defined in: [router-bridge-base.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-bridge-base.ts#L123)
34
34
 
35
35
  #### Parameters
36
36
 
@@ -53,7 +53,7 @@ Defined in: [router-bridge-base.ts:123](https://gitlab.com/xmachin-es/xmachines-
53
53
  connect(): void;
54
54
  ```
55
55
 
56
- Defined in: [router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-bridge-base.ts#L151)
56
+ Defined in: [router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-bridge-base.ts#L151)
57
57
 
58
58
  Connect the router bridge to the Actor.
59
59
 
@@ -85,7 +85,7 @@ Adapters that need custom initial-sync behavior should override
85
85
  disconnect(): void;
86
86
  ```
87
87
 
88
- Defined in: [router-bridge-base.ts:256](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-bridge-base.ts#L256)
88
+ Defined in: [router-bridge-base.ts:256](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-bridge-base.ts#L256)
89
89
 
90
90
  Disconnect the router bridge from the Actor.
91
91
 
@@ -9,7 +9,7 @@ function buildPlayRouteEvent(options): {
9
9
  } | null;
10
10
  ```
11
11
 
12
- Defined in: [router-sync.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-sync.ts#L168)
12
+ Defined in: [router-sync.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-sync.ts#L168)
13
13
 
14
14
  Build a normalized `play.route` event from raw router/browser input.
15
15
 
@@ -6,7 +6,7 @@
6
6
  function buildRouteTree(routes): RouteTree;
7
7
  ```
8
8
 
9
- Defined in: [build-tree.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/build-tree.ts#L21)
9
+ Defined in: [build-tree.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/build-tree.ts#L21)
10
10
 
11
11
  Build hierarchical route tree from flat route list
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/create-route-map.ts#L45)
9
+ Defined in: [create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/create-route-map.ts#L45)
10
10
 
11
11
  Create a `RouteMap` from an XState state machine.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMapFromTree(routeTree, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [create-route-map-from-tree.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/create-route-map-from-tree.ts#L33)
9
+ Defined in: [create-route-map-from-tree.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/create-route-map-from-tree.ts#L33)
10
10
 
11
11
  Create a `RouteMap` from a `RouteTree` node structure.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function detectDuplicateRoutes(routes): void;
7
7
  ```
8
8
 
9
- Defined in: [validate-routes.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/validate-routes.ts#L69)
9
+ Defined in: [validate-routes.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/validate-routes.ts#L69)
10
10
 
11
11
  Detect duplicate route paths
12
12
 
@@ -6,7 +6,7 @@
6
6
  function extractMachineRoutes(machine): RouteTree;
7
7
  ```
8
8
 
9
- Defined in: [extract-routes.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/extract-routes.ts#L89)
9
+ Defined in: [extract-routes.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/extract-routes.ts#L89)
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:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-sync.ts#L149)
9
+ Defined in: [router-sync.ts:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-sync.ts#L149)
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:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-sync.ts#L112)
9
+ Defined in: [router-sync.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-sync.ts#L112)
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:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/find-route.ts#L57)
9
+ Defined in: [find-route.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/find-route.ts#L57)
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:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/find-route.ts#L82)
9
+ Defined in: [find-route.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/find-route.ts#L82)
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:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/query.ts#L64)
9
+ Defined in: [query.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/query.ts#L64)
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:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/query.ts#L126)
9
+ Defined in: [query.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/query.ts#L126)
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:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/query.ts#L177)
9
+ Defined in: [query.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/query.ts#L177)
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:204](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/query.ts#L204)
9
+ Defined in: [query.ts:204](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/query.ts#L204)
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.55/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.57/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:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/query.ts#L148)
9
+ Defined in: [query.ts:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/query.ts#L148)
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:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-sync.ts#L72)
9
+ Defined in: [router-sync.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-sync.ts#L72)
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:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/validate-routes.ts#L27)
9
+ Defined in: [validate-routes.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/validate-routes.ts#L27)
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:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/validate-routes.ts#L43)
9
+ Defined in: [validate-routes.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/validate-routes.ts#L43)
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:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-sync.ts#L17)
5
+ Defined in: [router-sync.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-sync.ts#L17)
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:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-sync.ts#L20) |
12
- | <a id="property-pathname"></a> `pathname` | `string` | [router-sync.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-sync.ts#L18) |
13
- | <a id="property-search"></a> `search?` | `string` | [router-sync.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-sync.ts#L19) |
11
+ | <a id="property-match"></a> `match` | (`sanitizedPathname`) => [`RouteMatch`](RouteMatch.md) | [router-sync.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-sync.ts#L20) |
12
+ | <a id="property-pathname"></a> `pathname` | `string` | [router-sync.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-sync.ts#L18) |
13
+ | <a id="property-search"></a> `search?` | `string` | [router-sync.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-sync.ts#L19) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: LocationLike
4
4
 
5
- Defined in: [types.ts:414](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L414)
5
+ Defined in: [types.ts:414](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L414)
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:415](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L415) |
27
- | <a id="property-search"></a> `search` | `readonly` | `string` | [types.ts:416](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L416) |
26
+ | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [types.ts:415](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L415) |
27
+ | <a id="property-search"></a> `search` | `readonly` | `string` | [types.ts:416](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L416) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: MachineEdgeData
4
4
 
5
- Defined in: [types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L24)
5
+ Defined in: [types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L24)
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:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L26) |
15
- | <a id="property-guardtype"></a> `guardType?` | `string` | String representation of guard (if any) | [types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L28) |
14
+ | <a id="property-eventtype"></a> `eventType` | `string` | The event type that triggers this transition | [types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L26) |
15
+ | <a id="property-guardtype"></a> `guardType?` | `string` | String representation of guard (if any) | [types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L28) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: MachineNodeData
4
4
 
5
- Defined in: [types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L9)
5
+ Defined in: [types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L9)
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:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L15) |
15
- | <a id="property-route"></a> `route?` | `string` | Extracted route path from meta.route (string form) | [types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L17) |
16
- | <a id="property-stateid"></a> `stateId` | `string` | XState state ID (e.g., "test.dashboard.overview") | [types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L11) |
17
- | <a id="property-type"></a> `type` | `"atomic"` \| `"compound"` \| `"parallel"` \| `"final"` \| `"history"` | State type from XState | [types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L13) |
14
+ | <a id="property-meta"></a> `meta?` | `Record`\<`string`, `unknown`\> | Original state meta object | [types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L15) |
15
+ | <a id="property-route"></a> `route?` | `string` | Extracted route path from meta.route (string form) | [types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L17) |
16
+ | <a id="property-stateid"></a> `stateId` | `string` | XState state ID (e.g., "test.dashboard.overview") | [types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L11) |
17
+ | <a id="property-type"></a> `type` | `"atomic"` \| `"compound"` \| `"parallel"` \| `"final"` \| `"history"` | State type from XState | [types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L13) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayActor
4
4
 
5
- Defined in: [types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L297)
5
+ Defined in: [types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L297)
6
6
 
7
7
  Full actor shape used by `PlayRouterProvider` components across all framework
8
8
  adapters (`play-solid-router`, `play-vue-router`, `play-react-router`, and the
@@ -37,9 +37,9 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
37
37
 
38
38
  | Property | Modifier | Type | Description | Inherited from | Defined in |
39
39
  | ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
40
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [`RoutableActor`](RoutableActor.md).[`currentRoute`](RoutableActor.md#property-currentroute) | [types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L261) |
41
- | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive. | - | [types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L299) |
42
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](RoutableActor.md).[`initialRoute`](RoutableActor.md#property-initialroute) | [types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L267) |
40
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [`RoutableActor`](RoutableActor.md).[`currentRoute`](RoutableActor.md#property-currentroute) | [types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L261) |
41
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive. | - | [types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L299) |
42
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](RoutableActor.md).[`initialRoute`](RoutableActor.md#property-initialroute) | [types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L267) |
43
43
 
44
44
  ## Methods
45
45
 
@@ -49,7 +49,7 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
49
49
  send(event): void;
50
50
  ```
51
51
 
52
- Defined in: [types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L269)
52
+ Defined in: [types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L269)
53
53
 
54
54
  Send a route navigation event to the actor.
55
55
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L225)
5
+ Defined in: [types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L225)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -122,8 +122,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
122
122
 
123
123
  | Property | Modifier | Type | Defined in |
124
124
  | -------------------------------------- | ---------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
125
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L230) |
126
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L228) |
127
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L229) |
128
- | <a id="property-to"></a> `to` | `readonly` | `string` | [types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L227) |
129
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L226) |
125
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L230) |
126
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L228) |
127
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L229) |
128
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L227) |
129
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L226) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ResolvedRoutePath
4
4
 
5
- Defined in: [validate-routes.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/validate-routes.ts#L9)
5
+ Defined in: [validate-routes.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/validate-routes.ts#L9)
6
6
 
7
7
  A route entry with its RESOLVED full path — the path after relative routes have
8
8
  been prefixed with their parent's full path during tree construction.
@@ -13,5 +13,5 @@ been prefixed with their parent's full path during tree construction.
13
13
 
14
14
  | Property | Type | Description | Defined in |
15
15
  | ----------------------------------------- | -------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
16
- | <a id="property-fullpath"></a> `fullPath` | `string` | Resolved absolute route path (e.g. `"/dashboard/settings"`). | [validate-routes.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/validate-routes.ts#L13) |
17
- | <a id="property-stateid"></a> `stateId` | `string` | State identifier owning the route (e.g. `"app.dashboard.settings"`). | [validate-routes.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/validate-routes.ts#L11) |
16
+ | <a id="property-fullpath"></a> `fullPath` | `string` | Resolved absolute route path (e.g. `"/dashboard/settings"`). | [validate-routes.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/validate-routes.ts#L13) |
17
+ | <a id="property-stateid"></a> `stateId` | `string` | State identifier owning the route (e.g. `"app.dashboard.settings"`). | [validate-routes.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/validate-routes.ts#L11) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RoutableActor
4
4
 
5
- Defined in: [types.ts:259](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L259)
5
+ Defined in: [types.ts:259](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L259)
6
6
 
7
7
  Minimal actor interface required by `RouterBridgeBase` and all framework router
8
8
  adapters.
@@ -38,8 +38,8 @@ class MyBridge extends RouterBridgeBase {
38
38
 
39
39
  | Property | Modifier | Type | Description | Defined in |
40
40
  | ------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
41
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L261) |
42
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L267) |
41
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L261) |
42
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L267) |
43
43
 
44
44
  ## Methods
45
45
 
@@ -49,7 +49,7 @@ class MyBridge extends RouterBridgeBase {
49
49
  send(event): void;
50
50
  ```
51
51
 
52
- Defined in: [types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L269)
52
+ Defined in: [types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L269)
53
53
 
54
54
  Send a route navigation event to the actor.
55
55
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteInfo
4
4
 
5
- Defined in: [types.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L56)
5
+ Defined in: [types.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L56)
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:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L66) |
14
- | <a id="property-metadata"></a> `metadata` | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | Original route metadata | [types.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L73) |
15
- | <a id="property-pattern"></a> `pattern?` | `string` | Route pattern with parameters (e.g., /profile/:userId) if routePath contains params | [types.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L64) |
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:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L71) |
17
- | <a id="property-routepath"></a> `routePath` | `string` | Route path extracted from meta.route | [types.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L62) |
18
- | <a id="property-stateid"></a> `stateId` | `string` | State identifier (node.id or path.join('.')) | [types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L58) |
19
- | <a id="property-statepath"></a> `statePath` | `string`[] | State path segments from root | [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L60) |
13
+ | <a id="property-isabsolute"></a> `isAbsolute` | `boolean` | Whether route path is absolute (starts with /) | [types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L66) |
14
+ | <a id="property-metadata"></a> `metadata` | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | Original route metadata | [types.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L73) |
15
+ | <a id="property-pattern"></a> `pattern?` | `string` | Route pattern with parameters (e.g., /profile/:userId) if routePath contains params | [types.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L64) |
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:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L71) |
17
+ | <a id="property-routepath"></a> `routePath` | `string` | Route path extracted from meta.route | [types.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L62) |
18
+ | <a id="property-stateid"></a> `stateId` | `string` | State identifier (node.id or path.join('.')) | [types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L58) |
19
+ | <a id="property-statepath"></a> `statePath` | `string`[] | State path segments from root | [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L60) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapOptions
4
4
 
5
- Defined in: [create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/create-route-map.ts#L9)
5
+ Defined in: [create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/create-route-map.ts#L9)
6
6
 
7
7
  Options for `createRouteMap` and `createRouteMapFromTree`.
8
8
 
@@ -10,4 +10,4 @@ Options for `createRouteMap` and `createRouteMapFromTree`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
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.55/packages/play-router/src/create-route-map.ts#L20) |
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.57/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:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L51)
5
+ Defined in: [base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L51)
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:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L55) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L53) |
26
+ | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [base-route-map.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L55) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L53) |
@@ -2,11 +2,11 @@
2
2
 
3
3
  # Interface: RouteMatch
4
4
 
5
- Defined in: [router-sync.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-sync.ts#L12)
5
+ Defined in: [router-sync.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-sync.ts#L12)
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:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-sync.ts#L14) |
12
- | <a id="property-to"></a> `to` | `string` \| `null` \| `undefined` | [router-sync.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-sync.ts#L13) |
11
+ | <a id="property-params"></a> `params?` | `Record`\<`string`, `string`\> | [router-sync.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-sync.ts#L14) |
12
+ | <a id="property-to"></a> `to` | `string` \| `null` \| `undefined` | [router-sync.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-sync.ts#L13) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteNode
4
4
 
5
- Defined in: [types.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L79)
5
+ Defined in: [types.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L79)
6
6
 
7
7
  Node in the route tree representing a single route
8
8
 
@@ -10,12 +10,12 @@ Node in the route tree representing a single route
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ----------------------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-children"></a> `children` | `RouteNode`[] | Child routes | [types.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L103) |
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:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L92) |
15
- | <a id="property-id"></a> `id` | `string` | Unique identifier (state ID) | [types.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L81) |
16
- | <a id="property-metadata"></a> `metadata` | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | Original meta.route metadata | [types.ts:107](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L107) |
17
- | <a id="property-parent"></a> `parent` | `RouteNode` \| `null` | Parent route (null for root) | [types.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L105) |
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:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L86) |
19
- | <a id="property-pattern"></a> `pattern?` | `string` | Route pattern with parameters (e.g., /profile/:userId) if path contains params | [types.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L94) |
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:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L101) |
21
- | <a id="property-stateid"></a> `stateId` | `string` | XState state ID this route maps to | [types.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L96) |
13
+ | <a id="property-children"></a> `children` | `RouteNode`[] | Child routes | [types.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L103) |
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:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L92) |
15
+ | <a id="property-id"></a> `id` | `string` | Unique identifier (state ID) | [types.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L81) |
16
+ | <a id="property-metadata"></a> `metadata` | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | Original meta.route metadata | [types.ts:107](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L107) |
17
+ | <a id="property-parent"></a> `parent` | `RouteNode` \| `null` | Parent route (null for root) | [types.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L105) |
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:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L86) |
19
+ | <a id="property-pattern"></a> `pattern?` | `string` | Route pattern with parameters (e.g., /profile/:userId) if path contains params | [types.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L94) |
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:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L101) |
21
+ | <a id="property-stateid"></a> `stateId` | `string` | XState state ID this route maps to | [types.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L96) |