@xmachines/docs 1.0.0-beta.32 → 1.0.0-beta.34

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 (370) hide show
  1. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  2. package/api/@xmachines/play/classes/PlayError.md +4 -4
  3. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  4. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  5. package/api/@xmachines/play-actor/README.md +9 -10
  6. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  7. package/api/@xmachines/play-actor/functions/typedSpec.md +7 -10
  8. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +46 -0
  9. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +33 -0
  10. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  11. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Viewable.md +4 -4
  13. package/api/@xmachines/play-dom/README.md +309 -37
  14. package/api/@xmachines/play-dom/classes/PlayRenderer.md +39 -26
  15. package/api/@xmachines/play-dom/functions/connectRenderer.md +39 -20
  16. package/api/@xmachines/play-dom/functions/createPlayUI.md +28 -0
  17. package/api/@xmachines/play-dom/functions/createRenderer.md +43 -0
  18. package/api/@xmachines/play-dom/functions/defineRegistry.md +5 -5
  19. package/api/@xmachines/play-dom/functions/renderSpec.md +43 -9
  20. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +9 -9
  21. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +19 -9
  22. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +29 -0
  23. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +7 -7
  24. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +14 -9
  25. package/api/@xmachines/play-dom/interfaces/EventHandle.md +6 -6
  26. package/api/@xmachines/play-dom/interfaces/MountOptions.md +14 -0
  27. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +7 -5
  28. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +27 -0
  29. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +23 -7
  30. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  31. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +114 -0
  32. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +25 -0
  33. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +39 -0
  36. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/MountFn.md +25 -0
  40. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +23 -0
  41. package/api/@xmachines/play-dom/type-aliases/SetState.md +30 -0
  42. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  43. package/api/@xmachines/play-dom-router/README.md +166 -59
  44. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  45. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  46. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  47. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  48. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  49. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  50. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  51. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  52. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  53. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  54. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  55. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  56. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  57. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  58. package/api/@xmachines/play-react/README.md +166 -48
  59. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  60. package/api/@xmachines/play-react/functions/ActionProvider.md +21 -0
  61. package/api/@xmachines/play-react/functions/JSONUIProvider.md +21 -0
  62. package/api/@xmachines/play-react/functions/Renderer.md +21 -0
  63. package/api/@xmachines/play-react/functions/StateProvider.md +27 -0
  64. package/api/@xmachines/play-react/functions/ValidationProvider.md +21 -0
  65. package/api/@xmachines/play-react/functions/VisibilityProvider.md +21 -0
  66. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  67. package/api/@xmachines/play-react/functions/usePlayView.md +32 -0
  68. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  69. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +15 -0
  70. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +27 -0
  71. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +21 -0
  72. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  73. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  74. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +26 -0
  75. package/api/@xmachines/play-react/interfaces/RendererProps.md +17 -0
  76. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +16 -0
  77. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +14 -0
  78. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +20 -0
  79. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +13 -0
  80. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  81. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +23 -0
  82. package/api/@xmachines/play-react/variables/ActorProvider.md +33 -0
  83. package/api/@xmachines/play-react/variables/PlayRenderer.md +5 -50
  84. package/api/@xmachines/play-react/variables/PlayUIProvider.md +43 -0
  85. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  86. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  87. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  88. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  89. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  90. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  91. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  92. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  93. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  94. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  95. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  96. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  97. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  98. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  99. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  100. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  101. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  102. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  103. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  104. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  105. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  106. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  107. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  108. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  109. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  110. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  111. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  112. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  113. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  114. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  115. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  116. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  117. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  118. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  119. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  120. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  121. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  122. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  123. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  124. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  125. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  126. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  127. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  128. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  129. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  130. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  131. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  132. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  133. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  134. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  135. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  136. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  137. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  138. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  139. package/api/@xmachines/play-solid/README.md +159 -42
  140. package/api/@xmachines/play-solid/functions/ActionProvider.md +19 -0
  141. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +21 -0
  142. package/api/@xmachines/play-solid/functions/Renderer.md +21 -0
  143. package/api/@xmachines/play-solid/functions/StateProvider.md +19 -0
  144. package/api/@xmachines/play-solid/functions/ValidationProvider.md +19 -0
  145. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +20 -0
  146. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  147. package/api/@xmachines/play-solid/functions/useAction.md +24 -0
  148. package/api/@xmachines/play-solid/functions/useActions.md +13 -0
  149. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  150. package/api/@xmachines/play-solid/functions/useFieldValidation.md +29 -0
  151. package/api/@xmachines/play-solid/functions/useIsVisible.md +19 -0
  152. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +13 -0
  153. package/api/@xmachines/play-solid/functions/usePlayView.md +30 -0
  154. package/api/@xmachines/play-solid/functions/useStateBinding.md +25 -0
  155. package/api/@xmachines/play-solid/functions/useStateStore.md +13 -0
  156. package/api/@xmachines/play-solid/functions/useStateValue.md +25 -0
  157. package/api/@xmachines/play-solid/functions/useVisibility.md +13 -0
  158. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +12 -0
  159. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +30 -0
  160. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +15 -0
  161. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +21 -0
  162. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +26 -0
  163. package/api/@xmachines/play-solid/interfaces/RendererProps.md +17 -0
  164. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +13 -0
  165. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +11 -0
  166. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +21 -0
  167. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +17 -0
  168. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  169. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +23 -0
  170. package/api/@xmachines/play-solid/type-aliases/SetState.md +21 -0
  171. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +9 -0
  172. package/api/@xmachines/play-solid/variables/ActorContext.md +13 -0
  173. package/api/@xmachines/play-solid/variables/ActorProvider.md +27 -0
  174. package/api/@xmachines/play-solid/variables/PlayRenderer.md +5 -18
  175. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +26 -0
  176. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  177. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  178. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  179. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  180. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  181. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  182. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  183. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  184. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  185. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  186. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  187. package/api/@xmachines/play-svelte/README.md +142 -27
  188. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  189. package/api/@xmachines/play-svelte/functions/getActorContext.md +21 -0
  190. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +19 -0
  191. package/api/@xmachines/play-svelte/functions/setActorContext.md +19 -0
  192. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +40 -0
  193. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -5
  194. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +24 -0
  195. package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +9 -0
  196. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +7 -0
  197. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  198. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  199. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  200. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  201. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  202. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  203. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  204. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  205. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  206. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  207. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  208. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  209. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  210. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  211. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  212. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  213. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  214. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  215. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  216. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  217. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  218. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  219. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  220. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  221. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  222. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  223. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  224. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  225. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  226. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  227. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  228. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  229. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  230. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  231. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  232. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  233. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  234. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  235. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  236. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  237. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  238. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  239. package/api/@xmachines/play-vue/README.md +137 -40
  240. package/api/@xmachines/play-vue/functions/defineRegistry.md +2 -2
  241. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +28 -0
  242. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  243. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +12 -0
  244. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +25 -0
  245. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +15 -0
  246. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +20 -0
  247. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +24 -0
  248. package/api/@xmachines/play-vue/interfaces/RendererProps.md +17 -0
  249. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +15 -0
  250. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +11 -0
  251. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +21 -0
  252. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  253. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  254. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  255. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  256. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +23 -0
  257. package/api/@xmachines/play-vue/variables/ActionProvider.md +64 -0
  258. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +96 -0
  259. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  260. package/api/@xmachines/play-vue/variables/Renderer.md +79 -0
  261. package/api/@xmachines/play-vue/variables/StateProvider.md +79 -0
  262. package/api/@xmachines/play-vue/variables/ValidationProvider.md +55 -0
  263. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +40 -0
  264. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  265. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  266. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  267. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  268. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  269. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  270. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  271. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  272. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  273. package/api/@xmachines/play-xstate/classes/PlayerActor.md +24 -24
  274. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  275. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  276. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  277. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  278. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  279. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  280. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  281. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  282. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  283. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  284. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  285. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  286. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  287. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  288. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  289. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  290. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  291. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  292. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  293. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  294. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  295. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  296. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  297. package/api/_media/README.md +404 -0
  298. package/examples/@xmachines/play-dom-demo/README.md +42 -22
  299. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  300. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  301. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  302. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  303. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  304. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  305. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  306. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  307. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  308. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  309. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  310. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  311. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  312. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  313. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  314. package/examples/@xmachines/play-react-demo/README.md +53 -46
  315. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  316. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  317. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  318. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  319. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  320. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  321. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  322. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  323. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  324. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  325. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  326. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  327. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  328. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  329. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  330. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  331. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  332. package/examples/@xmachines/play-solid-demo/README.md +53 -34
  333. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  334. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  335. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  336. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  337. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  338. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  339. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  340. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  341. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  342. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  343. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  344. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  345. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  346. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  347. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  348. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  349. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  350. package/examples/@xmachines/play-svelte-demo/README.md +23 -20
  351. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +8 -10
  352. package/examples/@xmachines/play-sveltekit-router-demo/README.md +10 -12
  353. package/examples/@xmachines/play-vue-demo/README.md +55 -37
  354. package/examples/form-validation.md +112 -41
  355. package/examples/routing-patterns.md +9 -19
  356. package/guides/README.md +8 -0
  357. package/guides/actor-model.md +180 -0
  358. package/guides/getting-started.md +54 -37
  359. package/guides/installation.md +6 -6
  360. package/guides/signals.md +166 -0
  361. package/guides/state-machines.md +288 -0
  362. package/package.json +2 -2
  363. package/rfc/play.md +62 -35
  364. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +0 -17
  365. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +0 -23
  366. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +0 -23
  367. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +0 -23
  368. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +0 -21
  369. package/api/@xmachines/play-svelte/variables/getBoundProp.md +0 -7
  370. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +0 -21
@@ -41,7 +41,12 @@ without muting console output.
41
41
  - `useBoundProp` — re-exported from `@json-render/vue`
42
42
  - `ComponentFn` (type) — re-exported from `@json-render/vue`
43
43
  - `ComponentContext` (type) — re-exported from `@json-render/vue`
44
- - `PlayRendererProps` (type)
44
+ - `ActorProvider` — escape hatch primitive (owns actor bridging, signal bridge, store lifecycle)
45
+ - `PlayUIProvider` — batteries-included composite (wraps `ActorProvider` + `JSONUIProvider`)
46
+ - `getPlayViewContext` — composable for accessing the current view spec inside a provider tree
47
+ - `RenderErrorHandler` (type) — inner per-element error callback signature
48
+ - `ActorProviderProps` (type)
49
+ - `ViewContextValue` (type)
45
50
  - `PlayActor` (type)
46
51
 
47
52
  ## Quick Start
@@ -133,12 +138,9 @@ export const machine = setup({
133
138
  meta: {
134
139
  route: "/login",
135
140
  view: {
136
- component: "Login",
137
- spec: {
138
- root: "root",
139
- elements: {
140
- root: { type: "Login", props: { title: "Sign In" }, children: [] },
141
- },
141
+ root: "root",
142
+ elements: {
143
+ root: { type: "Login", props: { title: "Sign In" }, children: [] },
142
144
  },
143
145
  },
144
146
  },
@@ -148,12 +150,9 @@ export const machine = setup({
148
150
  meta: {
149
151
  route: "/dashboard",
150
152
  view: {
151
- component: "Dashboard",
152
- spec: {
153
- root: "root",
154
- elements: {
155
- root: { type: "Dashboard", props: { username: "" }, children: [] },
156
- },
153
+ root: "root",
154
+ elements: {
155
+ root: { type: "Dashboard", props: { username: "" }, children: [] },
157
156
  },
158
157
  },
159
158
  },
@@ -179,7 +178,7 @@ export const machine = setup({
179
178
  <!-- App.vue -->
180
179
  <script setup lang="ts">
181
180
  import { definePlayer } from "@xmachines/play-xstate";
182
- import { PlayRenderer } from "@xmachines/play-vue";
181
+ import { PlayUIProvider, PlayRenderer } from "@xmachines/play-vue";
183
182
  import { machine } from "./machine.js";
184
183
  import { registryResult } from "./registry.js";
185
184
 
@@ -189,27 +188,34 @@ actor.start();
189
188
  </script>
190
189
 
191
190
  <template>
192
- <PlayRenderer :actor="actor" :registryResult="registryResult" />
191
+ <PlayUIProvider :actor="actor" :registryResult="registryResult">
192
+ <PlayRenderer />
193
+ </PlayUIProvider>
193
194
  </template>
194
195
  ```
195
196
 
196
197
  ## API Reference
197
198
 
198
- ### `PlayRenderer`
199
+ ### `PlayUIProvider`
199
200
 
200
- Main Vue component. Subscribes to `actor.currentView` and renders the spec.
201
+ Batteries-included composite provider. Wraps `ActorProvider` + `JSONUIProvider`. Pass `actor` and `registryResult` here, then place `<PlayRenderer />` inside as a zero-prop child.
201
202
 
202
203
  ```vue
203
- <PlayRenderer :actor="actor" :registryResult="registryResult" :store="myStore" />
204
+ <PlayUIProvider
205
+ :actor="actor"
206
+ :registryResult="registryResult"
207
+ :store="myStore"
208
+ :onRenderError="(error, elementType) => console.warn(`<${elementType}> crashed:`, error)"
209
+ >
210
+ <template #fallback><p>Something went wrong.</p></template>
211
+ <PlayRenderer />
212
+ </PlayUIProvider>
204
213
  ```
205
214
 
206
215
  **`actor`** — A `PlayerActor` (or any `AbstractActor & Viewable`). Provides the `currentView` signal.
207
216
 
208
217
  **`registryResult`** — The full `DefineRegistryResult` returned by `defineRegistry(catalog, { components, actions })` from `@xmachines/play-vue`. Pass `.vue` SFCs directly — they are auto-wrapped via `h(SFC, ctx)` so `useBoundProp` and other composables work inside `<script setup>`.
209
218
 
210
- `defineRegistry` also accepts `onRenderError(error, elementType)`, which receives errors
211
- caught by `@json-render/vue`'s inner element boundary before the default logger is used.
212
-
213
219
  **`store`** (optional) — Controls per-view UI state (`$state` bindings, form values):
214
220
 
215
221
  - **Omitted (uncontrolled, default):** A fresh `@xstate/store` atom is created per view transition, seeded from `view.spec.state`.
@@ -223,30 +229,86 @@ import type { StateStore } from "@json-render/core";
223
229
  const store: StateStore = xstateStoreStateStore({ atom: createAtom({ username: "" }) });
224
230
  ```
225
231
 
226
- **Inner render errors** — You can intercept catalog component render failures without
227
- overriding the outer Vue error boundary:
232
+ ```vue
233
+ <PlayUIProvider :actor="actor" :registryResult="registryResult" :store="store">
234
+ <PlayRenderer />
235
+ </PlayUIProvider>
236
+ ```
237
+
238
+ **`onRenderError`** — Called when an individual catalog component throws during render. Caught by `@json-render/vue`'s inner per-element error boundary — the failed component is silently removed while the rest of the spec continues rendering. When both `onRenderError` on `PlayUIProvider` and on `defineRegistry` are set, the prop wins.
239
+
240
+ ---
241
+
242
+ ### `ActorProvider`
243
+
244
+ Escape hatch primitive. Owns actor bridging, signal bridge, and store lifecycle. Use this when you need direct control over the provider layer.
245
+
246
+ ```vue
247
+ <ActorProvider :actor="actor" :registryResult="registryResult" :onRenderError="handleError">
248
+ <!-- your own JSONUIProvider + PlayRenderer tree -->
249
+ </ActorProvider>
250
+ ```
251
+
252
+ ---
253
+
254
+ ### `PlayRenderer`
255
+
256
+ Zero-prop leaf component. Must be rendered inside a `PlayUIProvider` (or `ActorProvider`) tree. Subscribes to `actor.currentView` via context and renders the current spec.
257
+
258
+ ```vue
259
+ <PlayUIProvider :actor="actor" :registryResult="registryResult">
260
+ <PlayRenderer />
261
+ </PlayUIProvider>
262
+ ```
263
+
264
+ `PlayRenderer` accepts no props — all configuration (`actor`, `registryResult`, `store`, `fallback`, `onRenderError`) is provided by the enclosing `PlayUIProvider` or `ActorProvider`.
265
+
266
+ ## Error handling
267
+
268
+ The provider tree has two layers of error boundaries:
269
+
270
+ ### Outer boundary — `fallback` slot
271
+
272
+ Vue's `onErrorCaptured` wraps the entire renderer. Triggered when the spec or store setup throws, or when the inner boundary is not present. Use Vue's built-in `onErrorCaptured` in a parent component for observability.
273
+
274
+ ```vue
275
+ <PlayUIProvider :actor="actor" :registryResult="registryResult">
276
+ <template #fallback>
277
+ <p>Something went wrong.</p>
278
+ </template>
279
+ <PlayRenderer />
280
+ </PlayUIProvider>
281
+ ```
282
+
283
+ ### Inner boundary — `onRenderError`
284
+
285
+ Each catalog element is individually wrapped in an error boundary by `@json-render/vue`. When a component throws, it is silently removed while the rest of the spec continues rendering. The outer boundary is **not** triggered.
286
+
287
+ Pass `onRenderError` to `PlayUIProvider` (or `ActorProvider`) — overrides any registry-level handler — or bake it into `defineRegistry`:
288
+
289
+ ```vue
290
+ <!-- via PlayUIProvider prop -->
291
+ <PlayUIProvider
292
+ :actor="actor"
293
+ :registryResult="registryResult"
294
+ :onRenderError="(error, elementType) => console.warn(`<${elementType}> crashed:`, error)"
295
+ >
296
+ <PlayRenderer />
297
+ </PlayUIProvider>
298
+ ```
228
299
 
229
300
  ```ts
230
- export const registryResult = defineRegistry(catalog, {
301
+ // via defineRegistry bakes the handler into the registry
302
+ const registryResult = defineRegistry(catalog, {
231
303
  components: { Login: LoginSFC, Dashboard: DashboardSFC },
232
- actions: {
233
- login: async (params) => {
234
- if (!params) return;
235
- actor.send({ type: "auth.login", username: params.username });
236
- },
237
- logout: async (params) => {
238
- actor.send({ type: "auth.logout" });
239
- },
240
- },
304
+ actions: { login: async (params) => { ... }, logout: async () => { ... } },
241
305
  onRenderError(error, elementType) {
242
306
  reportExpectedRenderError(error, elementType);
243
307
  },
244
308
  });
245
309
  ```
246
310
 
247
- ```vue
248
- <PlayRenderer :actor="actor" :registryResult="registryResult" :store="store" />
249
- ```
311
+ `onRenderError` is typed as `RenderErrorHandler` and exported from `@xmachines/play-vue`.
250
312
 
251
313
  ---
252
314
 
@@ -262,7 +324,7 @@ const actor = useActor();
262
324
  actor.send({ type: "auth.logout" });
263
325
  ```
264
326
 
265
- Throws `"useActor() must be called inside <PlayRenderer>"` if called outside the tree.
327
+ Throws `NonNullableError: "useActor() must be called inside <ActorProvider> (or <PlayUIProvider>)"` if called outside the tree.
266
328
 
267
329
  ---
268
330
 
@@ -295,13 +357,22 @@ and renders UI components via @json-render/vue. Vue reactivity is only used
295
357
  to trigger re-renders — signals are the source of truth.
296
358
 
297
359
  Re-exports `defineRegistry` (SFC-aware — auto-wraps `.vue` SFCs via `h()`),
298
- `useBoundProp`, `ComponentFn`, and `ComponentContext` so consumers import
299
- everything from `@xmachines/play-vue` rather than `@json-render/vue` directly.
360
+ `useBoundProp`, `ComponentFn`, `ComponentContext`, and all json-render providers
361
+ so consumers import everything from `@xmachines/play-vue` rather than
362
+ `@json-render/vue` directly.
300
363
 
301
364
  ## Interfaces
302
365
 
366
+ - [ActionProviderProps](interfaces/ActionProviderProps.md)
367
+ - [ActorProviderProps](interfaces/ActorProviderProps.md)
303
368
  - [ComponentContext](interfaces/ComponentContext.md)
304
- - [PlayRendererProps](interfaces/PlayRendererProps.md)
369
+ - [DefineRegistryResult](interfaces/DefineRegistryResult.md)
370
+ - [JSONUIProviderProps](interfaces/JSONUIProviderProps.md)
371
+ - [PlayUIProviderProps](interfaces/PlayUIProviderProps.md)
372
+ - [RendererProps](interfaces/RendererProps.md)
373
+ - [StateProviderProps](interfaces/StateProviderProps.md)
374
+ - [ValidationProviderProps](interfaces/ValidationProviderProps.md)
375
+ - [ViewContextValue](interfaces/ViewContextValue.md)
305
376
 
306
377
  ## Type Aliases
307
378
 
@@ -310,13 +381,39 @@ everything from `@xmachines/play-vue` rather than `@json-render/vue` directly.
310
381
  - [ComponentsMap](type-aliases/ComponentsMap.md)
311
382
  - [DefineRegistryOptions](type-aliases/DefineRegistryOptions.md)
312
383
  - [PlayActor](type-aliases/PlayActor.md)
384
+ - [RenderErrorHandler](type-aliases/RenderErrorHandler.md)
313
385
 
314
386
  ## Variables
315
387
 
388
+ - [ActionProvider](variables/ActionProvider.md)
389
+ - [JSONUIProvider](variables/JSONUIProvider.md)
316
390
  - [PlayRenderer](variables/PlayRenderer.md)
391
+ - [Renderer](variables/Renderer.md)
392
+ - [StateProvider](variables/StateProvider.md)
393
+ - [ValidationProvider](variables/ValidationProvider.md)
394
+ - [VisibilityProvider](variables/VisibilityProvider.md)
317
395
 
318
396
  ## Functions
319
397
 
320
398
  - [defineRegistry](functions/defineRegistry.md)
399
+ - [getPlayViewContext](functions/getPlayViewContext.md)
321
400
  - [useActor](functions/useActor.md)
322
401
  - [useBoundProp](functions/useBoundProp.md)
402
+
403
+ ## References
404
+
405
+ ### ActorProvider
406
+
407
+ Renames and re-exports [PlayRenderer](variables/PlayRenderer.md)
408
+
409
+ ---
410
+
411
+ ### PlayUIProvider
412
+
413
+ Renames and re-exports [PlayRenderer](variables/PlayRenderer.md)
414
+
415
+ ---
416
+
417
+ ### RenderErrorHandler
418
+
419
+ Re-exports [RenderErrorHandler](type-aliases/RenderErrorHandler.md)
@@ -6,7 +6,7 @@
6
6
  function defineRegistry<C>(catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/define-registry.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/define-registry.ts#L122)
9
+ Defined in: [packages/play-vue/src/define-registry.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-vue/src/define-registry.ts#L122)
10
10
 
11
11
  Create a component registry, automatically wrapping `.vue` SFCs so they work
12
12
  correctly with `@json-render/vue`'s rendering pipeline.
@@ -29,4 +29,4 @@ Drop-in replacement for `defineRegistry` from `@json-render/vue`. Import from
29
29
 
30
30
  ## Returns
31
31
 
32
- `DefineRegistryResult`
32
+ [`DefineRegistryResult`](../interfaces/DefineRegistryResult.md)
@@ -0,0 +1,28 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / getPlayViewContext
2
+
3
+ # Function: getPlayViewContext()
4
+
5
+ ```ts
6
+ function getPlayViewContext(): ViewContextValue;
7
+ ```
8
+
9
+ Defined in: [packages/play-vue/src/actor-provider-context.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-vue/src/actor-provider-context.ts#L44)
10
+
11
+ Access the current ViewContextValue from inside an ActorProvider tree.
12
+
13
+ ## Returns
14
+
15
+ [`ViewContextValue`](../interfaces/ViewContextValue.md)
16
+
17
+ ## Throws
18
+
19
+ If called outside an <ActorProvider> (or <PlayUIProvider>) tree
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import { getPlayViewContext } from "@xmachines/play-vue";
25
+
26
+ const view = getPlayViewContext();
27
+ // view.spec, view.handlers, view.registry
28
+ ```
@@ -6,7 +6,7 @@
6
6
  function useActor(): PlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/useActor.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/useActor.ts#L43)
9
+ Defined in: [packages/play-vue/src/useActor.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-vue/src/useActor.ts#L43)
10
10
 
11
11
  ## Returns
12
12
 
@@ -0,0 +1,12 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / ActionProviderProps
2
+
3
+ # Interface: ActionProviderProps
4
+
5
+ Defined in: `@json-render/vue`
6
+
7
+ ## Properties
8
+
9
+ | Property | Type | Defined in |
10
+ | ------------------------------------------ | ------------------------------------- | ---------- |
11
+ | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | - |
12
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | - |
@@ -0,0 +1,25 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / ActorProviderProps
2
+
3
+ # Interface: ActorProviderProps
4
+
5
+ Defined in: [packages/play-vue/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-vue/src/types.ts#L14)
6
+
7
+ Props for the ActorProvider component.
8
+ Extracted to types.ts so TypeScript can re-export without the vue-shim limitation.
9
+
10
+ ## Extends
11
+
12
+ - [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md)\<[`DefineRegistryResult`](DefineRegistryResult.md)\>
13
+
14
+ ## Extended by
15
+
16
+ - [`PlayUIProviderProps`](PlayUIProviderProps.md)
17
+
18
+ ## Properties
19
+
20
+ | Property | Type | Description | Inherited from | Defined in |
21
+ | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22
+ | <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). | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L154) |
23
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L167) |
24
+ | <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L156) |
25
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L162) |
@@ -0,0 +1,15 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / DefineRegistryResult
2
+
3
+ # Interface: DefineRegistryResult
4
+
5
+ Defined in: `@json-render/vue`
6
+
7
+ Result returned by defineRegistry
8
+
9
+ ## Properties
10
+
11
+ | Property | Type | Defined in |
12
+ | --------------------------------------------------- | -------------------------------------------------------------------------------------- | ---------- |
13
+ | <a id="property-executeaction"></a> `executeAction` | (`actionName`, `params`, `setState`, `state?`) => `Promise`\<`void`\> | - |
14
+ | <a id="property-handlers"></a> `handlers` | (`getSetState`, `getState`) => `Record`\<`string`, (`params`) => `Promise`\<`void`\>\> | - |
15
+ | <a id="property-registry"></a> `registry` | `ComponentRegistry` | - |
@@ -0,0 +1,20 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / JSONUIProviderProps
2
+
3
+ # Interface: JSONUIProviderProps
4
+
5
+ Defined in: `@json-render/vue`
6
+
7
+ Props for JSONUIProvider
8
+
9
+ ## Properties
10
+
11
+ | Property | Type | Description | Defined in |
12
+ | ---------------------------------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------- | ---------- |
13
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Named functions for `$computed` expressions in props | - |
14
+ | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, (`params`) => `unknown`\> | - | - |
15
+ | <a id="property-initialstate"></a> `initialState?` | `Record`\<`string`, `unknown`\> | - | - |
16
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | - | - |
17
+ | <a id="property-onstatechange"></a> `onStateChange?` | (`changes`) => `void` | - | - |
18
+ | <a id="property-registry"></a> `registry` | `ComponentRegistry` | - | - |
19
+ | <a id="property-store"></a> `store?` | `StateStore` | - | - |
20
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | - | - |
@@ -0,0 +1,24 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / PlayUIProviderProps
2
+
3
+ # Interface: PlayUIProviderProps
4
+
5
+ Defined in: [packages/play-vue/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-vue/src/types.ts#L21)
6
+
7
+ Props for the ActorProvider component.
8
+ Extracted to types.ts so TypeScript can re-export without the vue-shim limitation.
9
+
10
+ ## Extends
11
+
12
+ - [`ActorProviderProps`](ActorProviderProps.md)
13
+
14
+ ## Properties
15
+
16
+ | Property | Type | Description | Inherited from | Defined in |
17
+ | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
18
+ | <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). | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L154) |
19
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, (`args?`, `state?`) => `unknown`\> | Named functions for $computed expressions in props | - | [packages/play-vue/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-vue/src/types.ts#L27) |
20
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigate function forwarded to JSONUIProvider for link resolution | - | [packages/play-vue/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-vue/src/types.ts#L23) |
21
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L167) |
22
+ | <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L156) |
23
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L162) |
24
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Validation functions forwarded to JSONUIProvider | - | [packages/play-vue/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-vue/src/types.ts#L25) |
@@ -0,0 +1,17 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / RendererProps
2
+
3
+ # Interface: RendererProps
4
+
5
+ Defined in: `@json-render/vue`
6
+
7
+ Props for the Renderer component
8
+
9
+ ## Properties
10
+
11
+ | Property | Type | Description | Defined in |
12
+ | ---------------------------------------------------- | ------------------- | --------------------------------------------------------------- | ---------- |
13
+ | <a id="property-fallback"></a> `fallback?` | `Component` | - | - |
14
+ | <a id="property-loading"></a> `loading?` | `boolean` | - | - |
15
+ | <a id="property-onrendererror"></a> `onRenderError?` | `any` | Callback for element render errors caught by the inner boundary | - |
16
+ | <a id="property-registry"></a> `registry` | `ComponentRegistry` | - | - |
17
+ | <a id="property-spec"></a> `spec` | `Spec` \| `null` | - | - |
@@ -0,0 +1,15 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / StateProviderProps
2
+
3
+ # Interface: StateProviderProps
4
+
5
+ Defined in: `@json-render/vue`
6
+
7
+ Props for StateProvider
8
+
9
+ ## Properties
10
+
11
+ | Property | Type | Description | Defined in |
12
+ | ---------------------------------------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
13
+ | <a id="property-initialstate"></a> `initialState?` | `StateModel` | Initial state model (used only in uncontrolled mode) | - |
14
+ | <a id="property-onstatechange"></a> `onStateChange?` | (`changes`) => `void` | Callback when state changes (used only in uncontrolled mode). Called once per `set` or `update` with all changed entries. | - |
15
+ | <a id="property-store"></a> `store?` | `StateStore` | External store that owns the state. When provided, the provider operates in **controlled mode** — `initialState` and `onStateChange` are ignored and the store is the single source of truth. | - |
@@ -0,0 +1,11 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / ValidationProviderProps
2
+
3
+ # Interface: ValidationProviderProps
4
+
5
+ Defined in: `@json-render/vue`
6
+
7
+ ## Properties
8
+
9
+ | Property | Type | Defined in |
10
+ | -------------------------------------------------------- | ------------------------------------------ | ---------- |
11
+ | <a id="property-customfunctions"></a> `customFunctions?` | `Record`\<`string`, `ValidationFunction`\> | - |
@@ -0,0 +1,21 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / ViewContextValue
2
+
3
+ # Interface: ViewContextValue
4
+
5
+ Defined in: [packages/play-vue/src/actor-provider-context.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-vue/src/actor-provider-context.ts#L21)
6
+
7
+ Context value provided by ActorProvider and consumed by PlayRenderer (zero-prop leaf).
8
+ Accessible via getPlayViewContext() inside any ActorProvider/PlayUIProvider tree.
9
+
10
+ ## Extends
11
+
12
+ - [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md)\<`ComponentRegistry`\>
13
+
14
+ ## Properties
15
+
16
+ | Property | Type | Description | Inherited from | Defined in |
17
+ | ----------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
18
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L122) |
19
+ | <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L124) |
20
+ | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L120) |
21
+ | <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L126) |
@@ -6,7 +6,7 @@
6
6
  type ComponentEntry<C, K> = ComponentFn<C, K> | Component;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/define-registry.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/define-registry.ts#L96)
9
+ Defined in: [packages/play-vue/src/define-registry.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-vue/src/define-registry.ts#L96)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  type ComponentsMap<C> = { [K in keyof InferCatalogComponents<C>]?: ComponentEntry<C, K> };
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/define-registry.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/define-registry.ts#L100)
9
+ Defined in: [packages/play-vue/src/define-registry.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-vue/src/define-registry.ts#L100)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -7,13 +7,13 @@ type DefineRegistryOptions<C> = Omit<Parameters<typeof defineRegistryBase>[1], "
7
7
  object;
8
8
  ```
9
9
 
10
- Defined in: [packages/play-vue/src/define-registry.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/define-registry.ts#L104)
10
+ Defined in: [packages/play-vue/src/define-registry.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-vue/src/define-registry.ts#L104)
11
11
 
12
12
  ## Type Declaration
13
13
 
14
14
  | Name | Type | Defined in |
15
15
  | ------------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
16
- | `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/define-registry.ts#L108) |
16
+ | `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-vue/src/define-registry.ts#L108) |
17
17
 
18
18
  ## Type Parameters
19
19
 
@@ -6,4 +6,4 @@
6
6
  type PlayActor = AbstractActor<AnyActorLogic>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/useActor.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/useActor.ts#L26)
9
+ Defined in: [packages/play-vue/src/useActor.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-vue/src/useActor.ts#L26)
@@ -0,0 +1,23 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / RenderErrorHandler
2
+
3
+ # Type Alias: RenderErrorHandler
4
+
5
+ ```ts
6
+ type RenderErrorHandler = (error, elementType) => void;
7
+ ```
8
+
9
+ Defined in: `@json-render/core`
10
+
11
+ Callback invoked when an individual catalog component throws during render.
12
+ Implemented by each framework renderer's error boundary / error capture mechanism.
13
+
14
+ ## Parameters
15
+
16
+ | Parameter | Type |
17
+ | ------------- | --------- |
18
+ | `error` | `unknown` |
19
+ | `elementType` | `string` |
20
+
21
+ ## Returns
22
+
23
+ `void`