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

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 (272) hide show
  1. package/api/@xmachines/play/classes/PlayError.md +4 -4
  2. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  3. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  4. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  5. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  6. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  7. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  8. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  9. package/api/@xmachines/play-dom/README.md +40 -10
  10. package/api/@xmachines/play-dom/classes/PlayRenderer.md +20 -12
  11. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  12. package/api/@xmachines/play-dom/functions/defineRegistry.md +8 -21
  13. package/api/@xmachines/play-dom/functions/renderSpec.md +15 -13
  14. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +9 -48
  15. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  16. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +7 -9
  17. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +7 -8
  18. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +9 -12
  19. package/api/@xmachines/play-dom/interfaces/EventHandle.md +6 -20
  20. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +5 -5
  21. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +30 -0
  22. package/api/@xmachines/play-dom/type-aliases/Actions.md +18 -0
  23. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -28
  24. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -7
  25. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -17
  26. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -6
  27. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +9 -0
  28. package/api/@xmachines/play-dom/variables/schema.md +56 -0
  29. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  30. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  31. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  32. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  33. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  34. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  35. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  36. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  37. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  38. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  39. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  40. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  41. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  42. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  43. package/api/@xmachines/play-react/README.md +29 -32
  44. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  45. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  46. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  47. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  48. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  49. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +11 -12
  50. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  51. package/api/@xmachines/play-react/variables/PlayRenderer.md +12 -5
  52. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  53. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  54. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  55. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  56. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  57. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  58. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  59. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  60. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  61. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  62. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  63. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  64. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  65. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  66. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  67. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  68. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  69. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  70. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  71. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  72. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  73. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  74. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  75. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  76. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  77. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  78. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  79. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  80. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  81. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  82. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  83. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  84. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  85. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  86. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  87. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  88. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  89. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  90. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  91. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  92. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  93. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  94. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  95. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  96. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  97. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  98. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  99. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  100. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  101. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  102. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  103. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  104. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  105. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  106. package/api/@xmachines/play-solid/README.md +28 -29
  107. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  108. package/api/@xmachines/play-solid/functions/useBoundProp.md +45 -0
  109. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +11 -12
  110. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  111. package/api/@xmachines/play-solid/variables/PlayRenderer.md +4 -25
  112. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  113. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  114. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  115. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  116. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  117. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  118. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  119. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  120. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  121. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  122. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  123. package/api/@xmachines/play-svelte/README.md +15 -4
  124. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +8 -9
  125. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  126. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  127. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  128. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  129. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  130. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  131. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  132. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  133. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  134. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  135. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  136. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  137. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  138. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  139. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  140. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  141. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  142. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  143. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  144. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  145. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  146. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  147. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  148. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  149. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  150. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  151. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  152. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  153. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  154. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  155. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  156. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  157. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  158. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  159. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  160. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  161. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  162. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  163. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  164. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  165. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  166. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  167. package/api/@xmachines/play-vue/README.md +33 -33
  168. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  169. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  170. package/api/@xmachines/play-vue/functions/useBoundProp.md +45 -0
  171. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +9 -10
  172. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  173. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  174. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  175. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  176. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  177. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  178. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  179. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  180. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  181. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  182. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  183. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  184. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  185. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  186. package/api/@xmachines/play-xstate/README.md +1 -0
  187. package/api/@xmachines/play-xstate/classes/PlayerActor.md +54 -23
  188. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  189. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  190. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  191. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  192. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  193. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  194. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  195. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  196. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  197. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  198. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  199. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  200. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  201. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  202. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  203. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  204. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  205. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  206. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  207. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  208. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  209. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  210. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  211. package/examples/@xmachines/play-dom-demo/README.md +7 -0
  212. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +23 -0
  213. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  214. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +9 -0
  215. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  216. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  217. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  218. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  219. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  220. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +9 -0
  221. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  222. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  223. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  224. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  225. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  226. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +172 -0
  227. package/examples/@xmachines/play-react-demo/README.md +9 -3
  228. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  229. package/examples/@xmachines/play-react-demo/functions/DebugPanel.md +1 -1
  230. package/examples/@xmachines/play-react-demo/functions/HeaderNav.md +1 -1
  231. package/examples/@xmachines/play-react-demo/functions/Shell.md +1 -1
  232. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +9 -0
  233. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  234. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  235. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  236. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +11 -0
  237. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  238. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  239. package/examples/@xmachines/play-react-demo/variables/NavBar.md +11 -0
  240. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +9 -0
  241. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  242. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  243. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  244. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  245. package/examples/@xmachines/play-react-demo/variables/Shell.md +13 -0
  246. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  247. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +172 -0
  248. package/examples/@xmachines/play-solid-demo/README.md +9 -3
  249. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  250. package/examples/@xmachines/play-solid-demo/functions/DebugPanel.md +1 -1
  251. package/examples/@xmachines/play-solid-demo/functions/HeaderNav.md +1 -1
  252. package/examples/@xmachines/play-solid-demo/functions/Shell.md +1 -1
  253. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +9 -0
  254. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  255. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  256. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  257. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +11 -0
  258. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  259. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  260. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +11 -0
  261. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +12 -0
  262. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  263. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  264. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  265. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  266. package/examples/@xmachines/play-solid-demo/variables/Shell.md +13 -0
  267. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  268. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +172 -0
  269. package/package.json +2 -2
  270. package/api/@xmachines/play-react/functions/useStateBinding.md +0 -34
  271. package/api/@xmachines/play-solid/functions/useStateBinding.md +0 -25
  272. package/api/@xmachines/play-vue/functions/useStateBinding.md +0 -32
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: WindowLike
4
4
 
5
- Defined in: [types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/types.ts#L324)
5
+ Defined in: [types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L324)
6
6
 
7
7
  Minimal window interface required by adapters that subscribe to DOM events
8
8
  (e.g. `hashchange`). Injectable for SSR and testing — pass a mock instead of
@@ -30,7 +30,7 @@ connectRouter({ actor, routeMap, window: mockWin });
30
30
  addEventListener(type, listener): void;
31
31
  ```
32
32
 
33
- Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/types.ts#L325)
33
+ Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L325)
34
34
 
35
35
  #### Parameters
36
36
 
@@ -51,7 +51,7 @@ Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.
51
51
  removeEventListener(type, listener): void;
52
52
  ```
53
53
 
54
- Defined in: [types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/types.ts#L326)
54
+ Defined in: [types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L326)
55
55
 
56
56
  #### Parameters
57
57
 
@@ -6,7 +6,7 @@
6
6
  type MachineGraph = Graph<MachineNodeData, MachineEdgeData>;
7
7
  ```
8
8
 
9
- Defined in: [machine-to-graph.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/machine-to-graph.ts#L17)
9
+ Defined in: [machine-to-graph.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/machine-to-graph.ts#L17)
10
10
 
11
11
  Typed @statelyai/graph Graph representing a state machine.
12
12
  Provides hierarchy queries, traversal algorithms, and reachability checks.
@@ -6,6 +6,6 @@
6
6
  type RouteMetadata = string | RouteObject;
7
7
  ```
8
8
 
9
- Defined in: [types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/types.ts#L49)
9
+ Defined in: [types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L49)
10
10
 
11
11
  Route metadata from state machine `meta.route` field.
@@ -6,7 +6,7 @@
6
6
  function watchSignal<T>(signal, onValue): () => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-signals/src/watch-signal.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/watch-signal.ts#L21)
9
+ Defined in: [packages/play-signals/src/watch-signal.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/watch-signal.ts#L21)
10
10
 
11
11
  Subscribe to a single signal using the canonical one-shot watcher lifecycle.
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ComputedOptions\<T\>
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/types.ts#L84)
5
+ Defined in: [packages/play-signals/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/types.ts#L84)
6
6
 
7
7
  Options for creating Signal.Computed
8
8
 
@@ -31,4 +31,4 @@ const options: ComputedOptions<string> = {
31
31
 
32
32
  | Property | Type | Description | Defined in |
33
33
  | -------------------------------------- | ----------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
34
- | <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for memoization | [packages/play-signals/src/types.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/types.ts#L88) |
34
+ | <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for memoization | [packages/play-signals/src/types.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/types.ts#L88) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: SignalComputed\<T\>
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/types.ts#L111)
5
+ Defined in: [packages/play-signals/src/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/types.ts#L111)
6
6
 
7
7
  Lazily-evaluated, memoized computed signal
8
8
 
@@ -38,7 +38,7 @@ console.log(doubled.get()); // 10 (memoized, not recomputed)
38
38
  get(): T;
39
39
  ```
40
40
 
41
- Defined in: [packages/play-signals/src/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/types.ts#L117)
41
+ Defined in: [packages/play-signals/src/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/types.ts#L117)
42
42
 
43
43
  Read computed value (recalculates only if dependencies changed)
44
44
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: SignalOptions\<T\>
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/types.ts#L26)
5
+ Defined in: [packages/play-signals/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/types.ts#L26)
6
6
 
7
7
  Options for creating Signal.State
8
8
 
@@ -32,4 +32,4 @@ const count = new Signal.State(0, options);
32
32
 
33
33
  | Property | Type | Description | Defined in |
34
34
  | -------------------------------------- | ----------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
35
- | <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for determining if value changed | [packages/play-signals/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/types.ts#L33) |
35
+ | <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for determining if value changed | [packages/play-signals/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/types.ts#L33) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: SignalState\<T\>
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/types.ts#L53)
5
+ Defined in: [packages/play-signals/src/types.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/types.ts#L53)
6
6
 
7
7
  Writable state signal holding a single reactive value
8
8
 
@@ -35,7 +35,7 @@ console.log(name.get()); // 'Bob'
35
35
  get(): T;
36
36
  ```
37
37
 
38
- Defined in: [packages/play-signals/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/types.ts#L59)
38
+ Defined in: [packages/play-signals/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/types.ts#L59)
39
39
 
40
40
  Read current value and track as dependency
41
41
 
@@ -53,7 +53,7 @@ Current value of the signal
53
53
  set(value): void;
54
54
  ```
55
55
 
56
- Defined in: [packages/play-signals/src/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/types.ts#L66)
56
+ Defined in: [packages/play-signals/src/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/types.ts#L66)
57
57
 
58
58
  Write new value and notify watchers if changed
59
59
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: SignalWatcher
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/types.ts#L167)
5
+ Defined in: [packages/play-signals/src/types.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/types.ts#L167)
6
6
 
7
7
  Watcher for observing signal changes and scheduling effects
8
8
 
@@ -40,7 +40,7 @@ getPending(): (
40
40
  | SignalComputed<unknown>)[];
41
41
  ```
42
42
 
43
- Defined in: [packages/play-signals/src/types.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/types.ts#L187)
43
+ Defined in: [packages/play-signals/src/types.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/types.ts#L187)
44
44
 
45
45
  Get signals that changed since last check
46
46
 
@@ -60,7 +60,7 @@ Array of signals that have pending updates
60
60
  unwatch(signal): void;
61
61
  ```
62
62
 
63
- Defined in: [packages/play-signals/src/types.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/types.ts#L180)
63
+ Defined in: [packages/play-signals/src/types.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/types.ts#L180)
64
64
 
65
65
  Stop watching a signal
66
66
 
@@ -82,7 +82,7 @@ Stop watching a signal
82
82
  watch(signal): void;
83
83
  ```
84
84
 
85
- Defined in: [packages/play-signals/src/types.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/types.ts#L173)
85
+ Defined in: [packages/play-signals/src/types.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/types.ts#L173)
86
86
 
87
87
  Start watching a signal for changes
88
88
 
@@ -6,7 +6,7 @@
6
6
  type WatcherNotify = () => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-signals/src/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-signals/src/types.ts#L139)
9
+ Defined in: [packages/play-signals/src/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-signals/src/types.ts#L139)
10
10
 
11
11
  Notification callback for Signal.subtle.Watcher
12
12
 
@@ -38,7 +38,7 @@ without muting console output.
38
38
  - `PlayRenderer` — main renderer component
39
39
  - `useActor` — hook for accessing the actor inside a `PlayRenderer` tree
40
40
  - `defineRegistry` — re-exported from `@json-render/solid`
41
- - `useStateBinding` — re-exported from `@json-render/solid`
41
+ - `useBoundProp` — re-exported from `@json-render/solid`
42
42
  - `ComponentFn` (type) — re-exported from `@json-render/solid`
43
43
  - `ComponentContext` (type) — re-exported from `@json-render/solid`
44
44
  - `PlayRendererProps` (type)
@@ -83,9 +83,17 @@ const Dashboard: ComponentFn<typeof catalog, "Dashboard"> = ({ props }) => (
83
83
  );
84
84
 
85
85
  // 3. Build registry
86
- const { registry } = defineRegistry(catalog, {
86
+ const registryResult = defineRegistry(catalog, {
87
87
  components: { Login, Dashboard },
88
- actions: { login: async () => {}, logout: async () => {} },
88
+ actions: {
89
+ login: async (params) => {
90
+ if (!params) return;
91
+ actor.send({ type: "auth.login", username: params.username });
92
+ },
93
+ logout: async (params) => {
94
+ actor.send({ type: "auth.logout" });
95
+ },
96
+ },
89
97
  });
90
98
 
91
99
  // 4. Define machine with view metadata
@@ -160,13 +168,7 @@ const actor = createPlayer();
160
168
  actor.start();
161
169
 
162
170
  function App() {
163
- return (
164
- <PlayRenderer
165
- actor={actor}
166
- registry={registry}
167
- actions={{ login: "auth.login", logout: "auth.logout" }}
168
- />
169
- );
171
+ return <PlayRenderer actor={actor} registryResult={registryResult} />;
170
172
  }
171
173
  ```
172
174
 
@@ -179,8 +181,7 @@ Main component. Subscribes to `actor.currentView` and renders the spec.
179
181
  ```tsx
180
182
  <PlayRenderer
181
183
  actor={actor}
182
- registry={registry}
183
- actions={{ login: "auth.login" }}
184
+ registryResult={registryResult}
184
185
  store={myStore}
185
186
  fallback={<p>Loading…</p>}
186
187
  />
@@ -188,21 +189,11 @@ Main component. Subscribes to `actor.currentView` and renders the spec.
188
189
 
189
190
  **`actor`** — A `PlayerActor` (or any `AbstractActor & Viewable`). Provides the `currentView` signal.
190
191
 
191
- **`registry`** — Built with `defineRegistry(catalog, { components, actions })` from `@xmachines/play-solid`.
192
+ **`registryResult`** — The full `DefineRegistryResult` returned by `defineRegistry(catalog, { components, actions })` from `@xmachines/play-solid`.
192
193
 
193
194
  `defineRegistry` also accepts `onRenderError(error, elementType)`, which receives errors
194
195
  caught by `@json-render/solid`'s inner element boundary before the default logger is used.
195
196
 
196
- **`actions`** — Maps json-render action names (from spec `on` bindings) to XState event type strings. Type-checked against `EventFromLogic<TLogic>["type"]` when `TLogic` is specified:
197
-
198
- ```tsx
199
- <PlayRenderer<typeof machine>
200
- actor={actor}
201
- registry={registry}
202
- actions={{ login: "auth.login", logout: "auth.logout" }}
203
- />
204
- ```
205
-
206
197
  **`store`** (optional) — Controls per-view UI state (`$state` bindings, form values):
207
198
 
208
199
  - **Omitted (uncontrolled, default):** A fresh `@xstate/store` atom is created per view transition, seeded from `view.spec.state`.
@@ -215,16 +206,24 @@ import type { StateStore } from "@json-render/core";
215
206
 
216
207
  const store: StateStore = xstateStoreStateStore({ atom: createAtom({ username: "" }) });
217
208
 
218
- <PlayRenderer actor={actor} registry={registry} store={store} actions={{ login: "auth.login" }} />;
209
+ <PlayRenderer actor={actor} registryResult={registryResult} store={store} />;
219
210
  ```
220
211
 
221
212
  **Inner render errors** — You can intercept catalog component render failures without
222
213
  overriding the outer Solid error boundary:
223
214
 
224
215
  ```tsx
225
- const { registry } = defineRegistry(catalog, {
216
+ const registryResult = defineRegistry(catalog, {
226
217
  components: { Login, Dashboard },
227
- actions: { login: async () => {}, logout: async () => {} },
218
+ actions: {
219
+ login: async (params) => {
220
+ if (!params) return;
221
+ actor.send({ type: "auth.login", username: params.username });
222
+ },
223
+ logout: async (params) => {
224
+ actor.send({ type: "auth.logout" });
225
+ },
226
+ },
228
227
  onRenderError(error, elementType) {
229
228
  reportExpectedRenderError(error, elementType);
230
229
  },
@@ -272,7 +271,7 @@ Priority: **route param fills `undefined` slots; explicit non-`undefined` spec p
272
271
  - SolidJS signals are only used to trigger re-renders — not for business logic
273
272
  - `actor.currentView` (TC39 Signal) is bridged into a SolidJS `createSignal` inside `PlayRenderer`
274
273
  - Per-view UI state lives in an `@xstate/store` atom, not in SolidJS reactive state
275
- - `@json-render/solid` drives rendering; `PlayRenderer` is the signal bridge — import `defineRegistry`, `ComponentFn`, `ComponentContext`, and `useStateBinding` from `@xmachines/play-solid`
274
+ - `@json-render/solid` drives rendering; `PlayRenderer` is the signal bridge — import `defineRegistry`, `ComponentFn`, `ComponentContext`, and `useBoundProp` from `@xmachines/play-solid`
276
275
 
277
276
  @xmachines/play-solid - SolidJS renderer for XMachines Play architecture
278
277
 
@@ -280,7 +279,7 @@ Provides a thin SolidJS rendering layer that passively observes actor signals
280
279
  and renders UI components via @json-render/solid. SolidJS reactivity is only
281
280
  used to trigger re-renders — signals are the source of truth.
282
281
 
283
- Re-exports `defineRegistry`, `useStateBinding`, `ComponentFn`, and
282
+ Re-exports `defineRegistry`, `useBoundProp`, `ComponentFn`, and
284
283
  `ComponentContext` from `@json-render/solid` so consumers import everything
285
284
  from `@xmachines/play-solid` rather than `@json-render/solid` directly.
286
285
 
@@ -302,4 +301,4 @@ from `@xmachines/play-solid` rather than `@json-render/solid` directly.
302
301
 
303
302
  - [defineRegistry](functions/defineRegistry.md)
304
303
  - [useActor](functions/useActor.md)
305
- - [useStateBinding](functions/useStateBinding.md)
304
+ - [useBoundProp](functions/useBoundProp.md)
@@ -6,7 +6,7 @@
6
6
  function useActor(): PlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/useActor.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/src/useActor.ts#L49)
9
+ Defined in: [packages/play-solid/src/useActor.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/src/useActor.ts#L49)
10
10
 
11
11
  ## Returns
12
12
 
@@ -0,0 +1,45 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-solid](../README.md) / useBoundProp
2
+
3
+ # Function: useBoundProp()
4
+
5
+ ```ts
6
+ function useBoundProp<T>(propValue, bindingPath): [T | undefined, (value) => void];
7
+ ```
8
+
9
+ Defined in: `@json-render/solid`
10
+
11
+ Hook for two-way bound props. Returns `[value, setValue]` where:
12
+
13
+ - `value` is the already-resolved prop value (passed through from render props)
14
+ - `setValue` writes back to the bound state path (no-op if not bound)
15
+
16
+ Designed to work with the `bindings` map that the renderer provides when
17
+ a prop uses `{ $bindState: "/path" }` or `{ $bindItem: "field" }`.
18
+
19
+ ## Type Parameters
20
+
21
+ | Type Parameter |
22
+ | -------------- |
23
+ | `T` |
24
+
25
+ ## Parameters
26
+
27
+ | Parameter | Type |
28
+ | ------------- | ----------------------- |
29
+ | `propValue` | `T` \| `undefined` |
30
+ | `bindingPath` | `string` \| `undefined` |
31
+
32
+ ## Returns
33
+
34
+ \[`T` \| `undefined`, (`value`) => `void`\]
35
+
36
+ ## Example
37
+
38
+ ```tsx
39
+ import { useBoundProp } from "@json-render/solid";
40
+
41
+ const Input: ComponentRenderer = (ctx) => {
42
+ const [value, setValue] = useBoundProp<string>(ctx.props.value, ctx.bindings?.value);
43
+ return <input value={value ?? ""} onInput={(e) => setValue(e.target.value)} />;
44
+ };
45
+ ```
@@ -2,23 +2,22 @@
2
2
 
3
3
  # Interface: PlayRendererProps\<TLogic\>
4
4
 
5
- Defined in: [packages/play-solid/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/src/types.ts#L29)
5
+ Defined in: [packages/play-solid/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/src/types.ts#L26)
6
6
 
7
7
  Props for PlayRenderer component
8
8
 
9
9
  ## Type Parameters
10
10
 
11
- | Type Parameter | Default type | Description |
12
- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | `TLogic` _extends_ [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | The XState actor logic type. Defaults to `AnyActorLogic` for non-generic usage. When a specific machine type is provided, the `actions` values are constrained to the event type strings that the machine actually accepts. |
11
+ | Type Parameter | Default type | Description |
12
+ | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
13
+ | `TLogic` _extends_ [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | The XState actor logic type. Defaults to `AnyActorLogic` for non-generic usage. |
14
14
 
15
15
  ## Properties
16
16
 
17
- | Property | Type | Description | Defined in |
18
- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | <a id="property-actions"></a> `actions?` | `object` | Optional mapping of json-render action names to XState event type strings. Values are constrained to `EventFromLogic<TLogic>["type"]` — passing a non-existent event type string is a compile error when TLogic is specified. | [packages/play-solid/src/types.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/src/types.ts#L65) |
20
- | <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) | Actor instance with currentView signal (requires Viewable capability) | [packages/play-solid/src/types.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/src/types.ts#L31) |
21
- | <a id="property-fallback"></a> `fallback?` | `any` | Optional element shown when currentView is null or a component throws | [packages/play-solid/src/types.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/src/types.ts#L37) |
22
- | <a id="property-onerror"></a> `onError?` | (`error`) => `void` | Optional callback invoked when a catalog component throws during render. Receives the thrown error use to forward to Sentry, Datadog, etc. | [packages/play-solid/src/types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/src/types.ts#L49) |
23
- | <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry from @json-render/solid defineRegistry() | [packages/play-solid/src/types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/src/types.ts#L34) |
24
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [packages/play-solid/src/types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/src/types.ts#L58) |
17
+ | Property | Type | Description | Defined in |
18
+ | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
19
+ | <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) | Actor instance with currentView signal (requires Viewable capability) | [packages/play-solid/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/src/types.ts#L28) |
20
+ | <a id="property-fallback"></a> `fallback?` | `any` | Optional element shown when currentView is null or a component throws | [packages/play-solid/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/src/types.ts#L38) |
21
+ | <a id="property-onerror"></a> `onError?` | (`error`) => `void` | Optional callback invoked when a catalog component throws during render. | [packages/play-solid/src/types.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/src/types.ts#L45) |
22
+ | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() in @json-render/solid. Contains both the component registry and the action handlers factory. Action handlers are real async functions dispatching to the actor (not string-mapped event types). | [packages/play-solid/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/src/types.ts#L35) |
23
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [packages/play-solid/src/types.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/src/types.ts#L54) |
@@ -6,4 +6,4 @@
6
6
  type PlayActor = AbstractActor<AnyActorLogic>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/useActor.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/src/useActor.ts#L26)
9
+ Defined in: [packages/play-solid/src/useActor.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/src/useActor.ts#L26)
@@ -6,15 +6,15 @@
6
6
  const PlayRenderer: Component<PlayRendererProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/PlayRenderer.tsx:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-solid/src/PlayRenderer.tsx#L55)
9
+ Defined in: [packages/play-solid/src/PlayRenderer.tsx:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/src/PlayRenderer.tsx#L75)
10
10
 
11
11
  Main renderer component that subscribes to actor signals and renders UI
12
12
 
13
- Architecture (per XMachines Play patterns):
13
+ Architecture:
14
14
 
15
15
  - Subscribes to actor.currentView signal via TC39 Signal.subtle.Watcher
16
- - Renders view.spec via @json-render/solid Renderer backed by the registry
17
- - Routes actions to actor.send() via ActionProvider handlers
16
+ - Renders view.spec via StateProvider PlayRendererInner (with ActionProvider + handlers)
17
+ - Routes actions to actor.send() via registryResult.handlers() — real async functions
18
18
  - SolidJS signal only for triggering renders, NOT business logic
19
19
  - State store: uses external `store` prop if provided (controlled mode); otherwise
20
20
  creates a fresh @xstate/store atom per view transition seeded from spec.state.
@@ -25,24 +25,3 @@ Architecture (per XMachines Play patterns):
25
25
  Invariant: Actor Authority - Actor decides all state transitions via guards.
26
26
  Invariant: Passive Infrastructure - Component observes signals and sends events.
27
27
  Invariant: Signal-Only Reactivity - Business logic state lives in actor signals.
28
-
29
- ## Example
30
-
31
- ```typescript
32
- import { PlayRenderer } from "@xmachines/play-solid";
33
- import { defineRegistry } from "@json-render/solid";
34
-
35
- const { registry } = defineRegistry(catalog, { components: { ... } });
36
-
37
- // Uncontrolled — fresh atom per view, seeded from spec.state:
38
- <PlayRenderer actor={actor} registry={registry} actions={{ login: "auth.login" }} />
39
-
40
- // Controlled — caller provides and owns the store:
41
- import { createAtom } from "@xstate/store";
42
- import { xstateStoreStateStore } from "@json-render/xstate";
43
- const store = xstateStoreStateStore({ atom: createAtom({ username: "" }) });
44
- <PlayRenderer actor={actor} registry={registry} store={store} actions={{ login: "auth.login" }} />
45
-
46
- // With observability hook:
47
- <PlayRenderer actor={actor} registry={registry} onError={(err) => Sentry.captureException(err)} />
48
- ```
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [packages/play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/base-route-map.ts#L100)
5
+ Defined in: [packages/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)
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: [packages/play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/base-route-map.ts#L125)
53
+ Defined in: [packages/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)
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: [packages/play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/base-route-map.ts#L209)
81
+ Defined in: [packages/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)
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: [packages/play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/base-route-map.ts#L174)
112
+ Defined in: [packages/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)
113
113
 
114
114
  Resolve a URL path to its mapped state ID.
115
115