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

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 (319) hide show
  1. package/api/@xmachines/play/README.md +4 -4
  2. package/api/@xmachines/play/classes/PlayError.md +10 -4
  3. package/api/@xmachines/play/type-aliases/PlayEvent.md +3 -3
  4. package/api/@xmachines/play-actor/README.md +6 -6
  5. package/api/@xmachines/play-actor/classes/AbstractActor.md +25 -3
  6. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  7. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  8. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  9. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  10. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  11. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  12. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  13. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  14. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  15. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  16. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  17. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +3 -3
  18. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +3 -3
  19. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +7 -7
  20. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  21. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +3 -3
  22. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  23. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  24. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  25. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  26. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  27. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  28. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  29. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  30. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  31. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  32. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  33. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  34. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  35. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  36. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  37. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +4 -4
  38. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  39. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  40. package/api/@xmachines/play-react/README.md +1 -1
  41. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +31 -5
  42. package/api/@xmachines/play-react/functions/defineRegistry.md +2 -0
  43. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  44. package/api/@xmachines/play-react/functions/useBoundProp.md +2 -0
  45. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  46. package/api/@xmachines/play-react/functions/useStateBinding.md +2 -0
  47. package/api/@xmachines/play-react/interfaces/ComponentContext.md +2 -0
  48. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  49. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  50. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +7 -7
  51. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +2 -0
  52. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  53. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  54. package/api/@xmachines/play-react-router/README.md +3 -3
  55. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  56. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  57. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  58. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  59. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  60. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  61. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  62. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +4 -4
  63. package/api/@xmachines/play-router/README.md +5 -5
  64. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  65. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  66. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  67. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  68. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  69. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  70. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  71. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  72. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  73. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  74. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  75. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  76. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  77. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  78. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  79. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  80. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  81. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  82. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  83. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  84. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  85. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  86. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  87. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  88. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  89. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  90. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +7 -7
  91. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  92. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  93. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  94. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  95. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  96. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  97. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  98. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  99. package/api/@xmachines/play-router/interfaces/RouterBridge.md +4 -4
  100. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  101. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  102. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  103. package/api/@xmachines/play-signals/README.md +2 -2
  104. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  105. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  106. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  107. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  108. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  109. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  110. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +6 -0
  111. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +8 -0
  112. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +2 -0
  113. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +10 -0
  114. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +2 -0
  115. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +2 -0
  116. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +2 -0
  117. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +2 -0
  118. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +2 -0
  119. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +2 -0
  120. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +2 -0
  121. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +2 -0
  122. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +2 -0
  123. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +2 -0
  124. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +2 -0
  125. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  126. package/api/@xmachines/play-solid/README.md +3 -3
  127. package/api/@xmachines/play-solid/functions/defineRegistry.md +2 -0
  128. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  129. package/api/@xmachines/play-solid/functions/useStateBinding.md +2 -0
  130. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +2 -0
  131. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +7 -7
  132. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +2 -0
  133. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  134. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  135. package/api/@xmachines/play-solid-router/README.md +1 -1
  136. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  137. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  138. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  139. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  140. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +23 -3
  141. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  142. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  143. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  144. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +4 -4
  145. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  146. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  147. package/api/@xmachines/play-svelte/functions/defineRegistry.md +2 -0
  148. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +2 -0
  149. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +2 -0
  150. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +7 -7
  151. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +2 -0
  152. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +2 -0
  153. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +2 -0
  154. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  155. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  156. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  157. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  158. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  159. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  160. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +4 -4
  161. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  162. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  163. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  164. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  165. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  166. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  167. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  168. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  169. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  170. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +4 -4
  171. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  172. package/api/@xmachines/play-tanstack-react-router/README.md +4 -4
  173. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  174. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  175. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  176. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  177. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  178. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  179. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  180. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  181. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  182. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  183. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +4 -4
  184. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  185. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  186. package/api/@xmachines/play-tanstack-solid-router/README.md +5 -5
  187. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  188. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  189. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  190. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  191. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  192. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  193. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  194. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +4 -4
  195. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  196. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  197. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  198. package/api/@xmachines/play-vue/README.md +1 -1
  199. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  200. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  201. package/api/@xmachines/play-vue/functions/useStateBinding.md +2 -0
  202. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +2 -0
  203. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  204. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  205. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +2 -0
  206. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  207. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  208. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  209. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  210. package/api/@xmachines/play-vue-router/README.md +1 -1
  211. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  212. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  213. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  214. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  215. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +7 -7
  216. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  217. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +4 -4
  218. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  219. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  220. package/api/@xmachines/play-xstate/README.md +10 -10
  221. package/api/@xmachines/play-xstate/classes/PlayerActor.md +26 -12
  222. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  223. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  224. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  225. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  226. package/api/@xmachines/play-xstate/functions/definePlayer.md +2 -2
  227. package/api/@xmachines/play-xstate/functions/deriveRoute.md +2 -2
  228. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  229. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  230. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  231. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  232. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  233. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  234. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  235. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  236. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  237. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  238. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  239. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  240. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  241. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  242. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  243. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  244. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  245. package/api/README.md +1 -41
  246. package/api/llms.txt +4 -8
  247. package/{api → examples}/@xmachines/play-dom-demo/README.md +2 -2
  248. package/examples/@xmachines/play-dom-demo/functions/initShell.md +20 -0
  249. package/{api → examples}/@xmachines/play-dom-demo/variables/About.md +1 -1
  250. package/{api → examples}/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  251. package/{api → examples}/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  252. package/{api → examples}/@xmachines/play-dom-demo/variables/Home.md +1 -1
  253. package/{api → examples}/@xmachines/play-dom-demo/variables/Login.md +1 -1
  254. package/{api → examples}/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  255. package/{api → examples}/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  256. package/{api → examples}/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  257. package/{api → examples}/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  258. package/{api → examples}/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  259. package/{api → examples}/@xmachines/play-dom-router-demo/README.md +3 -3
  260. package/{api → examples}/@xmachines/play-react-demo/README.md +2 -2
  261. package/{api → examples}/@xmachines/play-react-demo/functions/App.md +1 -1
  262. package/examples/@xmachines/play-react-demo/functions/DebugPanel.md +20 -0
  263. package/examples/@xmachines/play-react-demo/functions/HeaderNav.md +20 -0
  264. package/examples/@xmachines/play-react-demo/functions/Shell.md +22 -0
  265. package/{api → examples}/@xmachines/play-react-demo/variables/About.md +1 -1
  266. package/{api → examples}/@xmachines/play-react-demo/variables/Contact.md +1 -1
  267. package/{api → examples}/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  268. package/{api → examples}/@xmachines/play-react-demo/variables/Home.md +1 -1
  269. package/{api → examples}/@xmachines/play-react-demo/variables/Login.md +1 -1
  270. package/{api → examples}/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  271. package/{api → examples}/@xmachines/play-react-demo/variables/Overview.md +1 -1
  272. package/{api → examples}/@xmachines/play-react-demo/variables/Profile.md +1 -1
  273. package/{api → examples}/@xmachines/play-react-demo/variables/Settings.md +1 -1
  274. package/{api → examples}/@xmachines/play-react-demo/variables/Stats.md +1 -1
  275. package/{api → examples}/@xmachines/play-react-router-demo/README.md +2 -2
  276. package/{api → examples}/@xmachines/play-solid-demo/README.md +3 -3
  277. package/{api → examples}/@xmachines/play-solid-demo/functions/App.md +1 -1
  278. package/examples/@xmachines/play-solid-demo/functions/DebugPanel.md +20 -0
  279. package/examples/@xmachines/play-solid-demo/functions/HeaderNav.md +20 -0
  280. package/examples/@xmachines/play-solid-demo/functions/Shell.md +22 -0
  281. package/{api → examples}/@xmachines/play-solid-demo/variables/About.md +1 -1
  282. package/{api → examples}/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  283. package/{api → examples}/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  284. package/{api → examples}/@xmachines/play-solid-demo/variables/Home.md +1 -1
  285. package/{api → examples}/@xmachines/play-solid-demo/variables/Login.md +1 -1
  286. package/{api → examples}/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  287. package/{api → examples}/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  288. package/{api → examples}/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  289. package/{api → examples}/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  290. package/{api → examples}/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  291. package/{api → examples}/@xmachines/play-solid-router-demo/README.md +3 -3
  292. package/{api → examples}/@xmachines/play-svelte-demo/README.md +1 -1
  293. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +129 -0
  294. package/examples/@xmachines/play-sveltekit-router-demo/README.md +130 -0
  295. package/{api → examples}/@xmachines/play-tanstack-react-router-demo/README.md +3 -3
  296. package/{api → examples}/@xmachines/play-tanstack-solid-router-demo/README.md +4 -4
  297. package/{api → examples}/@xmachines/play-vue-demo/README.md +2 -2
  298. package/{api → examples}/@xmachines/play-vue-router-demo/README.md +2 -2
  299. package/examples/README.md +46 -30
  300. package/package.json +6 -4
  301. package/api/@xmachines/play-actor-shared/README.md +0 -155
  302. package/api/@xmachines/play-actor-shared/interfaces/AuthContext.md +0 -14
  303. package/api/@xmachines/play-actor-shared/type-aliases/AuthActor.md +0 -27
  304. package/api/@xmachines/play-actor-shared/type-aliases/AuthCatalog.md +0 -16
  305. package/api/@xmachines/play-actor-shared/type-aliases/AuthEvents.md +0 -17
  306. package/api/@xmachines/play-actor-shared/type-aliases/AuthInput.md +0 -9
  307. package/api/@xmachines/play-actor-shared/type-aliases/AuthSnapshot.md +0 -11
  308. package/api/@xmachines/play-actor-shared/type-aliases/CatalogProps.md +0 -187
  309. package/api/@xmachines/play-actor-shared/type-aliases/InferProps.md +0 -17
  310. package/api/@xmachines/play-actor-shared/variables/authCatalog.md +0 -173
  311. package/api/@xmachines/play-actor-shared/variables/authMachine.md +0 -189
  312. package/api/@xmachines/play-actor-shared/variables/authSetup.md +0 -22
  313. package/api/@xmachines/play-dom-demo/functions/initShell.md +0 -20
  314. package/api/@xmachines/play-react-demo/functions/DebugPanel.md +0 -20
  315. package/api/@xmachines/play-react-demo/functions/HeaderNav.md +0 -20
  316. package/api/@xmachines/play-react-demo/functions/Shell.md +0 -22
  317. package/api/@xmachines/play-solid-demo/functions/DebugPanel.md +0 -20
  318. package/api/@xmachines/play-solid-demo/functions/HeaderNav.md +0 -20
  319. package/api/@xmachines/play-solid-demo/functions/Shell.md +0 -22
@@ -15,7 +15,7 @@ This package exports the shared Play protocol surface. It exists to preserve str
15
15
  - **Actors** (business authority)
16
16
  - **Infrastructure adapters** (routers/renderers that observe and forward)
17
17
 
18
- Per [Play RFC](../../../rfc/play.md), this package supports:
18
+ Per [Play RFC](../docs/rfc/play.md), this package supports:
19
19
 
20
20
  - **Actor Authority (INV-01):** infrastructure proposes intents, actor decides validity
21
21
  - **Strict Separation (INV-02):** protocol types are framework-agnostic
@@ -95,9 +95,9 @@ See each package's README for the full list of error classes and when they are t
95
95
 
96
96
  ## Related Packages
97
97
 
98
- - [@xmachines/play-actor](../play-actor/README.md)
99
- - [@xmachines/play-xstate](../play-xstate/README.md)
100
- - [@xmachines/play-router](../play-router/README.md)
98
+ - [@xmachines/play-actor](../play-actor)
99
+ - [@xmachines/play-xstate](../play-xstate)
100
+ - [@xmachines/play-router](../play-router)
101
101
 
102
102
  ## License
103
103
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayError
4
4
 
5
- Defined in: [packages/play/src/errors.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play/src/errors.ts#L63)
5
+ Defined in: [packages/play/src/errors.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play/src/errors.ts#L63)
6
6
 
7
7
  Base class for all typed runtime errors thrown by `@xmachines/*` packages.
8
8
 
@@ -82,7 +82,7 @@ new PlayError(
82
82
  options?): PlayError;
83
83
  ```
84
84
 
85
- Defined in: [packages/play/src/errors.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play/src/errors.ts#L82)
85
+ Defined in: [packages/play/src/errors.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play/src/errors.ts#L82)
86
86
 
87
87
  #### Parameters
88
88
 
@@ -108,10 +108,10 @@ Error.constructor;
108
108
  | Property | Modifier | Type | Description | Inherited from | Defined in |
109
109
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
110
110
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | `Error.cause` | - |
111
- | <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:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play/src/errors.ts#L74) |
111
+ | <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:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play/src/errors.ts#L74) |
112
112
  | <a id="property-message"></a> `message` | `public` | `string` | - | `Error.message` | - |
113
113
  | <a id="property-name"></a> `name` | `public` | `string` | - | `Error.name` | - |
114
- | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or module that threw this error (e.g. `"RouterBridgeBase"`). | - | [packages/play/src/errors.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play/src/errors.ts#L65) |
114
+ | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or module that threw this error (e.g. `"RouterBridgeBase"`). | - | [packages/play/src/errors.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play/src/errors.ts#L65) |
115
115
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | `Error.stack` | - |
116
116
  | <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` | - |
117
117
 
@@ -123,6 +123,8 @@ Error.constructor;
123
123
  static captureStackTrace(targetObject, constructorOpt?): void;
124
124
  ```
125
125
 
126
+ Defined in: `@types/node`
127
+
126
128
  Creates a `.stack` property on `targetObject`, which when accessed returns
127
129
  a string representing the location in the code at which
128
130
  `Error.captureStackTrace()` was called.
@@ -192,6 +194,8 @@ Error.captureStackTrace;
192
194
  static isError(error): error is Error;
193
195
  ```
194
196
 
197
+ Defined in: `typescript`
198
+
195
199
  Indicates whether the argument provided is a built-in Error instance or not.
196
200
 
197
201
  #### Parameters
@@ -218,6 +222,8 @@ Error.isError;
218
222
  static prepareStackTrace(err, stackTraces): any;
219
223
  ```
220
224
 
225
+ Defined in: `@types/node`
226
+
221
227
  #### Parameters
222
228
 
223
229
  | Parameter | Type |
@@ -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.28/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.30/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.28/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.30/packages/play/src/types.ts#L70) |
38
38
 
39
39
  ## Type Parameters
40
40
 
@@ -78,4 +78,4 @@ const invalid: LoginEvent = { type: "auth.login" }; // Error!
78
78
 
79
79
  ## See
80
80
 
81
- [Play RFC](../../../../rfc/play.md)
81
+ [Play RFC](../../docs/rfc/play.md)
@@ -10,13 +10,13 @@ Foundation for all actor implementations, enforcing XState compatibility and rea
10
10
 
11
11
  `@xmachines/play-actor` provides `AbstractActor`, a base class that extends XState's `Actor` while enforcing the Play Architecture's signal protocol. It maintains XState ecosystem compatibility (inspection tools, devtools) while exposing reactive signals for infrastructure layer communication.
12
12
 
13
- Per [Play RFC](../../../rfc/play.md), this package implements:
13
+ Per [Play RFC](../docs/rfc/play.md), this package implements:
14
14
 
15
15
  - **Actor Authority (INV-01):** Actor is sole source of truth for state transitions
16
16
  - **Signal-Only Reactivity (INV-05):** Infrastructure observes via TC39 Signals, never directly queries
17
17
  - **Passive Infrastructure (INV-04):** Infrastructure reflects, never decides
18
18
 
19
- **Note:** This is an abstract base class. Concrete implementations are provided by adapters (see [@xmachines/play-xstate](../play-xstate/README.md)).
19
+ **Note:** This is an abstract base class. Concrete implementations are provided by adapters (see [@xmachines/play-xstate](../play-xstate)).
20
20
 
21
21
  ## Installation
22
22
 
@@ -207,9 +207,9 @@ This base class enforces three architectural invariants:
207
207
 
208
208
  ## Related Packages
209
209
 
210
- - **[@xmachines/play-xstate](../play-xstate/README.md)** - Concrete PlayerActor implementation
211
- - **[@xmachines/play-signals](../play-signals/README.md)** - TC39 Signals primitives
212
- - **[@xmachines/play](../play/README.md)** - Protocol types (PlayEvent, RouterBridge)
210
+ - **[@xmachines/play-xstate](../play-xstate)** - Concrete PlayerActor implementation
211
+ - **[@xmachines/play-signals](../play-signals)** - TC39 Signals primitives
212
+ - **[@xmachines/play](../play)** - Protocol types (PlayEvent, RouterBridge)
213
213
 
214
214
  ## License
215
215
 
@@ -234,7 +234,7 @@ reactive signals for Infrastructure layer communication.
234
234
 
235
235
  ## See
236
236
 
237
- [Play RFC](../../../rfc/play.md)
237
+ [Play RFC](../../docs/rfc/play.md)
238
238
 
239
239
  ## Classes
240
240
 
@@ -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:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/src/abstract-actor.ts#L141)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-actor/src/abstract-actor.ts#L141)
6
6
 
7
7
  Abstract base class for Play Architecture actors.
8
8
 
@@ -33,6 +33,8 @@ Infrastructure layer communication.
33
33
  new AbstractActor<TLogic, TEvent>(logic, options?): AbstractActor<TLogic, TEvent>;
34
34
  ```
35
35
 
36
+ Defined in: `xstate`
37
+
36
38
  Creates a new actor instance for the given logic with the provided options,
37
39
  if any.
38
40
 
@@ -65,7 +67,7 @@ Actor<TLogic>.constructor
65
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` | - |
66
68
  | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
67
69
  | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` | - |
68
- | <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:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/src/abstract-actor.ts#L151) |
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:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-actor/src/abstract-actor.ts#L151) |
69
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` | - |
70
72
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | - |
71
73
 
@@ -77,6 +79,8 @@ Actor<TLogic>.constructor
77
79
  observable: InteropSubscribable<SnapshotFrom<TLogic>>;
78
80
  ```
79
81
 
82
+ Defined in: `xstate`
83
+
80
84
  #### Returns
81
85
 
82
86
  [`InteropSubscribable`](https://www.jsdocs.io/package/xstate#InteropSubscribable)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>\>
@@ -95,6 +99,8 @@ Actor.[observable]
95
99
  getPersistedSnapshot(): Snapshot<unknown>;
96
100
  ```
97
101
 
102
+ Defined in: `xstate`
103
+
98
104
  Obtain the internal state of the actor, which can be persisted.
99
105
 
100
106
  #### Returns
@@ -129,6 +135,8 @@ Actor.getPersistedSnapshot;
129
135
  getSnapshot(): SnapshotFrom<TLogic>;
130
136
  ```
131
137
 
138
+ Defined in: `xstate`
139
+
132
140
  Read an actor’s snapshot synchronously.
133
141
 
134
142
  #### Returns
@@ -164,6 +172,8 @@ Actor.getSnapshot;
164
172
  on<TType>(type, handler): Subscription;
165
173
  ```
166
174
 
175
+ Defined in: `xstate`
176
+
167
177
  #### Type Parameters
168
178
 
169
179
  | Type Parameter |
@@ -195,6 +205,8 @@ Actor.on;
195
205
  select<TSelected>(selector, equalityFn?): Readable<TSelected>;
196
206
  ```
197
207
 
208
+ Defined in: `xstate`
209
+
198
210
  #### Type Parameters
199
211
 
200
212
  | Type Parameter |
@@ -226,7 +238,7 @@ Actor.select;
226
238
  abstract send(event): void;
227
239
  ```
228
240
 
229
- Defined in: [packages/play-actor/src/abstract-actor.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/src/abstract-actor.ts#L158)
241
+ Defined in: [packages/play-actor/src/abstract-actor.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-actor/src/abstract-actor.ts#L158)
230
242
 
231
243
  Send event to Actor.
232
244
 
@@ -256,6 +268,8 @@ Actor.send;
256
268
  start(): this;
257
269
  ```
258
270
 
271
+ Defined in: `xstate`
272
+
259
273
  Starts the Actor from the initial state
260
274
 
261
275
  #### Returns
@@ -276,6 +290,8 @@ Actor.start;
276
290
  stop(): this;
277
291
  ```
278
292
 
293
+ Defined in: `xstate`
294
+
279
295
  Stops the Actor and unsubscribe all listeners.
280
296
 
281
297
  #### Returns
@@ -298,6 +314,8 @@ Actor.stop;
298
314
  subscribe(observer): Subscription;
299
315
  ```
300
316
 
317
+ Defined in: `xstate`
318
+
301
319
  Subscribe an observer to an actor’s snapshot values.
302
320
 
303
321
  ##### Parameters
@@ -374,6 +392,8 @@ subscribe(
374
392
  completeListener?): Subscription;
375
393
  ```
376
394
 
395
+ Defined in: `xstate`
396
+
377
397
  Subscribe an observer to an actor’s snapshot values.
378
398
 
379
399
  ##### Parameters
@@ -451,6 +471,8 @@ Actor.subscribe;
451
471
  toJSON(): object;
452
472
  ```
453
473
 
474
+ Defined in: `xstate`
475
+
454
476
  #### Returns
455
477
 
456
478
  `object`
@@ -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:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/src/abstract-actor.ts#L86)
9
+ Defined in: [packages/play-actor/src/abstract-actor.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-actor/src/abstract-actor.ts#L86)
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,7 +2,7 @@
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.28/packages/play-actor/src/abstract-actor.ts#L43)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-actor/src/abstract-actor.ts#L43)
6
6
 
7
7
  XMachines extension of `@json-render/core` `Spec`.
8
8
 
@@ -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.28/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:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-actor/src/abstract-actor.ts#L51) |
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.28/packages/play-actor/src/abstract-actor.ts#L27)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-actor/src/abstract-actor.ts#L27)
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.28/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.28/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:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/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.30/packages/play-actor/src/abstract-actor.ts#L29) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ViewMetadata
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/src/abstract-actor.ts#L100)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-actor/src/abstract-actor.ts#L100)
6
6
 
7
7
  View metadata for rendering.
8
8
 
@@ -13,5 +13,5 @@ Used by PlayRenderer to dynamically render UI based on actor state.
13
13
 
14
14
  | Property | Type | Description | Defined in |
15
15
  | ------------------------------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
16
- | <a id="property-component"></a> `component` | `string` | Root element type name (for diagnostics and component resolution) | [packages/play-actor/src/abstract-actor.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/src/abstract-actor.ts#L102) |
17
- | <a id="property-spec"></a> `spec` | [`PlaySpec`](PlaySpec.md) | XMachines view spec — extends `@json-render/core` Spec with `contextProps` for explicit context field exposure. Use `typedSpec<TContext>(...)` at the definition site to validate `contextProps` entries against the machine context type. | [packages/play-actor/src/abstract-actor.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/src/abstract-actor.ts#L110) |
16
+ | <a id="property-component"></a> `component` | `string` | Root element type name (for diagnostics and component resolution) | [packages/play-actor/src/abstract-actor.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-actor/src/abstract-actor.ts#L102) |
17
+ | <a id="property-spec"></a> `spec` | [`PlaySpec`](PlaySpec.md) | XMachines view spec — extends `@json-render/core` Spec with `contextProps` for explicit context field exposure. Use `typedSpec<TContext>(...)` at the definition site to validate `contextProps` entries against the machine context type. | [packages/play-actor/src/abstract-actor.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-actor/src/abstract-actor.ts#L110) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: Viewable
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/src/abstract-actor.ts#L121)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-actor/src/abstract-actor.ts#L121)
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)\<[`ViewMetadata`](ViewMetadata.md) \| `null`\> | Current view signal. State signal containing view.component and view.spec from meta.view. Infrastructure renders view — Logic-Driven UI invariant. | [packages/play-actor/src/abstract-actor.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/src/abstract-actor.ts#L128) |
18
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`ViewMetadata`](ViewMetadata.md) \| `null`\> | Current view signal. State signal containing view.component and view.spec from meta.view. Infrastructure renders view — Logic-Driven UI invariant. | [packages/play-actor/src/abstract-actor.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-actor/src/abstract-actor.ts#L128) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayRenderer
4
4
 
5
- Defined in: [PlayRenderer.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/PlayRenderer.ts#L40)
5
+ Defined in: [PlayRenderer.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/PlayRenderer.ts#L40)
6
6
 
7
7
  PlayRenderer connects an actor's currentView signal to the DOM renderer.
8
8
 
@@ -34,7 +34,7 @@ new PlayRenderer(
34
34
  options?): PlayRenderer;
35
35
  ```
36
36
 
37
- Defined in: [PlayRenderer.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/PlayRenderer.ts#L52)
37
+ Defined in: [PlayRenderer.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/PlayRenderer.ts#L52)
38
38
 
39
39
  #### Parameters
40
40
 
@@ -57,7 +57,7 @@ Defined in: [PlayRenderer.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/bl
57
57
  connect(): void;
58
58
  ```
59
59
 
60
- Defined in: [PlayRenderer.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/PlayRenderer.ts#L63)
60
+ Defined in: [PlayRenderer.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/PlayRenderer.ts#L63)
61
61
 
62
62
  Start watching actor.currentView and render to container.
63
63
  Renders the initial view synchronously, then subscribes to signal changes.
@@ -74,7 +74,7 @@ Renders the initial view synchronously, then subscribes to signal changes.
74
74
  disconnect(): void;
75
75
  ```
76
76
 
77
- Defined in: [PlayRenderer.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/PlayRenderer.ts#L71)
77
+ Defined in: [PlayRenderer.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/PlayRenderer.ts#L71)
78
78
 
79
79
  Stop watching and clear the container.
80
80
 
@@ -6,7 +6,7 @@
6
6
  function connectRenderer(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [connect-renderer.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/connect-renderer.ts#L46)
9
+ Defined in: [connect-renderer.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/connect-renderer.ts#L46)
10
10
 
11
11
  Connect a signal-driven DOM renderer to an actor's currentView signal.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function defineRegistry<C>(_catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
- Defined in: [json-render/types.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/types.ts#L351)
9
+ Defined in: [json-render/types.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L351)
10
10
 
11
11
  Build a `DomRegistry` from a catalog and component/action options.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function renderSpec(spec, store, registry, send, actorActions): Node | null;
7
7
  ```
8
8
 
9
- Defined in: [json-render/renderer.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/renderer.ts#L54)
9
+ Defined in: [json-render/renderer.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/renderer.ts#L54)
10
10
 
11
11
  Render a Spec tree into DOM nodes using the provided `DomRegistry`.
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ComponentContext\<C, K\>
4
4
 
5
- Defined in: [json-render/types.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/types.ts#L152)
5
+ Defined in: [json-render/types.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L152)
6
6
 
7
7
  Catalog-typed context passed to each DOM component function.
8
8
 
@@ -54,9 +54,9 @@ const Login: ComponentFn<AuthCatalog, "Login"> = ({ props, emit, on, bindings })
54
54
 
55
55
  | Property | Type | Description | Defined in |
56
56
  | ----------------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
57
- | <a id="property-bindings"></a> `bindings` | `Record`\<`string`, `string`\> \| `undefined` | Two-way binding paths resolved from `$bindState` / `$bindItem` prop expressions. Keys match prop names that had `$bindState`/`$bindItem` expressions in the spec; values are the absolute state-store paths to write back to on user input. `undefined` when no bindings were found for this element. | [json-render/types.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/types.ts#L168) |
58
- | <a id="property-children"></a> `children` | `Node`[] | Rendered child nodes from the spec's `children` list. Append these into the returned element where children should appear. | [json-render/types.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/types.ts#L159) |
59
- | <a id="property-ctx"></a> `ctx` | [`DomRenderContext`](DomRenderContext.md) | Low-level render context. Exposes `send`, `store`, `actorActions`, and `renderChildren` for advanced use cases. Framework renderers do not expose this field — prefer `emit`/`on` for event dispatch and `children` for child rendering. | [json-render/types.ts:206](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/types.ts#L206) |
60
- | <a id="property-emit"></a> `emit` | (`event`) => `void` | Dispatch a named event defined in the spec's `on` map. Resolves the catalog action binding, applies param expressions against the current state store, and calls `send()` with the mapped XState event type. **Example** `btn.addEventListener("click", () => emit("submit"));` | [json-render/types.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/types.ts#L180) |
61
- | <a id="property-on"></a> `on` | (`event`) => [`EventHandle`](EventHandle.md) | Get an `EventHandle` for a named event from the spec's `on` map. Use when you need `shouldPreventDefault` or want to check whether an `on` binding exists before attaching a listener. **Example** `const handle = on("submit"); if (handle.bound) { form.addEventListener("submit", (e) => { if (handle.shouldPreventDefault) e.preventDefault(); handle.emit(); }); }` | [json-render/types.ts:198](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/types.ts#L198) |
62
- | <a id="property-props"></a> `props` | `InferComponentProps`\<`C`, `K`\> | Catalog-typed, store-resolved props for this component. | [json-render/types.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/types.ts#L154) |
57
+ | <a id="property-bindings"></a> `bindings` | `Record`\<`string`, `string`\> \| `undefined` | Two-way binding paths resolved from `$bindState` / `$bindItem` prop expressions. Keys match prop names that had `$bindState`/`$bindItem` expressions in the spec; values are the absolute state-store paths to write back to on user input. `undefined` when no bindings were found for this element. | [json-render/types.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L168) |
58
+ | <a id="property-children"></a> `children` | `Node`[] | Rendered child nodes from the spec's `children` list. Append these into the returned element where children should appear. | [json-render/types.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L159) |
59
+ | <a id="property-ctx"></a> `ctx` | [`DomRenderContext`](DomRenderContext.md) | Low-level render context. Exposes `send`, `store`, `actorActions`, and `renderChildren` for advanced use cases. Framework renderers do not expose this field — prefer `emit`/`on` for event dispatch and `children` for child rendering. | [json-render/types.ts:206](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L206) |
60
+ | <a id="property-emit"></a> `emit` | (`event`) => `void` | Dispatch a named event defined in the spec's `on` map. Resolves the catalog action binding, applies param expressions against the current state store, and calls `send()` with the mapped XState event type. **Example** `btn.addEventListener("click", () => emit("submit"));` | [json-render/types.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L180) |
61
+ | <a id="property-on"></a> `on` | (`event`) => [`EventHandle`](EventHandle.md) | Get an `EventHandle` for a named event from the spec's `on` map. Use when you need `shouldPreventDefault` or want to check whether an `on` binding exists before attaching a listener. **Example** `const handle = on("submit"); if (handle.bound) { form.addEventListener("submit", (e) => { if (handle.shouldPreventDefault) e.preventDefault(); handle.emit(); }); }` | [json-render/types.ts:198](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L198) |
62
+ | <a id="property-props"></a> `props` | `InferComponentProps`\<`C`, `K`\> | Catalog-typed, store-resolved props for this component. | [json-render/types.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L154) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ConnectRendererOptions
4
4
 
5
- Defined in: [xm-types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/xm-types.ts#L35)
5
+ Defined in: [xm-types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L35)
6
6
 
7
7
  Options for connectRenderer() — backward compat API.
8
8
 
@@ -10,9 +10,9 @@ Options for connectRenderer() — backward compat API.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-actions"></a> `actions?` | `Record`\<`string`, `string`\> | Map of json-render actionName → XState event type | [xm-types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/xm-types.ts#L49) |
14
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [xm-types.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/xm-types.ts#L37) |
15
- | <a id="property-container"></a> `container` | `HTMLElement` | Container element to render into | [xm-types.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/xm-types.ts#L43) |
16
- | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional element shown when currentView is null (defaults to nothing — clears container) | [xm-types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/xm-types.ts#L46) |
17
- | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | Registry of component renderers — replaces old `components` map | [xm-types.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/xm-types.ts#L40) |
18
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored. When omitted, a fresh @xstate/store atom is created internally per view transition. | [xm-types.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/xm-types.ts#L56) |
13
+ | <a id="property-actions"></a> `actions?` | `Record`\<`string`, `string`\> | Map of json-render actionName → XState event type | [xm-types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L49) |
14
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [xm-types.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L37) |
15
+ | <a id="property-container"></a> `container` | `HTMLElement` | Container element to render into | [xm-types.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L43) |
16
+ | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional element shown when currentView is null (defaults to nothing — clears container) | [xm-types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L46) |
17
+ | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | Registry of component renderers — replaces old `components` map | [xm-types.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L40) |
18
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored. When omitted, a fresh @xstate/store atom is created internally per view transition. | [xm-types.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/xm-types.ts#L56) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DefineRegistryOptions\<C\>
4
4
 
5
- Defined in: [json-render/types.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/types.ts#L275)
5
+ Defined in: [json-render/types.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L275)
6
6
 
7
7
  Options for `defineRegistry`.
8
8
 
@@ -21,5 +21,5 @@ directly via `send()` to an XState actor instead of calling framework action han
21
21
 
22
22
  | Property | Type | Description | Defined in |
23
23
  | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
24
- | <a id="property-actions"></a> `actions?` | `InferCatalogActions`\<`C`\> _extends_ `Record`\<`string`, `never`\> ? `Record`\<`string`, `string`\> : `Record`\<keyof `InferCatalogActions`\<`C`\>, `string`\> | Map of catalog action name → XState event type string. When a spec element fires `emit("login")`, the DOM renderer looks up `actions.login` (e.g. `"auth.login"`) and calls `send({ type: "auth.login", ...params })`. In the framework renderers this field holds async handler functions. In the DOM renderer it is a simpler string map because routing to the actor is handled by the XMachines play-dom layer rather than inside the json-render action system. | [json-render/types.ts:291](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/types.ts#L291) |
25
- | <a id="property-components"></a> `components?` | [`ComponentRegistry`](../type-aliases/ComponentRegistry.md)\<`C`\> | Catalog-typed component implementations. Each key must match a component declared in the catalog. | [json-render/types.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/types.ts#L280) |
24
+ | <a id="property-actions"></a> `actions?` | `InferCatalogActions`\<`C`\> _extends_ `Record`\<`string`, `never`\> ? `Record`\<`string`, `string`\> : `Record`\<keyof `InferCatalogActions`\<`C`\>, `string`\> | Map of catalog action name → XState event type string. When a spec element fires `emit("login")`, the DOM renderer looks up `actions.login` (e.g. `"auth.login"`) and calls `send({ type: "auth.login", ...params })`. In the framework renderers this field holds async handler functions. In the DOM renderer it is a simpler string map because routing to the actor is handled by the XMachines play-dom layer rather than inside the json-render action system. | [json-render/types.ts:291](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L291) |
25
+ | <a id="property-components"></a> `components?` | [`ComponentRegistry`](../type-aliases/ComponentRegistry.md)\<`C`\> | Catalog-typed component implementations. Each key must match a component declared in the catalog. | [json-render/types.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L280) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DefineRegistryResult
4
4
 
5
- Defined in: [json-render/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/types.ts#L303)
5
+ Defined in: [json-render/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L303)
6
6
 
7
7
  Result returned by `defineRegistry`.
8
8
 
@@ -14,5 +14,5 @@ callers can pass it directly to `connectRenderer` or `PlayRenderer`.
14
14
 
15
15
  | Property | Type | Description | Defined in |
16
16
  | ------------------------------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actoractions"></a> `actorActions` | `Record`\<`string`, `string`\> | Resolved map of catalog action name → XState event type string. Pass to `connectRenderer({ ..., actions: actorActions })` or `new PlayRenderer(container, actor, registry, { actions: actorActions })`. | [json-render/types.ts:314](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/types.ts#L314) |
18
- | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | The built `DomRegistry`, ready to pass to `connectRenderer` or `PlayRenderer`. | [json-render/types.ts:307](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/src/json-render/types.ts#L307) |
17
+ | <a id="property-actoractions"></a> `actorActions` | `Record`\<`string`, `string`\> | Resolved map of catalog action name → XState event type string. Pass to `connectRenderer({ ..., actions: actorActions })` or `new PlayRenderer(container, actor, registry, { actions: actorActions })`. | [json-render/types.ts:314](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L314) |
18
+ | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | The built `DomRegistry`, ready to pass to `connectRenderer` or `PlayRenderer`. | [json-render/types.ts:307](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-dom/src/json-render/types.ts#L307) |