@xmachines/docs 1.0.0-beta.31 → 1.0.0-beta.33

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 (289) hide show
  1. package/api/@xmachines/play/README.md +5 -0
  2. package/api/@xmachines/play/classes/NonNullableError.md +189 -0
  3. package/api/@xmachines/play/classes/PlayError.md +9 -4
  4. package/api/@xmachines/play/functions/assertNonNullable.md +56 -0
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  6. package/api/@xmachines/play-actor/README.md +9 -9
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  9. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  10. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  11. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  13. package/api/@xmachines/play-dom/README.md +228 -39
  14. package/api/@xmachines/play-dom/classes/PlayRenderer.md +39 -26
  15. package/api/@xmachines/play-dom/functions/connectRenderer.md +39 -20
  16. package/api/@xmachines/play-dom/functions/createRenderer.md +43 -0
  17. package/api/@xmachines/play-dom/functions/defineRegistry.md +5 -5
  18. package/api/@xmachines/play-dom/functions/renderSpec.md +43 -9
  19. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  20. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +11 -9
  21. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +7 -7
  22. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +14 -9
  23. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  24. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +7 -5
  25. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +23 -7
  26. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  27. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +114 -0
  28. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +25 -0
  29. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  31. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +39 -0
  32. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/SetState.md +30 -0
  36. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  37. package/api/@xmachines/play-dom-router/README.md +166 -59
  38. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  39. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  40. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  41. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  42. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  43. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  44. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  45. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  46. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  47. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  48. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  49. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  50. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  51. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  52. package/api/@xmachines/play-react/README.md +1 -0
  53. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  54. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  55. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  56. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  57. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  58. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +9 -8
  59. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  60. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +22 -0
  61. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  62. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  63. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  64. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  65. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  66. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  67. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  68. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  69. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  70. package/api/@xmachines/play-router/README.md +1 -1
  71. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  72. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  73. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  74. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  75. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  76. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  77. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  78. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  79. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  80. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  81. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  82. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  83. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  84. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  85. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  86. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  87. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  88. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  89. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  90. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  91. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  92. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  93. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  94. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  95. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  96. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  97. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  98. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  99. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  100. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  101. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  102. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  103. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  104. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  105. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  106. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  107. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  108. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  109. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  110. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  111. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  112. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  113. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  114. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  115. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  116. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  117. package/api/@xmachines/play-solid/README.md +1 -0
  118. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  119. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +9 -8
  120. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  121. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +22 -0
  122. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  123. package/api/@xmachines/play-solid-router/README.md +2 -2
  124. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  125. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  126. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +28 -1
  127. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  128. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  129. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  130. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  131. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  132. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  133. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  134. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  135. package/api/@xmachines/play-svelte/README.md +52 -12
  136. package/api/@xmachines/play-svelte/functions/defineRegistry.md +12 -35
  137. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +24 -0
  138. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +9 -8
  139. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +30 -0
  140. package/api/@xmachines/play-svelte/type-aliases/Actions.md +17 -0
  141. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +23 -0
  142. package/api/@xmachines/play-svelte/type-aliases/SetState.md +21 -0
  143. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  144. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  145. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  146. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  147. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  148. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  149. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  150. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  151. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  152. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  153. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  154. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  155. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  156. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  157. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  158. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  159. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  160. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  161. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  162. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  163. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +8 -1
  164. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  165. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  166. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  167. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  168. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  169. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  170. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  171. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  172. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  173. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  174. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  175. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  176. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +9 -1
  177. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  178. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  179. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  180. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  181. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  182. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  183. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  184. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  185. package/api/@xmachines/play-vue/README.md +1 -0
  186. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  187. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  188. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +7 -6
  189. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  190. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  191. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  192. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  193. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +22 -0
  194. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  195. package/api/@xmachines/play-vue-router/README.md +3 -3
  196. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  197. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  198. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +39 -26
  199. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  200. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  201. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  202. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  203. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  204. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  205. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  206. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  207. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  208. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  209. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  210. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  211. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  212. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  213. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  214. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  215. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  216. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  217. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  218. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  219. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  220. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  221. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  222. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  223. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  224. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  225. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  226. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  227. package/api/@xmachines/shared/README.md +47 -47
  228. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  229. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  230. package/api/_media/README.md +321 -0
  231. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  232. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  233. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  234. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  235. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  236. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  237. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  238. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  239. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  240. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  241. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  242. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  243. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  244. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  245. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  246. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  247. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  248. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  249. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  250. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  251. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  252. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  253. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  254. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  255. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  256. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  257. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  258. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  259. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  260. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  261. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  262. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  263. package/examples/@xmachines/play-react-router-demo/README.md +1 -3
  264. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  265. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  266. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  267. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  268. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  269. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  270. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  271. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  272. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  273. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  274. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  275. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  276. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  277. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  278. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  279. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  280. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  281. package/examples/@xmachines/play-solid-router-demo/README.md +1 -3
  282. package/examples/README.md +2 -2
  283. package/examples/form-validation.md +80 -0
  284. package/examples/routing-patterns.md +9 -19
  285. package/guides/getting-started.md +51 -38
  286. package/guides/installation.md +6 -6
  287. package/package.json +6 -6
  288. package/rfc/play.md +19 -19
  289. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +0 -23
@@ -57,10 +57,10 @@ npm install @xmachines/play-svelte
57
57
 
58
58
  This package re-exports from `@json-render/svelte`:
59
59
 
60
- - `defineRegistry` — wire Svelte components into the Play catalog
60
+ - `defineRegistry` — wire Svelte components into the Play catalog (with catalog-typed action params — see below)
61
61
  - `getBoundProp` — two-way reactive binding helper for form inputs
62
62
 
63
- Types: `BaseComponentProps`, `ComponentFn`, `ComponentContext`
63
+ Types: `BaseComponentProps`, `ComponentFn`, `ComponentContext`, `RenderErrorHandler`
64
64
 
65
65
  For anything else (`schema`, `Renderer`, `JsonUIProvider`, context helpers), import from `@json-render/svelte` directly.
66
66
 
@@ -73,10 +73,14 @@ For anything else (`schema`, `Renderer`, `JsonUIProvider`, context helpers), imp
73
73
 
74
74
  ## Error handling
75
75
 
76
- `PlayRenderer` wraps its content in a Svelte 5 `<svelte:boundary>`. Two props control error behavior:
76
+ `PlayRenderer` has two layers of error boundaries:
77
77
 
78
- - **`fallback`**a Svelte snippet rendered when `currentView` is `null` (no active view) or when a catalog component throws during render.
79
- - **`onError`** — a callback invoked when a catalog component throws. Receives the error and a `reset` function that clears the boundary and attempts to re-render.
78
+ ### Outer boundary — `onError` and `fallback`
79
+
80
+ Wraps the entire renderer. Triggered when the spec state or store setup throws, or when the inner boundary is not present.
81
+
82
+ - **`fallback`** — a Svelte snippet rendered when `currentView` is `null` or when the outer boundary catches an error.
83
+ - **`onError`** — called when the outer boundary catches an error. Receives the error and a `reset` callback.
80
84
 
81
85
  ```svelte
82
86
  <PlayRenderer
@@ -84,14 +88,44 @@ For anything else (`schema`, `Renderer`, `JsonUIProvider`, context helpers), imp
84
88
  {registryResult}
85
89
  fallback={errorSnippet}
86
90
  onError={(error, reset) => {
87
- console.error("Render error:", error);
88
- // Optionally attempt recovery:
89
- // reset();
91
+ console.error("Outer render error:", error);
92
+ // reset(); // attempt recovery
93
+ }}
94
+ />
95
+ ```
96
+
97
+ ### Inner boundary — `onRenderError`
98
+
99
+ Each catalog element rendered by `@json-render/svelte` is individually wrapped in a `<svelte:boundary>`. When an element component throws, the failed component is silently removed from the DOM while the rest of the spec continues rendering. The outer `onError` / `fallback` are **not** triggered.
100
+
101
+ Pass `onRenderError` to `PlayRenderer` (or to `defineRegistry`) to receive these per-element errors instead of the default `console.error` logging:
102
+
103
+ ```svelte
104
+ <!-- via PlayRenderer prop -->
105
+ <PlayRenderer
106
+ {actor}
107
+ {registryResult}
108
+ onRenderError={(error, elementType) => {
109
+ console.warn(`<${elementType}> crashed:`, error);
110
+ reportToSentry(error, { component: elementType });
90
111
  }}
91
112
  />
92
113
  ```
93
114
 
94
- `onError` is optional. When omitted, render errors are silently caught by the boundary and `fallback` is shown if provided. The `reset` parameter follows Svelte 5's `<svelte:boundary onerror>` contract.
115
+ ```ts
116
+ // via defineRegistry — bakes the handler into the registry
117
+ const registryResult = defineRegistry(catalog, {
118
+ components: { Login, Dashboard },
119
+ actions: { ... },
120
+ onRenderError(error, elementType) {
121
+ myErrorReporter.capture(error, { elementType });
122
+ },
123
+ });
124
+ ```
125
+
126
+ When both are provided, the `PlayRenderer` prop wins — it creates a fresh registry copy with its own handler for that render.
127
+
128
+ `onRenderError` is typed as `RenderErrorHandler` and exported from `@xmachines/play-svelte`.
95
129
 
96
130
  @xmachines/play-svelte - Svelte renderer for XMachines Play architecture
97
131
 
@@ -99,20 +133,26 @@ Provides a thin Svelte rendering layer that passively observes actor signals
99
133
  and renders UI components via @json-render/svelte. Svelte reactivity is only
100
134
  used to trigger re-renders — signals are the source of truth.
101
135
 
102
- Re-exports `defineRegistry`, `getBoundProp`, `BaseComponentProps`, and
103
- `ComponentFn` from `@json-render/svelte` so consumers import everything
104
- from `@xmachines/play-svelte` rather than `@json-render/svelte` directly.
136
+ Re-exports `defineRegistry` (catalog-typed — action params are inferred from
137
+ the catalog schema), `getBoundProp`, `BaseComponentProps`, and `ComponentFn`
138
+ from `@json-render/svelte` so consumers import everything from
139
+ `@xmachines/play-svelte` rather than `@json-render/svelte` directly.
105
140
 
106
141
  ## Interfaces
107
142
 
108
143
  - [BaseComponentProps](interfaces/BaseComponentProps.md)
109
144
  - [ComponentContext](interfaces/ComponentContext.md)
145
+ - [DefineRegistryOptions](interfaces/DefineRegistryOptions.md)
110
146
  - [PlayRendererProps](interfaces/PlayRendererProps.md)
111
147
 
112
148
  ## Type Aliases
113
149
 
150
+ - [ActionFn](type-aliases/ActionFn.md)
151
+ - [Actions](type-aliases/Actions.md)
114
152
  - [ComponentFn](type-aliases/ComponentFn.md)
115
153
  - [PlayRenderer](type-aliases/PlayRenderer.md)
154
+ - [RenderErrorHandler](type-aliases/RenderErrorHandler.md)
155
+ - [SetState](type-aliases/SetState.md)
116
156
 
117
157
  ## Variables
118
158
 
@@ -3,52 +3,29 @@
3
3
  # Function: defineRegistry()
4
4
 
5
5
  ```ts
6
- function defineRegistry<C, TComponents>(_catalog, options): DefineRegistryResult;
6
+ function defineRegistry<C>(catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
- Defined in: `@json-render/svelte`
9
+ Defined in: [packages/play-svelte/src/define-registry.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/define-registry.ts#L152)
10
10
 
11
- Create a registry from a catalog with Svelte components and/or actions.
11
+ Create a component registry, restoring catalog-typed `params` on action handlers.
12
12
 
13
- Components must accept `BaseComponentProps` as their props interface.
13
+ Drop-in replacement for `defineRegistry` from `@json-render/svelte`. Import from
14
+ `@xmachines/play-svelte` to get per-action param type inference for free.
14
15
 
15
16
  ## Type Parameters
16
17
 
17
- | Type Parameter |
18
- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | `C` _extends_ `Catalog`\<`SchemaDefinition`\<`SchemaType`\<`string`, `unknown`\>, `SchemaType`\<`string`, `unknown`\>\>, `unknown`\> |
20
- | `TComponents` _extends_ `Record`\<`string`, `Component`\<[`BaseComponentProps`](../interfaces/BaseComponentProps.md)\<`any`\>, \{ \}, `string`\>\> |
18
+ | Type Parameter |
19
+ | ------------------------------------------------------------------------------------------------------------------------------------ |
20
+ | `C` _extends_ `Catalog`\<`SchemaDefinition`\<`SchemaType`\<`string`, `unknown`\>, `SchemaType`\<`string`, `unknown`\>\>, `unknown`\> |
21
21
 
22
22
  ## Parameters
23
23
 
24
- | Parameter | Type | Description |
25
- | --------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------ |
26
- | `_catalog` | `C` | - |
27
- | `options` | \{ `actions?`: `Record`\<`string`, `DefineRegistryActionFn`\>; `components?`: `TComponents`; \} | - |
28
- | `options.actions?` | `Record`\<`string`, `DefineRegistryActionFn`\> | Action handlers |
29
- | `options.components?` | `TComponents` | Svelte components that accept BaseComponentProps |
24
+ | Parameter | Type | Description |
25
+ | --------- | ------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
26
+ | `catalog` | `C` | The json-render catalog defining component prop shapes and action schemas. |
27
+ | `options` | [`DefineRegistryOptions`](../interfaces/DefineRegistryOptions.md)\<`C`\> | Registry options. `actions` entries receive params typed from the catalog. |
30
28
 
31
29
  ## Returns
32
30
 
33
31
  `DefineRegistryResult`
34
-
35
- ## Example
36
-
37
- ```ts
38
- import { defineRegistry } from "@json-render/svelte";
39
- import Card from "./components/Card.svelte";
40
- import Button from "./components/Button.svelte";
41
- import { myCatalog } from "./catalog";
42
-
43
- const { registry, handlers } = defineRegistry(myCatalog, {
44
- components: {
45
- Card,
46
- Button,
47
- },
48
- actions: {
49
- submit: async (params, setState) => {
50
- // handle action
51
- },
52
- },
53
- });
54
- ```
@@ -0,0 +1,24 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / DefineRegistryOptions
2
+
3
+ # Interface: DefineRegistryOptions\<C\>
4
+
5
+ Defined in: [packages/play-svelte/src/define-registry.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/define-registry.ts#L91)
6
+
7
+ Options for `defineRegistry`.
8
+
9
+ Mirrors the upstream shape but replaces the untyped
10
+ `Record<string, DefineRegistryActionFn>` with a catalog-typed `Actions<C>` map.
11
+
12
+ ## Type Parameters
13
+
14
+ | Type Parameter |
15
+ | ----------------------- |
16
+ | `C` _extends_ `Catalog` |
17
+
18
+ ## Properties
19
+
20
+ | Property | Type | Description | Defined in |
21
+ | ---------------------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22
+ | <a id="property-actions"></a> `actions?` | [`Actions`](../type-aliases/Actions.md)\<`C`\> | Catalog-typed action handler map. Each handler receives `params` typed to the exact schema defined in the catalog action (or `undefined` if no params were provided), plus the upstream `setState` and `state` arguments. Guard against `undefined` before accessing params: **Example** `actions: { login: async (params) => { if (!params) return; actor.send({ type: "auth.login", username: params.username }); }, logout: async () => actor.send({ type: "auth.logout" }), }` | [packages/play-svelte/src/define-registry.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/define-registry.ts#L115) |
23
+ | <a id="property-components"></a> `components?` | `Components`\<`C`\> | Svelte component implementations — keyed by catalog component name. | [packages/play-svelte/src/define-registry.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/define-registry.ts#L95) |
24
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Callback invoked when a catalog component throws during render. The error is caught by `@json-render/svelte`'s inner `<svelte:boundary>` that wraps each rendered element. When provided, this callback replaces the default `console.error(...)` fallback — the component is silently removed from the DOM and your callback receives the error and the element type name for custom error reporting or recovery logic. **Example** `const { registry, handlers } = defineRegistry(authCatalog, { components: { Login, Dashboard }, actions: { ... }, onRenderError(error, elementType) { console.warn(`Component <${elementType}> crashed:`, error); reportToSentry(error, { componentType: elementType }); }, });` **Param** The thrown value (not necessarily an `Error` instance). **Param** The catalog component name that crashed (e.g. `"Dashboard"`). | [packages/play-svelte/src/define-registry.ts:140](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/define-registry.ts#L140) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRendererProps\<TLogic\>
4
4
 
5
- Defined in: [packages/play-svelte/src/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte/src/types.ts#L13)
5
+ Defined in: [packages/play-svelte/src/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/types.ts#L13)
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -12,10 +12,11 @@ Defined in: [packages/play-svelte/src/types.ts:13](https://gitlab.com/xmachin-es
12
12
 
13
13
  ## Properties
14
14
 
15
- | Property | Type | Description | Defined in |
16
- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | - | [packages/play-svelte/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte/src/types.ts#L14) |
18
- | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | Svelte snippet rendered when currentView is null (no active view). Also shown when a catalog component throws during render. | [packages/play-svelte/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte/src/types.ts#L29) |
19
- | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | Called when a catalog component throws during render. Receives the thrown error and a `reset` function that clears the boundary and attempts to re-render. Matches Svelte 5's `<svelte:boundary onerror>` signature. | [packages/play-svelte/src/types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte/src/types.ts#L36) |
20
- | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry()contains component registry and action handlers. Action handlers are async functions that dispatch to the actor (not string-mapped event type stubs). Replaces the old `registry` + `actions` prop pair. | [packages/play-svelte/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte/src/types.ts#L21) |
21
- | <a id="property-store"></a> `store?` | `StateStore` | - | [packages/play-svelte/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte/src/types.ts#L23) |
15
+ | Property | Type | Description | Defined in |
16
+ | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
17
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | - | [packages/play-svelte/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/types.ts#L14) |
18
+ | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | Svelte snippet rendered when currentView is null (no active view). Also shown when a catalog component throws during render. | [packages/play-svelte/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/types.ts#L29) |
19
+ | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | Called when a catalog component throws during render. Receives the thrown error and a `reset` function that clears the boundary and attempts to re-render. Matches Svelte 5's `<svelte:boundary onerror>` signature. | [packages/play-svelte/src/types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/types.ts#L36) |
20
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Caught by the inner `<svelte:boundary>` inside each rendered element the failed component is silently removed from the DOM while the rest of the spec continues rendering. Unlike `onError`, this does not take a `reset` callback because the inner boundary never re-renders the failed element. When not provided, `@json-render/svelte` logs the error to `console.error`. **Example** `<PlayRenderer {actor} {registryResult} onRenderError={(error, elementType) => { console.warn(`<${elementType}> crashed:`, error); }} />` | [packages/play-svelte/src/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/types.ts#L60) |
21
+ | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains component registry and action handlers. Action handlers are async functions that dispatch to the actor (not string-mapped event type stubs). Replaces the old `registry` + `actions` prop pair. | [packages/play-svelte/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/types.ts#L21) |
22
+ | <a id="property-store"></a> `store?` | `StateStore` | - | [packages/play-svelte/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/types.ts#L23) |
@@ -0,0 +1,30 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / ActionFn
2
+
3
+ # Type Alias: ActionFn\<C, K\>
4
+
5
+ ```ts
6
+ type ActionFn<C, K> = (params, setState, state) => Promise<void>;
7
+ ```
8
+
9
+ Defined in: `@json-render/svelte`
10
+
11
+ Action handler function type
12
+
13
+ ## Type Parameters
14
+
15
+ | Type Parameter |
16
+ | ------------------------------------------------ |
17
+ | `C` _extends_ `Catalog` |
18
+ | `K` _extends_ keyof `InferCatalogActions`\<`C`\> |
19
+
20
+ ## Parameters
21
+
22
+ | Parameter | Type |
23
+ | ---------- | ---------------------------------------------- |
24
+ | `params` | `InferActionParams`\<`C`, `K`\> \| `undefined` |
25
+ | `setState` | [`SetState`](SetState.md) |
26
+ | `state` | `StateModel` |
27
+
28
+ ## Returns
29
+
30
+ `Promise`\<`void`\>
@@ -0,0 +1,17 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / Actions
2
+
3
+ # Type Alias: Actions\<C\>
4
+
5
+ ```ts
6
+ type Actions<C> = { [K in keyof InferCatalogActions<C>]: ActionFn<C, K> };
7
+ ```
8
+
9
+ Defined in: `@json-render/svelte`
10
+
11
+ Registry of all action handlers for a catalog
12
+
13
+ ## Type Parameters
14
+
15
+ | Type Parameter |
16
+ | ----------------------- |
17
+ | `C` _extends_ `Catalog` |
@@ -0,0 +1,23 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / RenderErrorHandler
2
+
3
+ # Type Alias: RenderErrorHandler
4
+
5
+ ```ts
6
+ type RenderErrorHandler = (error, elementType) => void;
7
+ ```
8
+
9
+ Defined in: `@json-render/svelte`
10
+
11
+ Registry of component renderers.
12
+ Maps component type names to Svelte components.
13
+
14
+ ## Parameters
15
+
16
+ | Parameter | Type |
17
+ | ------------- | --------- |
18
+ | `error` | `unknown` |
19
+ | `elementType` | `string` |
20
+
21
+ ## Returns
22
+
23
+ `void`
@@ -0,0 +1,21 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / SetState
2
+
3
+ # Type Alias: SetState
4
+
5
+ ```ts
6
+ type SetState = (updater) => void;
7
+ ```
8
+
9
+ Defined in: `@json-render/svelte`
10
+
11
+ State setter function for updating application state
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type |
16
+ | --------- | ------------------------------------------- |
17
+ | `updater` | (`prev`) => `Record`\<`string`, `unknown`\> |
18
+
19
+ ## Returns
20
+
21
+ `void`
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L100)
5
+ Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L100)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -50,7 +50,7 @@ map.getPathByStateId("missing"); // null
50
50
  new RouteMap(mappings, options?): BaseRouteMap;
51
51
  ```
52
52
 
53
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L125)
53
+ Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L125)
54
54
 
55
55
  Build a route map from an array of state ID ↔ path mappings.
56
56
 
@@ -78,7 +78,7 @@ buckets for efficient candidate selection.
78
78
  getPathByStateId(stateId): string | null;
79
79
  ```
80
80
 
81
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L209)
81
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L209)
82
82
 
83
83
  Look up the path pattern registered for a state ID.
84
84
 
@@ -109,7 +109,7 @@ map.getPathByStateId("missing"); // null
109
109
  getStateIdByPath(path): string | null;
110
110
  ```
111
111
 
112
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L174)
112
+ Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L174)
113
113
 
114
114
  Resolve a URL path to its mapped state ID.
115
115
 
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [play-svelte-spa-router/src/connect-router.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte-spa-router/src/connect-router.ts#L30)
9
+ Defined in: [play-svelte-spa-router/src/connect-router.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte-spa-router/src/connect-router.ts#L30)
10
10
 
11
11
  Connect svelte-spa-router to actor.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/create-route-map-from-machine.ts#L26)
9
+ Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/create-route-map-from-machine.ts#L26)
10
10
 
11
11
  Create a `BaseRouteMap` from an XState state machine.
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ConnectRouterOptions
4
4
 
5
- Defined in: [play-svelte-spa-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte-spa-router/src/connect-router.ts#L7)
5
+ Defined in: [play-svelte-spa-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte-spa-router/src/connect-router.ts#L7)
6
6
 
7
7
  @xmachines/play-svelte-spa-router
8
8
 
@@ -12,6 +12,6 @@ Svelte SPA router adapter for XMachines Play architecture.
12
12
 
13
13
  | Property | Modifier | Type | Description | Defined in |
14
14
  | ----------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | - | [play-svelte-spa-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte-spa-router/src/connect-router.ts#L8) |
16
- | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-svelte-spa-router/src/connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte-spa-router/src/connect-router.ts#L9) |
17
- | <a id="property-window"></a> `window?` | `readonly` | [`WindowLike`](WindowLike.md) | Window-like object for `hashchange` subscriptions. Defaults to the global `window`. Pass a mock in tests or a no-op in SSR environments. | [play-svelte-spa-router/src/connect-router.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte-spa-router/src/connect-router.ts#L14) |
15
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | - | [play-svelte-spa-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte-spa-router/src/connect-router.ts#L8) |
16
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-svelte-spa-router/src/connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte-spa-router/src/connect-router.ts#L9) |
17
+ | <a id="property-window"></a> `window?` | `readonly` | [`WindowLike`](WindowLike.md) | Window-like object for `hashchange` subscriptions. Defaults to the global `window`. Pass a mock in tests or a no-op in SSR environments. | [play-svelte-spa-router/src/connect-router.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte-spa-router/src/connect-router.ts#L14) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L223)
5
+ Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L223)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -112,8 +112,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
112
112
 
113
113
  | Property | Modifier | Type | Defined in |
114
114
  | -------------------------------------- | ---------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
115
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L228) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L226) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L227) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L225) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L224) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L228) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L226) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L227) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L225) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L224) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L57)
5
+ Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L57)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: BaseRouteMapping = { stateId: "settings", path: "/setting
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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"`) | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/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"`) | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L59) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L271)
5
+ Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L271)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L287)
57
+ Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L287)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L303)
86
+ Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L303)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: WindowLike
4
4
 
5
- Defined in: [play-router/src/types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L324)
5
+ Defined in: [play-router/src/types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L324)
6
6
 
7
7
  Minimal window interface required by adapters that subscribe to DOM events
8
8
  (e.g. `hashchange`). Injectable for SSR and testing — pass a mock instead of
@@ -30,7 +30,7 @@ connectRouter({ actor, routeMap, window: mockWin });
30
30
  addEventListener(type, listener): void;
31
31
  ```
32
32
 
33
- Defined in: [play-router/src/types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L325)
33
+ Defined in: [play-router/src/types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L325)
34
34
 
35
35
  #### Parameters
36
36
 
@@ -51,7 +51,7 @@ Defined in: [play-router/src/types.ts:325](https://gitlab.com/xmachin-es/xmachin
51
51
  removeEventListener(type, listener): void;
52
52
  ```
53
53
 
54
- Defined in: [play-router/src/types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L326)
54
+ Defined in: [play-router/src/types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L326)
55
55
 
56
56
  #### Parameters
57
57
 
@@ -6,4 +6,4 @@
6
6
  type RoutableActor = AbstractActor<AnyActorLogic> & Routable;
7
7
  ```
8
8
 
9
- Defined in: [play-svelte-spa-router/src/types.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte-spa-router/src/types.ts#L6)
9
+ Defined in: [play-svelte-spa-router/src/types.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte-spa-router/src/types.ts#L6)
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L100)
5
+ Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L100)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -50,7 +50,7 @@ map.getPathByStateId("missing"); // null
50
50
  new RouteMap(mappings, options?): BaseRouteMap;
51
51
  ```
52
52
 
53
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L125)
53
+ Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L125)
54
54
 
55
55
  Build a route map from an array of state ID ↔ path mappings.
56
56
 
@@ -78,7 +78,7 @@ buckets for efficient candidate selection.
78
78
  getPathByStateId(stateId): string | null;
79
79
  ```
80
80
 
81
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L209)
81
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L209)
82
82
 
83
83
  Look up the path pattern registered for a state ID.
84
84
 
@@ -109,7 +109,7 @@ map.getPathByStateId("missing"); // null
109
109
  getStateIdByPath(path): string | null;
110
110
  ```
111
111
 
112
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L174)
112
+ Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L174)
113
113
 
114
114
  Resolve a URL path to its mapped state ID.
115
115
 
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [play-sveltekit-router/src/connect-router.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-sveltekit-router/src/connect-router.ts#L29)
9
+ Defined in: [play-sveltekit-router/src/connect-router.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-sveltekit-router/src/connect-router.ts#L29)
10
10
 
11
11
  Connect SvelteKit router to actor.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/create-route-map-from-machine.ts#L26)
9
+ Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/create-route-map-from-machine.ts#L26)
10
10
 
11
11
  Create a `BaseRouteMap` from an XState state machine.
12
12