@xmachines/docs 1.0.0-beta.29 → 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 (292) 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 +5 -5
  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-actor-shared → play-dom-demo}/variables/authCatalog.md +23 -24
  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 +5 -5
  230. package/examples/@xmachines/play-react-demo/functions/HeaderNav.md +5 -5
  231. package/examples/@xmachines/play-react-demo/functions/Shell.md +7 -7
  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 +5 -5
  251. package/examples/@xmachines/play-solid-demo/functions/HeaderNav.md +5 -5
  252. package/examples/@xmachines/play-solid-demo/functions/Shell.md +7 -7
  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/examples/README.md +0 -8
  270. package/package.json +2 -2
  271. package/api/@xmachines/play-react/functions/useStateBinding.md +0 -34
  272. package/api/@xmachines/play-solid/functions/useStateBinding.md +0 -25
  273. package/api/@xmachines/play-vue/functions/useStateBinding.md +0 -32
  274. package/examples/@xmachines/play-actor-shared/README.md +0 -155
  275. package/examples/@xmachines/play-actor-shared/interfaces/AuthContext.md +0 -14
  276. package/examples/@xmachines/play-actor-shared/type-aliases/AuthActor.md +0 -27
  277. package/examples/@xmachines/play-actor-shared/type-aliases/AuthCatalog.md +0 -16
  278. package/examples/@xmachines/play-actor-shared/type-aliases/AuthEvents.md +0 -17
  279. package/examples/@xmachines/play-actor-shared/type-aliases/AuthInput.md +0 -9
  280. package/examples/@xmachines/play-actor-shared/type-aliases/AuthSnapshot.md +0 -11
  281. package/examples/@xmachines/play-actor-shared/type-aliases/CatalogProps.md +0 -187
  282. package/examples/@xmachines/play-actor-shared/type-aliases/InferProps.md +0 -17
  283. package/examples/@xmachines/play-actor-shared/variables/authMachine.md +0 -189
  284. package/examples/@xmachines/play-actor-shared/variables/authSetup.md +0 -22
  285. package/examples/@xmachines/play-router-shared/README.md +0 -111
  286. package/examples/@xmachines/play-router-shared/test/auth-machine-routing.test.ts/README.md +0 -3
  287. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/README.md +0 -11
  288. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/functions/defineSharedDemoBrowserSuite.md +0 -19
  289. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/variables/defineRouterDemoBrowserSuite.md +0 -19
  290. package/examples/@xmachines/play-router-shared/test/env.d.ts/README.md +0 -8
  291. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMeta.md +0 -63
  292. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMetaEnv.md +0 -32
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ConnectRendererOptions
4
4
 
5
- Defined in: [xm-types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/xm-types.ts#L35)
5
+ Defined in: [xm-types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L38)
6
6
 
7
7
  Options for connectRenderer() — backward compat API.
8
8
 
@@ -10,9 +10,9 @@ Options for connectRenderer() — backward compat API.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-actions"></a> `actions?` | `Record`\<`string`, `string`\> | Map of json-render actionName XState event type | [xm-types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/xm-types.ts#L49) |
14
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [xm-types.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/xm-types.ts#L37) |
15
- | <a id="property-container"></a> `container` | `HTMLElement` | Container element to render into | [xm-types.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/xm-types.ts#L43) |
16
- | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional element shown when currentView is null (defaults to nothing clears container) | [xm-types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/xm-types.ts#L46) |
17
- | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | Registry of component renderers — replaces old `components` map | [xm-types.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/xm-types.ts#L40) |
18
- | <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. When omitted, a fresh @xstate/store atom is created internally per view transition. | [xm-types.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/xm-types.ts#L56) |
13
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [xm-types.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L40) |
14
+ | <a id="property-container"></a> `container` | `HTMLElement` | Container element to render into | [xm-types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L46) |
15
+ | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional element shown when currentView is null (defaults to nothing — clears container) | [xm-types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L49) |
16
+ | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Map of catalog action name async ActionHandler function. Replaces the old `actions: Record<string, string>` string-map approach. | [xm-types.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L55) |
17
+ | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | Registry of component renderers — replaces old `components` map | [xm-types.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L43) |
18
+ | <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. When omitted, a fresh @xstate/store atom is created internally per view transition. | [xm-types.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L62) |
@@ -2,14 +2,12 @@
2
2
 
3
3
  # Interface: DefineRegistryOptions\<C\>
4
4
 
5
- Defined in: [json-render/types.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L275)
5
+ Defined in: [json-render/types.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L144)
6
6
 
7
7
  Options for `defineRegistry`.
8
8
 
9
- Mirrors `DefineRegistryOptions<C>` from @json-render/react, /solid, /svelte, /vue
10
- with one intentional difference: `actions` is a `Record<string, string>` event-type
11
- map rather than async handler functions, because the DOM renderer dispatches events
12
- directly via `send()` to an XState actor instead of calling framework action handlers.
9
+ Mirrors `DefineRegistryOptions<C>` from @json-render/react, /solid, /svelte, /vue.
10
+ `actions` accepts catalog-typed async handler functions params are fully typed.
13
11
 
14
12
  ## Type Parameters
15
13
 
@@ -19,7 +17,7 @@ directly via `send()` to an XState actor instead of calling framework action han
19
17
 
20
18
  ## Properties
21
19
 
22
- | Property | Type | Description | Defined in |
23
- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
24
- | <a id="property-actions"></a> `actions?` | `InferCatalogActions`\<`C`\> _extends_ `Record`\<`string`, `never`\> ? `Record`\<`string`, `string`\> : `Record`\<keyof `InferCatalogActions`\<`C`\>, `string`\> | Map of catalog action name → XState event type string. When a spec element fires `emit("login")`, the DOM renderer looks up `actions.login` (e.g. `"auth.login"`) and calls `send({ type: "auth.login", ...params })`. In the framework renderers this field holds async handler functions. In the DOM renderer it is a simpler string map because routing to the actor is handled by the XMachines play-dom layer rather than inside the json-render action system. | [json-render/types.ts:291](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L291) |
25
- | <a id="property-components"></a> `components?` | [`ComponentRegistry`](../type-aliases/ComponentRegistry.md)\<`C`\> | Catalog-typed component implementations. Each key must match a component declared in the catalog. | [json-render/types.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L280) |
20
+ | Property | Type | Description | Defined in |
21
+ | ---------------------------------------------- | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
22
+ | <a id="property-actions"></a> `actions?` | [`Actions`](../type-aliases/Actions.md)\<`C`\> | Map of catalog action name → catalog-typed async handler function. Each handler receives params typed to the action's schema (or `undefined`). Guard against undefined before accessing params: **Example** `actions: { login: async (params) => { if (!params) return; actor.send({ type: 'auth.login', username: params.username }); }, }` | [json-render/types.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L165) |
23
+ | <a id="property-components"></a> `components?` | [`ComponentRegistry`](../type-aliases/ComponentRegistry.md)\<`C`\> | Catalog-typed component implementations. | [json-render/types.ts:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L148) |
@@ -2,17 +2,16 @@
2
2
 
3
3
  # Interface: DefineRegistryResult
4
4
 
5
- Defined in: [json-render/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L303)
5
+ Defined in: [json-render/types.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L174)
6
6
 
7
7
  Result returned by `defineRegistry`.
8
8
 
9
- Mirrors the `{ registry }` field from @json-render/react, /solid, /svelte, /vue.
10
- The DOM result also exposes `actorActions` the resolved event-type map so
11
- callers can pass it directly to `connectRenderer` or `PlayRenderer`.
9
+ Matches `DefineRegistryResult` from @json-render/react, /solid, /svelte, /vue
10
+ returns `{ registry, handlers }` instead of the old `{ registry, actorActions }`.
12
11
 
13
12
  ## Properties
14
13
 
15
- | Property | Type | Description | Defined in |
16
- | ------------------------------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actoractions"></a> `actorActions` | `Record`\<`string`, `string`\> | Resolved map of catalog action name XState event type string. Pass to `connectRenderer({ ..., actions: actorActions })` or `new PlayRenderer(container, actor, registry, { actions: actorActions })`. | [json-render/types.ts:314](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L314) |
18
- | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | The built `DomRegistry`, ready to pass to `connectRenderer` or `PlayRenderer`. | [json-render/types.ts:307](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L307) |
14
+ | Property | Type | Description | Defined in |
15
+ | ----------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
16
+ | <a id="property-handlers"></a> `handlers` | (`getSetState`, `getState`) => `Record`\<`string`, `ActionHandler`\> | Create ActionProvider-compatible handlers. Accepts getter functions so handlers always read the latest state. For DOM rendering, pass `() => undefined, () => ({})` since DOM actions dispatch directly to actor without needing setState. | [json-render/types.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L185) |
17
+ | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | The built `DomRegistry`, ready to pass to `connectRenderer` or `PlayRenderer`. | [json-render/types.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L178) |
@@ -2,20 +2,17 @@
2
2
 
3
3
  # Interface: DomRenderContext
4
4
 
5
- Defined in: [json-render/types.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L68)
5
+ Defined in: [json-render/types.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L52)
6
6
 
7
7
  Low-level render context passed to each `DomComponentRenderer`.
8
8
 
9
- This is the raw renderer-level interface. Most component authors should use
10
- the higher-level `ComponentContext<C, K>` provided by `defineRegistry`.
11
-
12
9
  ## Properties
13
10
 
14
- | Property | Type | Description | Defined in |
15
- | -------------------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
16
- | <a id="property-actoractions"></a> `actorActions` | `Record`\<`string`, `string`\> | Map of json-render catalog action names dispatch event type strings. | [json-render/types.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L76) |
17
- | <a id="property-elementbindings"></a> `elementBindings?` | `Record`\<`string`, `string`\> | Pre-computed two-way binding paths for this element's props. Resolved from raw props before `resolveElementProps` runs — the resolved props no longer contain `$bindState`/`$bindItem` expressions. `undefined` when no binding expressions were found. | [json-render/types.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L85) |
18
- | <a id="property-renderchildren"></a> `renderChildren` | (`keys`) => `Node`[] | Render a list of child element keys into DOM nodes. | [json-render/types.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L78) |
19
- | <a id="property-send"></a> `send` | (`event`) => `void` | Dispatch an event (e.g. to an XState actor). | [json-render/types.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L74) |
20
- | <a id="property-spec"></a> `spec` | `Spec` | Full spec tree for this render pass. | [json-render/types.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L70) |
21
- | <a id="property-store"></a> `store` | `StateStore` | Live state store bound to `spec.state`. | [json-render/types.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L72) |
11
+ | Property | Type | Description | Defined in |
12
+ | -------------------------------------------------------- | ------------------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
13
+ | <a id="property-elementbindings"></a> `elementBindings?` | `Record`\<`string`, `string`\> | Pre-computed two-way binding paths for this element's props. | [json-render/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L66) |
14
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Map of json-render catalog action names async ActionHandler functions. | [json-render/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L60) |
15
+ | <a id="property-renderchildren"></a> `renderChildren` | (`keys`) => `Node`[] | Render a list of child element keys into DOM nodes. | [json-render/types.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L62) |
16
+ | <a id="property-send"></a> `send` | (`event`) => `void` | Dispatch an event (e.g. to an XState actor). | [json-render/types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L58) |
17
+ | <a id="property-spec"></a> `spec` | `Spec` | Full spec tree for this render pass. | [json-render/types.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L54) |
18
+ | <a id="property-store"></a> `store` | `StateStore` | Live state store bound to `spec.state`. | [json-render/types.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L56) |
@@ -2,28 +2,14 @@
2
2
 
3
3
  # Interface: EventHandle
4
4
 
5
- Defined in: [json-render/types.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L48)
5
+ Defined in: [json-render/types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L36)
6
6
 
7
7
  Handle returned by `ComponentContext.on(eventName)`.
8
8
 
9
- Matches the `EventHandle` interface from @json-render/react, /solid, /svelte, /vue.
10
-
11
- ## Example
12
-
13
- ```ts
14
- const handle = on("submit");
15
- if (handle.bound) {
16
- btn.addEventListener("click", (e) => {
17
- if (handle.shouldPreventDefault) e.preventDefault();
18
- handle.emit();
19
- });
20
- }
21
- ```
22
-
23
9
  ## Properties
24
10
 
25
- | Property | Type | Description | Defined in |
26
- | ----------------------------------------------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
27
- | <a id="property-bound"></a> `bound` | `boolean` | `true` if an `on` binding exists for this event name; `false` otherwise. | [json-render/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L57) |
28
- | <a id="property-emit"></a> `emit` | () => `void` | Fire the bound action, resolving params from the current state store. | [json-render/types.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L50) |
29
- | <a id="property-shouldpreventdefault"></a> `shouldPreventDefault` | `boolean` | Whether any binding for this event has `preventDefault: true`. Use to call `e.preventDefault()` on the triggering DOM event. | [json-render/types.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L55) |
11
+ | Property | Type | Description | Defined in |
12
+ | ----------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
13
+ | <a id="property-bound"></a> `bound` | `boolean` | `true` if an `on` binding exists for this event name; `false` otherwise. | [json-render/types.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L44) |
14
+ | <a id="property-emit"></a> `emit` | () => `void` | Fire the bound action, resolving params from the current state store. | [json-render/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L38) |
15
+ | <a id="property-shouldpreventdefault"></a> `shouldPreventDefault` | `boolean` | Whether any binding for this event has `preventDefault: true`. | [json-render/types.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L42) |
@@ -2,13 +2,13 @@
2
2
 
3
3
  # Interface: PlayDomOptions
4
4
 
5
- Defined in: [xm-types.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/xm-types.ts#L18)
5
+ Defined in: [xm-types.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L18)
6
6
 
7
7
  Options for PlayRenderer.
8
8
 
9
9
  ## Properties
10
10
 
11
- | Property | Type | Description | Defined in |
12
- | ---------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-actions"></a> `actions?` | `Record`\<`string`, `string`\> | Map of json-render actionNameXState event type | [xm-types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/xm-types.ts#L20) |
14
- | <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. | [xm-types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/xm-types.ts#L29) |
11
+ | Property | Type | Description | Defined in |
12
+ | ------------------------------------------ | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
13
+ | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Map of catalog action name async ActionHandler function. Replaces the old `actions: Record<string, string>` string-map approach. | [xm-types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L23) |
14
+ | <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. | [xm-types.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L32) |
@@ -0,0 +1,30 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / ActionFn
2
+
3
+ # Type Alias: ActionFn\<C, K\>
4
+
5
+ ```ts
6
+ type ActionFn<C, K> = (params) => Promise<void>;
7
+ ```
8
+
9
+ Defined in: [json-render/types.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L126)
10
+
11
+ Catalog-typed action function — mirrors `ActionFn<C, K>` from @json-render/react, /solid, /vue.
12
+ `params` is typed to the exact param schema defined in the catalog, or `undefined` if no spec
13
+ provided params. The handler must guard against undefined before accessing params.
14
+
15
+ ## Type Parameters
16
+
17
+ | Type Parameter |
18
+ | ------------------------------------------------ |
19
+ | `C` _extends_ `Catalog` |
20
+ | `K` _extends_ keyof `InferCatalogActions`\<`C`\> |
21
+
22
+ ## Parameters
23
+
24
+ | Parameter | Type |
25
+ | --------- | ---------------------------------------------- |
26
+ | `params` | `InferActionParams`\<`C`, `K`\> \| `undefined` |
27
+
28
+ ## Returns
29
+
30
+ `Promise`\<`void`\>
@@ -0,0 +1,18 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-dom](../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/types.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L134)
10
+
11
+ Map of catalog-typed action handler functions.
12
+ Each key is a catalog action name; each value is an `ActionFn<C, K>` for that action.
13
+
14
+ ## Type Parameters
15
+
16
+ | Type Parameter |
17
+ | ----------------------- |
18
+ | `C` _extends_ `Catalog` |
@@ -6,15 +6,7 @@
6
6
  type ComponentFn<C, K> = (ctx) => HTMLElement | Text | null;
7
7
  ```
8
8
 
9
- Defined in: [json-render/types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L238)
10
-
11
- Catalog-typed DOM component function.
12
-
13
- The DOM equivalent of `ComponentFn<C, K>` from @json-render/react, /solid,
14
- /svelte, /vue. The only structural difference is the return type:
15
- `HTMLElement | Text | null` instead of a framework node.
16
-
17
- Pass implementations to `defineRegistry` — do not call directly.
9
+ Defined in: [json-render/types.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L105)
18
10
 
19
11
  ## Type Parameters
20
12
 
@@ -32,22 +24,3 @@ Pass implementations to `defineRegistry` — do not call directly.
32
24
  ## Returns
33
25
 
34
26
  `HTMLElement` \| `Text` \| `null`
35
-
36
- ## Example
37
-
38
- ```ts
39
- import type { ComponentFn } from "@xmachines/play-dom";
40
- import type { AuthCatalog } from "@xmachines/play-actor-shared";
41
-
42
- export const Home: ComponentFn<AuthCatalog, "Home"> = ({ props, children }) => {
43
- const section = document.createElement("section");
44
- section.setAttribute("data-page", "home");
45
-
46
- const h2 = document.createElement("h2");
47
- h2.textContent = props.title;
48
- section.appendChild(h2);
49
-
50
- children.forEach((child) => section.appendChild(child));
51
- return section;
52
- };
53
- ```
@@ -6,13 +6,7 @@
6
6
  type ComponentRegistry<C> = { [K in keyof InferCatalogComponents<C>]: ComponentFn<C, K> };
7
7
  ```
8
8
 
9
- Defined in: [json-render/types.ts:251](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L251)
10
-
11
- Catalog-keyed map of `ComponentFn` implementations.
12
-
13
- Used as the `components` field in `DefineRegistryOptions`.
14
- TypeScript enforces that every component key declared in the catalog has
15
- a matching implementation.
9
+ Defined in: [json-render/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L111)
16
10
 
17
11
  ## Type Parameters
18
12
 
@@ -6,13 +6,7 @@
6
6
  type DomComponentRenderer = (element, ctx) => HTMLElement | Text | null;
7
7
  ```
8
8
 
9
- Defined in: [json-render/types.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L106)
10
-
11
- Raw DOM component renderer function.
12
-
13
- Receives a resolved `UIElement` and a `DomRenderContext`, and returns a DOM
14
- node or `null`. Prefer using `ComponentFn<C, K>` via `defineRegistry` for
15
- catalog-typed, framework-consistent components.
9
+ Defined in: [json-render/types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L71)
16
10
 
17
11
  ## Parameters
18
12
 
@@ -24,13 +18,3 @@ catalog-typed, framework-consistent components.
24
18
  ## Returns
25
19
 
26
20
  `HTMLElement` \| `Text` \| `null`
27
-
28
- ## Example
29
-
30
- ```ts
31
- const myRenderer: DomComponentRenderer = (element, ctx) => {
32
- const el = document.createElement("div");
33
- el.textContent = String(element.props.title ?? "");
34
- return el;
35
- };
36
- ```
@@ -6,9 +6,4 @@
6
6
  type DomRegistry = Record<string, DomComponentRenderer>;
7
7
  ```
8
8
 
9
- Defined in: [json-render/types.ts:263](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/src/json-render/types.ts#L263)
10
-
11
- Raw registry of `DomComponentRenderer` functions keyed by element type.
12
-
13
- Passed to `connectRenderer` or `PlayRenderer`. Build with `defineRegistry`
14
- to get catalog-typed component functions automatically wrapped.
9
+ Defined in: [json-render/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L117)
@@ -0,0 +1,9 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / DomSchema
2
+
3
+ # Type Alias: DomSchema
4
+
5
+ ```ts
6
+ type DomSchema = typeof schema;
7
+ ```
8
+
9
+ Defined in: [json-render/schema.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/schema.ts#L60)
@@ -0,0 +1,56 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / schema
2
+
3
+ # Variable: schema
4
+
5
+ ```ts
6
+ const schema: Schema<{
7
+ catalog: SchemaType<
8
+ "object",
9
+ {
10
+ actions: SchemaType<
11
+ "map",
12
+ {
13
+ description: SchemaType<"string", unknown>;
14
+ params: SchemaType<"zod", unknown>;
15
+ }
16
+ >;
17
+ components: SchemaType<
18
+ "map",
19
+ {
20
+ description: SchemaType<"string", unknown>;
21
+ example: SchemaType<"any", unknown>;
22
+ props: SchemaType<"zod", unknown>;
23
+ slots: SchemaType<"array", SchemaType<"string", unknown>>;
24
+ }
25
+ >;
26
+ }
27
+ >;
28
+ spec: SchemaType<
29
+ "object",
30
+ {
31
+ elements: SchemaType<
32
+ "record",
33
+ SchemaType<
34
+ "object",
35
+ {
36
+ children: SchemaType<"array", SchemaType<"string", unknown>>;
37
+ props: SchemaType<"propsOf", string>;
38
+ type: SchemaType<"ref", string>;
39
+ visible: SchemaType<"any", unknown>;
40
+ }
41
+ >
42
+ >;
43
+ root: SchemaType<"string", unknown>;
44
+ }
45
+ >;
46
+ }>;
47
+ ```
48
+
49
+ Defined in: [json-render/schema.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/schema.ts#L20)
50
+
51
+ The schema for @xmachines/play-dom
52
+
53
+ Defines:
54
+
55
+ - Spec: A flat tree of elements with keys, types, props, children, and on-bindings
56
+ - Catalog: Components with props schemas, and optional actions with param schemas
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [play-dom-router/src/connect-router.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/connect-router.ts#L48)
9
+ Defined in: [play-dom-router/src/connect-router.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/connect-router.ts#L48)
10
10
 
11
11
  Connect vanilla router to actor (pure browser integration).
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createBrowserHistory(options): BrowserHistory;
7
7
  ```
8
8
 
9
- Defined in: [play-dom-router/src/create-browser-history.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L120)
9
+ Defined in: [play-dom-router/src/create-browser-history.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L120)
10
10
 
11
11
  Create browser history that wraps window.history
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.29/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.31/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
 
@@ -6,7 +6,7 @@
6
6
  function createRouter(options): VanillaRouter;
7
7
  ```
8
8
 
9
- Defined in: [play-dom-router/src/create-router.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-router.ts#L52)
9
+ Defined in: [play-dom-router/src/create-router.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-router.ts#L52)
10
10
 
11
11
  Create vanilla router for framework-agnostic routing.
12
12
 
@@ -2,17 +2,17 @@
2
2
 
3
3
  # Interface: BrowserHistory
4
4
 
5
- Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L1)
5
+ Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L1)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Modifier | Type | Description | Defined in |
10
10
  | ----------------------------------------- | ---------- | --------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-location"></a> `location` | `readonly` | `object` | Get current location state | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L5) |
12
- | `location.hash` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L8) |
13
- | `location.pathname` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L6) |
14
- | `location.search` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L7) |
15
- | `location.state` | `public` | `unknown` | - | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L9) |
11
+ | <a id="property-location"></a> `location` | `readonly` | `object` | Get current location state | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L5) |
12
+ | `location.hash` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L8) |
13
+ | `location.pathname` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L6) |
14
+ | `location.search` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L7) |
15
+ | `location.state` | `public` | `unknown` | - | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L9) |
16
16
 
17
17
  ## Methods
18
18
 
@@ -22,7 +22,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com
22
22
  back(): void;
23
23
  ```
24
24
 
25
- Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L26)
25
+ Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L26)
26
26
 
27
27
  #### Returns
28
28
 
@@ -36,7 +36,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.co
36
36
  createHref(path): string;
37
37
  ```
38
38
 
39
- Defined in: [play-dom-router/src/create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L38)
39
+ Defined in: [play-dom-router/src/create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L38)
40
40
 
41
41
  Create href from path
42
42
 
@@ -58,7 +58,7 @@ Create href from path
58
58
  destroy(): void;
59
59
  ```
60
60
 
61
- Defined in: [play-dom-router/src/create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L47)
61
+ Defined in: [play-dom-router/src/create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L47)
62
62
 
63
63
  Cleanup.
64
64
 
@@ -78,7 +78,7 @@ wrapper is destroyed.
78
78
  forward(): void;
79
79
  ```
80
80
 
81
- Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L27)
81
+ Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L27)
82
82
 
83
83
  #### Returns
84
84
 
@@ -92,7 +92,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.co
92
92
  go(delta): void;
93
93
  ```
94
94
 
95
- Defined in: [play-dom-router/src/create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L25)
95
+ Defined in: [play-dom-router/src/create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L25)
96
96
 
97
97
  Go back/forward
98
98
 
@@ -114,7 +114,7 @@ Go back/forward
114
114
  push(path, state?): void;
115
115
  ```
116
116
 
117
- Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L15)
117
+ Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L15)
118
118
 
119
119
  Push new URL to history
120
120
 
@@ -137,7 +137,7 @@ Push new URL to history
137
137
  replace(path, state?): void;
138
138
  ```
139
139
 
140
- Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L20)
140
+ Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L20)
141
141
 
142
142
  Replace current URL in history
143
143
 
@@ -160,7 +160,7 @@ Replace current URL in history
160
160
  subscribe(listener): () => void;
161
161
  ```
162
162
 
163
- Defined in: [play-dom-router/src/create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom-router/src/create-browser-history.ts#L33)
163
+ Defined in: [play-dom-router/src/create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom-router/src/create-browser-history.ts#L33)
164
164
 
165
165
  Subscribe to history changes
166
166
  Returns unsubscribe function