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

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 (360) 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 +2 -2
  6. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  7. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  8. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  9. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  10. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +7 -7
  11. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +8 -8
  12. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +3 -3
  13. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  14. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  15. package/api/@xmachines/play-dom/README.md +10 -16
  16. package/api/@xmachines/play-dom/classes/PlayRenderer.md +12 -11
  17. package/api/@xmachines/play-dom/functions/createPlayUI.md +5 -5
  18. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  19. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  20. package/api/@xmachines/play-dom/functions/renderSpec.md +2 -2
  21. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +9 -9
  22. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +12 -11
  23. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +7 -7
  24. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +19 -18
  25. package/api/@xmachines/play-dom/interfaces/EventHandle.md +6 -6
  26. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  27. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +14 -13
  28. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +14 -13
  29. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +12 -11
  30. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +3 -3
  31. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +9 -9
  33. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +2 -2
  34. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +3 -3
  37. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +5 -5
  38. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  41. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/SetState.md +3 -3
  43. package/api/@xmachines/play-dom/variables/schema.md +26 -20
  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/RoutableActor.md +4 -4
  53. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  54. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  55. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  56. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  57. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  58. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  59. package/api/@xmachines/play-react/README.md +5 -11
  60. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  61. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  62. package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
  63. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  64. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  65. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  66. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +12 -11
  67. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  68. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  69. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  70. package/api/@xmachines/play-react/interfaces/RendererProps.md +7 -7
  71. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  72. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  73. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  74. package/api/@xmachines/play-react/variables/PlayRenderer.md +2 -2
  75. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  76. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
  77. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  78. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  79. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  80. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  81. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  82. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  83. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  84. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  85. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  86. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  87. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  88. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  89. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  90. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  91. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
  92. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  93. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  94. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  95. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  96. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  97. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  98. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  99. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  100. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  101. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  102. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  103. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  104. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  105. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  106. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  107. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  108. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  109. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  110. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  111. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  112. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  113. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  114. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  115. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  116. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  117. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +3 -3
  118. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  119. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  120. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  121. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  122. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  123. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  124. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  125. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  126. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  127. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  128. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  129. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  130. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  131. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  132. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  133. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  134. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  135. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  136. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  137. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  138. package/api/@xmachines/play-solid/README.md +8 -14
  139. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  140. package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
  141. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  142. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  143. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +12 -11
  144. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  145. package/api/@xmachines/play-solid/interfaces/RendererProps.md +7 -7
  146. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +7 -7
  147. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  148. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -7
  149. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  150. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  151. package/api/@xmachines/play-solid/variables/PlayRenderer.md +2 -2
  152. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  153. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  154. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
  155. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  156. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  157. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  158. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  159. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  160. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  161. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  162. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  163. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  164. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  165. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  166. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  167. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  168. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  169. package/api/@xmachines/play-svelte/README.md +21 -26
  170. package/api/@xmachines/play-svelte/functions/defineRegistry.md +2 -2
  171. package/api/@xmachines/play-svelte/functions/getActorContext.md +2 -2
  172. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  173. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  174. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +10 -10
  175. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -6
  176. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +13 -13
  177. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  178. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  179. package/api/@xmachines/play-svelte/type-aliases/JSONUIProviderProps.md +7 -0
  180. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +17 -1
  181. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  182. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  183. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  184. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  185. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  186. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  187. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  188. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  189. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  190. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  191. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  192. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  193. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  194. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  195. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  196. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  197. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  198. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  199. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  200. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  201. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  202. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
  203. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  204. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  205. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  206. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  207. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  208. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  209. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  210. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  211. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  212. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  213. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  214. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  215. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  216. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  217. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  218. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  219. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
  220. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  221. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
  222. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  223. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
  224. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  225. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  226. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  227. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  228. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  229. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  230. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  231. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  232. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  233. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  234. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  235. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  236. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  237. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  238. package/api/@xmachines/play-vue/README.md +8 -14
  239. package/api/@xmachines/play-vue/functions/defineRegistry.md +3 -3
  240. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  241. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  242. package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
  243. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  244. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +11 -10
  245. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  246. package/api/@xmachines/play-vue/interfaces/RendererProps.md +7 -7
  247. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  248. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  249. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  250. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  251. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  252. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  253. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +9 -0
  254. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  255. package/api/@xmachines/play-vue/variables/Renderer.md +9 -0
  256. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  257. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
  258. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  259. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  260. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  261. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  262. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  263. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  264. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  265. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  266. package/api/@xmachines/play-xstate/classes/PlayerActor.md +28 -28
  267. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  268. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  269. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  270. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  271. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  272. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  273. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  274. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  275. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  276. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  277. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  278. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  279. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  280. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  281. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  282. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  283. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  284. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  285. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  286. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  287. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  288. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  289. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  290. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  291. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  292. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +3 -3
  293. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  294. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  295. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  296. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  297. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  298. package/api/llms.txt +2 -2
  299. package/contributing/architecture.md +9 -9
  300. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  301. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  302. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  303. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  304. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  305. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  306. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  307. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  308. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  309. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  310. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  311. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  312. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  313. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  314. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  315. package/examples/@xmachines/play-react-demo/README.md +1 -1
  316. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  317. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  318. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  319. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  320. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  321. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  322. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  323. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  324. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  325. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  326. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  327. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  328. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  329. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  330. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  331. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  332. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  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/type-aliases/AuthCatalog.md +1 -1
  351. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  352. package/examples/@xmachines/play-vue-demo/README.md +2 -2
  353. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  354. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  355. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  356. package/examples/form-validation.md +2 -2
  357. package/guides/getting-started.md +4 -4
  358. package/guides/state-machines.md +1 -1
  359. package/package.json +2 -2
  360. package/rfc/play.md +16 -16
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: NonNullableError
4
4
 
5
- Defined in: [packages/play/src/errors.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play/src/errors.ts#L111)
5
+ Defined in: [packages/play/src/errors.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play/src/errors.ts#L111)
6
6
 
7
7
  Thrown by [assertNonNullable](../functions/assertNonNullable.md) when a value is `null` or `undefined`.
8
8
 
@@ -35,7 +35,7 @@ try {
35
35
  new NonNullableError(message, options?): NonNullableError;
36
36
  ```
37
37
 
38
- Defined in: [packages/play/src/errors.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play/src/errors.ts#L112)
38
+ Defined in: [packages/play/src/errors.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play/src/errors.ts#L112)
39
39
 
40
40
  #### Parameters
41
41
 
@@ -57,10 +57,10 @@ Defined in: [packages/play/src/errors.ts:112](https://gitlab.com/xmachin-es/xmac
57
57
  | Property | Modifier | Type | Description | Inherited from | Defined in |
58
58
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
59
59
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](PlayError.md).[`cause`](PlayError.md#property-cause) | - |
60
- | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable error identifier. Error codes follow the `PLAY_<PACKAGE>_<DESCRIPTION>` naming convention and are guaranteed stable across patch and minor releases within a major version. Never match on `.message` — always match on `.code` or the subclass. | [`PlayError`](PlayError.md).[`code`](PlayError.md#property-code) | [packages/play/src/errors.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play/src/errors.ts#L75) |
60
+ | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable error identifier. Error codes follow the `PLAY_<PACKAGE>_<DESCRIPTION>` naming convention and are guaranteed stable across patch and minor releases within a major version. Never match on `.message` — always match on `.code` or the subclass. | [`PlayError`](PlayError.md).[`code`](PlayError.md#property-code) | [packages/play/src/errors.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play/src/errors.ts#L75) |
61
61
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](PlayError.md).[`message`](PlayError.md#property-message) | - |
62
62
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](PlayError.md).[`name`](PlayError.md#property-name) | - |
63
- | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or module that threw this error (e.g. `"RouterBridgeBase"`). | [`PlayError`](PlayError.md).[`scope`](PlayError.md#property-scope) | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play/src/errors.ts#L66) |
63
+ | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or module that threw this error (e.g. `"RouterBridgeBase"`). | [`PlayError`](PlayError.md).[`scope`](PlayError.md#property-scope) | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play/src/errors.ts#L66) |
64
64
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](PlayError.md).[`stack`](PlayError.md#property-stack) | - |
65
65
  | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](PlayError.md).[`stackTraceLimit`](PlayError.md#property-stacktracelimit) | - |
66
66
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayError
4
4
 
5
- Defined in: [packages/play/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play/src/errors.ts#L64)
5
+ Defined in: [packages/play/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play/src/errors.ts#L64)
6
6
 
7
7
  Base class for all typed runtime errors thrown by `@xmachines/*` packages.
8
8
 
@@ -87,7 +87,7 @@ new PlayError(
87
87
  options?): PlayError;
88
88
  ```
89
89
 
90
- Defined in: [packages/play/src/errors.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play/src/errors.ts#L83)
90
+ Defined in: [packages/play/src/errors.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play/src/errors.ts#L83)
91
91
 
92
92
  #### Parameters
93
93
 
@@ -113,10 +113,10 @@ Error.constructor;
113
113
  | Property | Modifier | Type | Description | Inherited from | Defined in |
114
114
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
115
115
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | `Error.cause` | - |
116
- | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable error identifier. Error codes follow the `PLAY_<PACKAGE>_<DESCRIPTION>` naming convention and are guaranteed stable across patch and minor releases within a major version. Never match on `.message` — always match on `.code` or the subclass. | - | [packages/play/src/errors.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play/src/errors.ts#L75) |
116
+ | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable error identifier. Error codes follow the `PLAY_<PACKAGE>_<DESCRIPTION>` naming convention and are guaranteed stable across patch and minor releases within a major version. Never match on `.message` — always match on `.code` or the subclass. | - | [packages/play/src/errors.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play/src/errors.ts#L75) |
117
117
  | <a id="property-message"></a> `message` | `public` | `string` | - | `Error.message` | - |
118
118
  | <a id="property-name"></a> `name` | `public` | `string` | - | `Error.name` | - |
119
- | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or module that threw this error (e.g. `"RouterBridgeBase"`). | - | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play/src/errors.ts#L66) |
119
+ | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or module that threw this error (e.g. `"RouterBridgeBase"`). | - | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play/src/errors.ts#L66) |
120
120
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | `Error.stack` | - |
121
121
  | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | - |
122
122
 
@@ -6,7 +6,7 @@
6
6
  function assertNonNullable<V>(value, name?): NonNullable<V>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play/src/utils.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play/src/utils.ts#L39)
9
+ Defined in: [packages/play/src/utils.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play/src/utils.ts#L39)
10
10
 
11
11
  Assert that `value` is neither `null` nor `undefined`, and return it typed
12
12
  as `NonNullable<V>` — combining the guard and the narrowed value in a single
@@ -6,7 +6,7 @@
6
6
  type PlayEvent<TPayload> = object & TPayload;
7
7
  ```
8
8
 
9
- Defined in: [packages/play/src/types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play/src/types.ts#L69)
9
+ Defined in: [packages/play/src/types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play/src/types.ts#L69)
10
10
 
11
11
  Generic event type for Play Architecture
12
12
 
@@ -34,7 +34,7 @@ Robot, and other state machine libraries.
34
34
 
35
35
  | Name | Type | Defined in |
36
36
  | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
37
- | `type` | `string` | [packages/play/src/types.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play/src/types.ts#L70) |
37
+ | `type` | `string` | [packages/play/src/types.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play/src/types.ts#L70) |
38
38
 
39
39
  ## Type Parameters
40
40
 
@@ -105,7 +105,7 @@ meta: {
105
105
 
106
106
  ### `PlaySpec`
107
107
 
108
- Extends `@json-render/core`'s `Spec` with an optional `contextProps` field — an explicit allowlist of machine context fields that are merged into element props at view derivation time.
108
+ Extends `@xmachines/json-render-core`'s `Spec` with an optional `contextProps` field — an explicit allowlist of machine context fields that are merged into element props at view derivation time.
109
109
 
110
110
  ```ts
111
111
  import type { PlaySpec } from "@xmachines/play-actor";
@@ -158,7 +158,7 @@ Framework-agnostic base props shared by every `ActorProvider` implementation (Re
158
158
 
159
159
  ```ts
160
160
  import type { BaseActorProviderProps } from "@xmachines/play-actor";
161
- import type { DefineRegistryResult } from "@json-render/react";
161
+ import type { DefineRegistryResult } from "@xmachines/json-render-react";
162
162
 
163
163
  interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult> {
164
164
  fallback?: React.ReactNode;
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Abstract Class: AbstractActor\<TLogic, TEvent\>
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L180)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L185)
6
6
 
7
7
  Abstract base class for Play Architecture actors.
8
8
 
@@ -67,7 +67,7 @@ Actor<TLogic>.constructor
67
67
  | <a id="property-ref"></a> `ref` | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TLogic`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TLogic`\>\> | - | `Actor.ref` | - |
68
68
  | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
69
69
  | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` | - |
70
- | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Infrastructure observes this signal to react to state changes without directly coupling to the actor's internal state machine implementation. | - | [packages/play-actor/src/abstract-actor.ts:190](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L190) |
70
+ | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Infrastructure observes this signal to react to state changes without directly coupling to the actor's internal state machine implementation. | - | [packages/play-actor/src/abstract-actor.ts:195](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L195) |
71
71
  | <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | `Actor.system` | - |
72
72
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | - |
73
73
 
@@ -238,7 +238,7 @@ Actor.select;
238
238
  abstract send(event): void;
239
239
  ```
240
240
 
241
- Defined in: [packages/play-actor/src/abstract-actor.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L197)
241
+ Defined in: [packages/play-actor/src/abstract-actor.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L202)
242
242
 
243
243
  Send event to Actor.
244
244
 
@@ -6,7 +6,7 @@
6
6
  function attachRenderErrorHandler<TRegistry>(registry, handler): TRegistry;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/provider-guards.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/provider-guards.ts#L64)
9
+ Defined in: [packages/play-actor/src/provider-guards.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/provider-guards.ts#L64)
10
10
 
11
11
  Clone a component registry and inject an `onRenderError` handler.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function toAtomState(state): Record<string, unknown>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/provider-guards.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/provider-guards.ts#L36)
9
+ Defined in: [packages/play-actor/src/provider-guards.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/provider-guards.ts#L36)
10
10
 
11
11
  Safely coerce a spec's `state` field to a plain object for `createAtom`.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function typedSpec<TContext>(spec): PlaySpec;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/abstract-actor.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L83)
9
+ Defined in: [packages/play-actor/src/abstract-actor.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L88)
10
10
 
11
11
  Identity helper that constrains a `PlaySpec` object's `contextProps` to keys
12
12
  of a specific machine context type, giving compile-time validation and IDE
@@ -2,12 +2,12 @@
2
2
 
3
3
  # Interface: BaseActorProviderProps\<TRegistry\>
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L150)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:155](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L155)
6
6
 
7
7
  Framework-agnostic base props shared by every `ActorProvider` implementation
8
8
  (React, Vue, Solid, Svelte). `TRegistry` captures the framework-specific
9
9
  `DefineRegistryResult` type; `RenderErrorHandler` is sourced from
10
- `@json-render/core` so no second generic is needed.
10
+ `@xmachines/json-render-core` so no second generic is needed.
11
11
 
12
12
  Framework packages extend this with their `fallback`, `onError`, and `children` fields.
13
13
 
@@ -15,7 +15,7 @@ Framework packages extend this with their `fallback`, `onError`, and `children`
15
15
 
16
16
  ```ts
17
17
  import type { BaseActorProviderProps } from "@xmachines/play-actor";
18
- import type { DefineRegistryResult } from "@json-render/react";
18
+ import type { DefineRegistryResult } from "@xmachines/json-render-react";
19
19
 
20
20
  interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult> {
21
21
  fallback?: React.ReactNode;
@@ -40,7 +40,7 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
40
40
 
41
41
  | Property | Type | Description | Defined in |
42
42
  | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
43
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L154) |
44
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../../play-dom/type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L167) |
45
- | <a id="property-registryresult"></a> `registryResult` | `TRegistry` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L156) |
46
- | <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. | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L162) |
43
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L159) |
44
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../../play-dom/type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L172) |
45
+ | <a id="property-registryresult"></a> `registryResult` | `TRegistry` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [packages/play-actor/src/abstract-actor.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L161) |
46
+ | <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. | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L167) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BaseViewContextValue\<TRegistry\>
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L118)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L123)
6
6
 
7
7
  Framework-agnostic base for every framework's `ViewContextValue`.
8
8
 
@@ -19,15 +19,15 @@ type) so it is typed via `TRegistry` — the same generic used in `BaseActorProv
19
19
 
20
20
  ## Type Parameters
21
21
 
22
- | Type Parameter | Description |
23
- | ------------------------------ | --------------------------------------------------------------------------------------------- |
24
- | `TRegistry` _extends_ `object` | The framework's component registry type (e.g. `ComponentRegistry` from `@json-render/react`). |
22
+ | Type Parameter | Description |
23
+ | ------------------------------ | ------------------------------------------------------------------------------------------------------- |
24
+ | `TRegistry` _extends_ `object` | The framework's component registry type (e.g. `ComponentRegistry` from `@xmachines/json-render-react`). |
25
25
 
26
26
  ## Properties
27
27
 
28
28
  | Property | Type | Description | Defined in |
29
29
  | ----------------------------------------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30
- | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [packages/play-actor/src/abstract-actor.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L122) |
31
- | <a id="property-registry"></a> `registry` | `TRegistry` | Component registry from registryResult.registry. | [packages/play-actor/src/abstract-actor.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L124) |
32
- | <a id="property-spec"></a> `spec` | [`PlaySpec`](PlaySpec.md) | The current PlaySpec to render. | [packages/play-actor/src/abstract-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L120) |
33
- | <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [packages/play-actor/src/abstract-actor.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L126) |
30
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L127) |
31
+ | <a id="property-registry"></a> `registry` | `TRegistry` | Component registry from registryResult.registry. | [packages/play-actor/src/abstract-actor.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L129) |
32
+ | <a id="property-spec"></a> `spec` | [`PlaySpec`](PlaySpec.md) | The current PlaySpec to render. | [packages/play-actor/src/abstract-actor.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L125) |
33
+ | <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [packages/play-actor/src/abstract-actor.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L131) |
@@ -2,9 +2,9 @@
2
2
 
3
3
  # Interface: PlaySpec
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L43)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L48)
6
6
 
7
- XMachines extension of `@json-render/core` `Spec`.
7
+ XMachines extension of `@xmachines/json-render-core` `Spec`.
8
8
 
9
9
  Adds `contextProps` — an explicit allowlist of machine context fields that
10
10
  `deriveCurrentView` merges into element props as low-priority slots. Only
@@ -22,7 +22,7 @@ entries against your machine's context type at compile time.
22
22
 
23
23
  | Property | Modifier | Type | Description | Inherited from | Defined in |
24
24
  | -------------------------------------------------- | ---------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25
- | <a id="property-contextprops"></a> `contextProps?` | `readonly` | readonly `string`[] | Explicit allowlist of machine context field names to expose as prop slots. Each named field is merged into every spec element's `props` at view derivation time, filling any slot whose current value is `undefined`. Use `typedSpec<TContext>(...)` to constrain entries to `keyof TContext & string`. | - | [packages/play-actor/src/abstract-actor.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L51) |
25
+ | <a id="property-contextprops"></a> `contextProps?` | `readonly` | readonly `string`[] | Explicit allowlist of machine context field names to expose as prop slots. Each named field is merged into every spec element's `props` at view derivation time, filling any slot whose current value is `undefined`. Use `typedSpec<TContext>(...)` to constrain entries to `keyof TContext & string`. | - | [packages/play-actor/src/abstract-actor.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L56) |
26
26
  | <a id="property-elements"></a> `elements` | `public` | `Record`\<`string`, `UIElement`\> | Flat map of elements by key | `Spec.elements` | - |
27
27
  | <a id="property-root"></a> `root` | `public` | `string` | Root element key | `Spec.root` | - |
28
28
  | <a id="property-state"></a> `state?` | `public` | `Record`\<`string`, `unknown`\> | Optional initial state to seed the state model. Components using statePath will read from / write to this state. | `Spec.state` | - |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: Routable
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L27)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L32)
6
6
 
7
7
  Optional capability: Routing support
8
8
 
@@ -10,5 +10,5 @@ Optional capability: Routing support
10
10
 
11
11
  | Property | Modifier | Type | Defined in |
12
12
  | ------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | [packages/play-actor/src/abstract-actor.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L28) |
14
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | [packages/play-actor/src/abstract-actor.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L29) |
13
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | [packages/play-actor/src/abstract-actor.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L33) |
14
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | [packages/play-actor/src/abstract-actor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L34) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: Viewable
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L99)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L104)
6
6
 
7
7
  Actor capability for exposing renderable view state.
8
8
 
@@ -15,4 +15,4 @@ framework adapter.
15
15
 
16
16
  | Property | Modifier | Type | Description | Defined in |
17
17
  | ----------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
18
- | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](PlaySpec.md) \| `null`\> | Current view signal. Contains the json-render PlaySpec for the current machine state, or null when no view is active. Infrastructure renders view — Logic-Driven UI invariant. | [packages/play-actor/src/abstract-actor.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L106) |
18
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](PlaySpec.md) \| `null`\> | Current view signal. Contains the json-render PlaySpec for the current machine state, or null when no view is active. Infrastructure renders view — Logic-Driven UI invariant. | [packages/play-actor/src/abstract-actor.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-actor/src/abstract-actor.ts#L111) |
@@ -17,14 +17,14 @@ npm install @xmachines/play-dom
17
17
  **Peer dependencies:**
18
18
 
19
19
  ```bash
20
- npm install xstate @xstate/store @json-render/core @json-render/xstate
20
+ npm install xstate @xstate/store @xmachines/json-render-core @xmachines/json-render-xstate
21
21
  ```
22
22
 
23
23
  ## Quick Start
24
24
 
25
25
  ```typescript
26
26
  import { createRenderer, schema } from "@xmachines/play-dom";
27
- import { defineCatalog } from "@json-render/core";
27
+ import { defineCatalog } from "@xmachines/json-render-core";
28
28
  import { z } from "zod";
29
29
  import type { ComponentFn } from "@xmachines/play-dom";
30
30
 
@@ -74,7 +74,7 @@ disconnect();
74
74
 
75
75
  ```typescript
76
76
  import { createRenderer, schema } from "@xmachines/play-dom";
77
- import { defineCatalog } from "@json-render/core";
77
+ import { defineCatalog } from "@xmachines/json-render-core";
78
78
 
79
79
  const catalog = defineCatalog(schema, {
80
80
  /* ... */
@@ -95,7 +95,7 @@ Factory-level options (`functions`, `validationFunctions`, `navigate`, `onRender
95
95
 
96
96
  ```typescript
97
97
  import { defineRegistry, createPlayUI, schema } from "@xmachines/play-dom";
98
- import { defineCatalog } from "@json-render/core";
98
+ import { defineCatalog } from "@xmachines/json-render-core";
99
99
 
100
100
  const catalog = defineCatalog(schema, {
101
101
  /* ... */
@@ -144,7 +144,7 @@ renderer.disconnect();
144
144
 
145
145
  ```typescript
146
146
  import { createAtom } from "@xstate/store";
147
- import { xstateStoreStateStore } from "@json-render/xstate";
147
+ import { xstateStoreStateStore } from "@xmachines/json-render-xstate";
148
148
 
149
149
  const atom = createAtom({ username: "" });
150
150
  const store = xstateStoreStateStore({ atom });
@@ -179,10 +179,10 @@ Without `functions`, any `$computed` expression silently resolves to `undefined`
179
179
 
180
180
  Provides named validation functions for inline field validation within components. Functions receive `(value, args?)` and return `true` (valid) or `false` (invalid).
181
181
 
182
- Unlike the framework renderers, the DOM renderer has no automatic `ValidationProvider` tree. Components must invoke validation explicitly using `runValidationCheck` / `runValidation` from `@json-render/core`, passing `ctx.ctx.validationFunctions` as `customFunctions`.
182
+ Unlike the framework renderers, the DOM renderer has no automatic `ValidationProvider` tree. Components must invoke validation explicitly using `runValidationCheck` / `runValidation` from `@xmachines/json-render-core`, passing `ctx.ctx.validationFunctions` as `customFunctions`.
183
183
 
184
184
  ```typescript
185
- import { runValidationCheck } from "@json-render/core";
185
+ import { runValidationCheck } from "@xmachines/json-render-core";
186
186
 
187
187
  const mount = createPlayUI(registryResult, {
188
188
  validationFunctions: {
@@ -246,7 +246,7 @@ const mount = createPlayUI(registryResult, {
246
246
  });
247
247
  ```
248
248
 
249
- The argument order matches the upstream `RenderErrorHandler` type from `@json-render/core`: **error first, name second**. This is consistent with the framework renderers (`@json-render/solid`, `@json-render/react`).
249
+ The argument order matches the upstream `RenderErrorHandler` type from `@xmachines/json-render-core`: **error first, name second**. This is consistent with the framework renderers (`@xmachines/json-render-solid`, `@xmachines/json-render-react`).
250
250
 
251
251
  Without `onRenderError`, all three error types are logged via `console.error` and swallowed. No exception propagates, and no unhandled promise rejection is created.
252
252
 
@@ -275,7 +275,7 @@ const MyComponent: ComponentFn<typeof catalog, "MyComponent"> = ({ ctx }) => {
275
275
  | `PlayRenderer` | class | Class-based renderer with `connect()` / `disconnect()` lifecycle |
276
276
  | `defineRegistry(catalog, options)` | function | Build a catalog-typed `DomRegistry` with typed handlers |
277
277
  | `renderSpec(...)` | function | Pure Spec → DOM renderer (low-level) |
278
- | `schema` | const | The `@json-render/dom` schema — pass to `defineCatalog()` |
278
+ | `schema` | const | The `@xmachines/json-render-dom` schema — pass to `defineCatalog()` |
279
279
 
280
280
  ### Key Types
281
281
 
@@ -328,7 +328,7 @@ Public API split into two layers:
328
328
  - `PlayRenderer` — class-based renderer with `connect()` / `disconnect()` lifecycle
329
329
  - `PlayDomOptions`, `CreatePlayUIOptions`, `MountFn`, `MountOptions`
330
330
 
331
- **json-render layer** (upstreamable to @json-render/dom):
331
+ **json-render layer** (re-exported from @xmachines/json-render-dom):
332
332
 
333
333
  - `defineRegistry` — build a catalog-typed DomRegistry
334
334
  - `renderSpec` — pure Spec → DOM renderer (uses resolveElementProps from core)
@@ -386,9 +386,3 @@ Public API split into two layers:
386
386
  - [createRenderer](functions/createRenderer.md)
387
387
  - [defineRegistry](functions/defineRegistry.md)
388
388
  - [renderSpec](functions/renderSpec.md)
389
-
390
- ## References
391
-
392
- ### RenderErrorHandler
393
-
394
- Re-exports [RenderErrorHandler](type-aliases/RenderErrorHandler.md)
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayRenderer
4
4
 
5
- Defined in: [packages/play-dom/src/PlayRenderer.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom/src/PlayRenderer.ts#L66)
5
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/PlayRenderer.ts#L67)
6
6
 
7
7
  PlayRenderer connects an actor's `currentView` signal to the DOM renderer.
8
8
 
@@ -13,6 +13,7 @@ Options from `PlayDomOptions` (which extends `UIProviderOptions`) are all forwar
13
13
  into `DomRenderContext` on every render pass:
14
14
 
15
15
  - `functions` — named compute functions for `{ $computed: "name" }` prop expressions
16
+ - `directives` — custom `$`-prefixed dynamic values (from `defineDirective`), resolved during prop resolution
16
17
  - `validationFunctions` — custom validation functions, available at `ctx.ctx.validationFunctions`
17
18
  - `navigate` — navigation callback, invoked on `onSuccess: { navigate: "..." }` action bindings
18
19
  - `onRenderError` — called with `(error, name)` for component render errors and action handler rejections
@@ -37,7 +38,7 @@ renderer.disconnect();
37
38
 
38
39
  ```typescript
39
40
  import { createAtom } from "@xstate/store";
40
- import { xstateStoreStateStore } from "@json-render/xstate";
41
+ import { xstateStoreStateStore } from "@xmachines/json-render-xstate";
41
42
 
42
43
  const atom = createAtom({ username: "" });
43
44
  const store = xstateStoreStateStore({ atom });
@@ -60,16 +61,16 @@ new PlayRenderer(
60
61
  options?): PlayRenderer;
61
62
  ```
62
63
 
63
- Defined in: [packages/play-dom/src/PlayRenderer.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom/src/PlayRenderer.ts#L100)
64
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/PlayRenderer.ts#L102)
64
65
 
65
66
  #### Parameters
66
67
 
67
- | Parameter | Type | Description |
68
- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
69
- | `container` | `HTMLElement` | `HTMLElement` to render into. Cleared and repopulated on every view transition. |
70
- | `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 providing the `currentView` signal (must implement `Viewable`). |
71
- | `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | Component renderer map — typically `registryResult.registry` from `defineRegistry`. |
72
- | `options` | [`PlayDomOptions`](../interfaces/PlayDomOptions.md) | Configuration (see [PlayDomOptions](../interfaces/PlayDomOptions.md)): - `registryResult` — auto-wires `setState`/`state` from the xstate store. - `store` — external `StateStore` (controlled mode; overrides `spec.state` seeding). - `loading` — streaming mode flag; suppresses missing-child warnings. - `functions` — named compute functions for `$computed` prop expressions. - `validationFunctions` — custom validation functions; available at `ctx.ctx.validationFunctions`. - `navigate` — navigation callback; invoked on `onSuccess: { navigate: "..." }`. - `onRenderError` — `(error, name)` handler for component render errors and action handler rejections; suppresses `console.error` fallback. |
68
+ | Parameter | Type | Description |
69
+ | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
70
+ | `container` | `HTMLElement` | `HTMLElement` to render into. Cleared and repopulated on every view transition. |
71
+ | `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 providing the `currentView` signal (must implement `Viewable`). |
72
+ | `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | Component renderer map — typically `registryResult.registry` from `defineRegistry`. |
73
+ | `options` | [`PlayDomOptions`](../interfaces/PlayDomOptions.md) | Configuration (see [PlayDomOptions](../interfaces/PlayDomOptions.md)): - `registryResult` — auto-wires `setState`/`state` from the xstate store. - `store` — external `StateStore` (controlled mode; overrides `spec.state` seeding). - `loading` — streaming mode flag; suppresses missing-child warnings. - `functions` — named compute functions for `$computed` prop expressions. - `directives` — custom `$`-prefixed dynamic values resolved during prop resolution. - `validationFunctions` — custom validation functions; available at `ctx.ctx.validationFunctions`. - `navigate` — navigation callback; invoked on `onSuccess: { navigate: "..." }`. - `onRenderError` — `(error, name)` handler for component render errors and action handler rejections; suppresses `console.error` fallback. |
73
74
 
74
75
  #### Returns
75
76
 
@@ -83,7 +84,7 @@ Defined in: [packages/play-dom/src/PlayRenderer.ts:100](https://gitlab.com/xmach
83
84
  connect(): void;
84
85
  ```
85
86
 
86
- Defined in: [packages/play-dom/src/PlayRenderer.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom/src/PlayRenderer.ts#L116)
87
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/PlayRenderer.ts#L118)
87
88
 
88
89
  Start watching actor.currentView and render to container.
89
90
  Renders the initial view synchronously, then subscribes to signal changes.
@@ -105,7 +106,7 @@ change. Guard against this by auto-disconnecting first.
105
106
  disconnect(): void;
106
107
  ```
107
108
 
108
- Defined in: [packages/play-dom/src/PlayRenderer.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom/src/PlayRenderer.ts#L125)
109
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/PlayRenderer.ts#L127)
109
110
 
110
111
  Stop watching and clear the container.
111
112
 
@@ -6,7 +6,7 @@
6
6
  function createPlayUI(registryResult, options?): MountFn;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/create-play-ui.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom/src/create-play-ui.ts#L92)
9
+ Defined in: [packages/play-dom/src/create-play-ui.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/create-play-ui.ts#L93)
10
10
 
11
11
  Create a batteries-included DOM renderer mount function.
12
12
 
@@ -16,10 +16,10 @@ once per actor/container pair.
16
16
 
17
17
  ## Parameters
18
18
 
19
- | Parameter | Type | Description |
20
- | ---------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
- | `registryResult` | [`DefineRegistryResult`](../interfaces/DefineRegistryResult.md) | Result from `defineRegistry()` — provides the registry and the lazy handlers factory. |
22
- | `options` | [`CreatePlayUIOptions`](../interfaces/CreatePlayUIOptions.md) | Factory-level configuration (see [CreatePlayUIOptions](../interfaces/CreatePlayUIOptions.md)): - `functions` — named compute functions for `$computed` prop expressions. - `validationFunctions` — custom validation functions; available at `ctx.ctx.validationFunctions`. - `navigate` — navigation callback; invoked on `onSuccess: { navigate: "..." }`. - `onRenderError` — `(error, name)` handler for component render errors and action handler rejections. - `fallback` — element shown when the actor's initial view is `null`. |
19
+ | Parameter | Type | Description |
20
+ | ---------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
21
+ | `registryResult` | [`DefineRegistryResult`](../interfaces/DefineRegistryResult.md) | Result from `defineRegistry()` — provides the registry and the lazy handlers factory. |
22
+ | `options` | [`CreatePlayUIOptions`](../interfaces/CreatePlayUIOptions.md) | Factory-level configuration (see [CreatePlayUIOptions](../interfaces/CreatePlayUIOptions.md)): - `functions` — named compute functions for `$computed` prop expressions. - `directives` — custom `$`-prefixed dynamic values resolved during prop resolution. - `validationFunctions` — custom validation functions; available at `ctx.ctx.validationFunctions`. - `navigate` — navigation callback; invoked on `onSuccess: { navigate: "..." }`. - `onRenderError` — `(error, name)` handler for component render errors and action handler rejections. - `fallback` — element shown when the actor's initial view is `null`. |
23
23
 
24
24
  ## Returns
25
25
 
@@ -6,7 +6,7 @@
6
6
  function createRenderer<C>(catalog, componentMap): (actor, container, options?) => () => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/create-renderer.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom/src/create-renderer.ts#L84)
9
+ Defined in: [packages/play-dom/src/create-renderer.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/create-renderer.ts#L84)
10
10
 
11
11
  Create a reusable DOM renderer factory from a catalog and component map.
12
12