@xmachines/docs 1.0.0-beta.48 → 1.0.0-beta.51

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 (311) hide show
  1. package/README.md +4 -4
  2. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  3. package/api/@xmachines/play/classes/PlayError.md +4 -4
  4. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  6. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  7. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  8. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  9. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  10. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  11. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  13. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  14. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  15. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  16. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  17. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  18. package/api/@xmachines/play-dom/functions/renderSpec.md +3 -3
  19. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  20. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +13 -13
  21. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +6 -6
  22. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  23. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +12 -12
  24. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  25. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  26. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +5 -5
  27. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +5 -5
  28. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  29. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  31. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  35. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  40. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  41. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  42. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  43. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  44. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  45. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  46. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  47. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  48. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  49. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  50. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  51. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  52. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  53. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  54. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  55. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  56. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  57. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  58. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  59. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  60. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  61. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  62. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  63. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  64. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  65. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  66. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  67. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  68. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  69. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  70. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  71. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  72. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  73. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  74. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  75. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  76. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  77. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  78. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  79. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  80. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  81. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  82. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  83. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  84. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  85. package/api/@xmachines/play-router/functions/createRouteMatcher.md +1 -1
  86. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  87. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  88. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  89. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  90. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  91. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  92. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  93. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  94. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  95. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  96. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  97. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  98. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  99. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  100. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  101. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  102. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  103. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  104. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  105. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  106. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  107. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  108. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  109. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  110. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +4 -4
  111. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  112. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  113. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  114. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  115. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  116. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  117. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  118. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  119. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  120. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  121. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  122. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  123. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  124. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  125. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  126. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  127. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  128. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  129. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  130. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  131. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  132. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  133. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  134. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  135. package/api/@xmachines/play-solid/variables/PlayUIProvider.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 +3 -3
  141. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  142. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  143. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  144. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  145. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  146. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  147. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  148. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  149. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  150. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  151. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  152. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  153. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  154. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  155. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  156. package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +1 -1
  157. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  158. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  159. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  160. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  161. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  162. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  163. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  164. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  165. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  166. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  167. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  168. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  169. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  170. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  171. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  172. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  173. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  174. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  175. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  176. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  177. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  178. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  179. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  180. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  181. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  182. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  183. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  184. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  185. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  186. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  187. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  188. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  189. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  190. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  191. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  192. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  193. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  194. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  195. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  196. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  197. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  198. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  199. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  200. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  201. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  202. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  203. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  204. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  205. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  206. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  207. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  208. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  209. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  210. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  211. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  212. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  213. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  214. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  215. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  216. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  217. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  218. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  219. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  220. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  221. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  222. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  223. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  224. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  225. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  226. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  227. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  228. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  229. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  230. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  231. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  232. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  233. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  234. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  235. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  236. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  237. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  238. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  239. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  240. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  241. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  242. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  243. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  244. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  245. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  246. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  247. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  248. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  249. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  250. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  251. package/contributing/README.md +10 -0
  252. package/{guides → contributing}/configuration.md +19 -35
  253. package/{guides → contributing}/deployment.md +0 -22
  254. package/{guides → contributing}/development.md +2 -2
  255. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  256. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  257. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  258. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  259. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  260. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  261. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  262. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  263. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  264. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  265. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  266. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  267. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  268. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  269. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  270. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  271. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  272. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  273. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  274. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  275. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  276. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  277. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  278. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  279. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  280. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  281. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  282. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  283. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  284. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  285. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  286. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  287. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  288. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  289. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  290. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  291. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  292. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  293. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  294. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  295. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  296. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  297. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  298. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  299. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  300. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  301. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  302. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  303. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  304. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  305. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  306. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  307. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  308. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  309. package/guides/README.md +4 -0
  310. package/package.json +4 -2
  311. /package/{guides → contributing}/testing.md +0 -0
package/README.md CHANGED
@@ -89,10 +89,10 @@ Concept guides, tutorials, and operational docs for working with XMachines:
89
89
  **Development & Operations:**
90
90
 
91
91
  - **[Architecture](guides/architecture.md)** — Package layers, data flows, key abstractions, TypeScript build graph
92
- - **[Configuration](guides/configuration.md)** — TypeScript, linting, formatting, Vitest, CI/CD, and release configuration
93
- - **[Development](guides/development.md)** — Monorepo setup, build system, adding packages, code conventions
94
- - **[Testing](guides/testing.md)** — Vitest setup, node vs browser modes, test patterns, coverage requirements
95
- - **[Deployment](guides/deployment.md)** — npm publishing, semantic-release process, GitLab CI pipeline
92
+ - **[Development](contributing/development.md)** — Monorepo setup, build system, adding packages, code conventions
93
+ - **[Configuration](contributing/configuration.md)** — TypeScript, linting, formatting, Vitest, CI/CD, and release configuration
94
+ - **[Testing](contributing/testing.md)** — Vitest setup, node vs browser modes, test patterns, coverage requirements
95
+ - **[Deployment](contributing/deployment.md)** — npm publishing, semantic-release process, GitLab CI pipeline
96
96
 
97
97
  ### Examples
98
98
 
package/api/@xmachines/play/classes/NonNullableError.md CHANGED
@@ -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.48/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.51/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.48/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.51/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.48/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.51/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.48/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.51/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
 
package/api/@xmachines/play/classes/PlayError.md CHANGED
@@ -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.48/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.51/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.48/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.51/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.48/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.51/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.48/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.51/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
 
package/api/@xmachines/play/functions/assertNonNullable.md CHANGED
@@ -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.48/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.51/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
package/api/@xmachines/play/type-aliases/PlayEvent.md CHANGED
@@ -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.48/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.51/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.48/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.51/packages/play/src/types.ts#L70) |
38
38
 
39
39
  ## Type Parameters
40
40
 
package/api/@xmachines/play-actor/classes/AbstractActor.md CHANGED
@@ -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.48/packages/play-actor/src/abstract-actor.ts#L180)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L180)
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.48/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:190](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L190) |
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.48/packages/play-actor/src/abstract-actor.ts#L197)
241
+ Defined in: [packages/play-actor/src/abstract-actor.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L197)
242
242
 
243
243
  Send event to Actor.
244
244
 
package/api/@xmachines/play-actor/functions/typedSpec.md CHANGED
@@ -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.48/packages/play-actor/src/abstract-actor.ts#L83)
9
+ Defined in: [packages/play-actor/src/abstract-actor.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L83)
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
package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md CHANGED
@@ -2,7 +2,7 @@
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.48/packages/play-actor/src/abstract-actor.ts#L150)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L150)
6
6
 
7
7
  Framework-agnostic base props shared by every `ActorProvider` implementation
8
8
  (React, Vue, Solid, Svelte). `TRegistry` captures the framework-specific
@@ -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.48/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.48/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.48/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.48/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:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/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.51/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.51/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.51/packages/play-actor/src/abstract-actor.ts#L162) |
package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md CHANGED
@@ -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.48/packages/play-actor/src/abstract-actor.ts#L118)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L118)
6
6
 
7
7
  Framework-agnostic base for every framework's `ViewContextValue`.
8
8
 
@@ -27,7 +27,7 @@ type) so it is typed via `TRegistry` — the same generic used in `BaseActorProv
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.48/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.48/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.48/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.48/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:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/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.51/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.51/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.51/packages/play-actor/src/abstract-actor.ts#L126) |
package/api/@xmachines/play-actor/interfaces/PlaySpec.md CHANGED
@@ -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.48/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.51/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.48/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.51/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` | - |
package/api/@xmachines/play-actor/interfaces/Routable.md CHANGED
@@ -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.48/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.51/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.48/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.48/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.51/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.51/packages/play-actor/src/abstract-actor.ts#L29) |
package/api/@xmachines/play-actor/interfaces/Viewable.md CHANGED
@@ -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.48/packages/play-actor/src/abstract-actor.ts#L99)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L99)
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.48/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:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L106) |
package/api/@xmachines/play-dom/classes/PlayRenderer.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayRenderer
4
4
 
5
- Defined in: [packages/play-dom/src/PlayRenderer.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/PlayRenderer.ts#L78)
5
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/PlayRenderer.ts#L78)
6
6
 
7
7
  PlayRenderer connects an actor's `currentView` signal to the DOM renderer.
8
8
 
@@ -50,7 +50,7 @@ new PlayRenderer(
50
50
  options?): PlayRenderer;
51
51
  ```
52
52
 
53
- Defined in: [packages/play-dom/src/PlayRenderer.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/PlayRenderer.ts#L101)
53
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/PlayRenderer.ts#L101)
54
54
 
55
55
  #### Parameters
56
56
 
@@ -73,7 +73,7 @@ Defined in: [packages/play-dom/src/PlayRenderer.ts:101](https://gitlab.com/xmach
73
73
  connect(): void;
74
74
  ```
75
75
 
76
- Defined in: [packages/play-dom/src/PlayRenderer.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/PlayRenderer.ts#L117)
76
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/PlayRenderer.ts#L117)
77
77
 
78
78
  Start watching actor.currentView and render to container.
79
79
  Renders the initial view synchronously, then subscribes to signal changes.
@@ -95,7 +95,7 @@ change. Guard against this by auto-disconnecting first.
95
95
  disconnect(): void;
96
96
  ```
97
97
 
98
- Defined in: [packages/play-dom/src/PlayRenderer.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/PlayRenderer.ts#L126)
98
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/PlayRenderer.ts#L126)
99
99
 
100
100
  Stop watching and clear the container.
101
101
 
package/api/@xmachines/play-dom/functions/connectRenderer.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function connectRenderer(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/connect-renderer.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/connect-renderer.ts#L65)
9
+ Defined in: [packages/play-dom/src/connect-renderer.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/connect-renderer.ts#L65)
10
10
 
11
11
  Connect a signal-driven DOM renderer to an actor's `currentView` signal.
12
12
 
package/api/@xmachines/play-dom/functions/createPlayUI.md CHANGED
@@ -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:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/create-play-ui.ts#L64)
9
+ Defined in: [packages/play-dom/src/create-play-ui.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/create-play-ui.ts#L64)
10
10
 
11
11
  Create a batteries-included DOM renderer mount function.
12
12
 
package/api/@xmachines/play-dom/functions/createRenderer.md CHANGED
@@ -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:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/create-renderer.ts#L83)
9
+ Defined in: [packages/play-dom/src/create-renderer.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/create-renderer.ts#L83)
10
10
 
11
11
  Create a reusable DOM renderer factory from a catalog and component map.
12
12
 
package/api/@xmachines/play-dom/functions/defineRegistry.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function defineRegistry<C>(_catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:398](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/json-render/types.ts#L398)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:398](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L398)
10
10
 
11
11
  ## Type Parameters
12
12
 
package/api/@xmachines/play-dom/functions/renderSpec.md CHANGED
@@ -17,7 +17,7 @@ function renderSpec(
17
17
  ): Node | null;
18
18
  ```
19
19
 
20
- Defined in: [packages/play-dom/src/json-render/renderer.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/json-render/renderer.ts#L116)
20
+ Defined in: [packages/play-dom/src/json-render/renderer.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/renderer.ts#L116)
21
21
 
22
22
  Render a Spec tree into DOM nodes using the provided `DomRegistry`.
23
23
 
@@ -52,10 +52,10 @@ or has no registered renderer.
52
52
 
53
53
  ## Remarks
54
54
 
55
- **Devtools isolation in tests:** The module-level `_devtoolsActive` flag is a
55
+ **Devtools isolation in tests:** The module-level `devtoolsActive` flag is a
56
56
  singleton that persists for the lifetime of the module. In test environments,
57
57
  any call to `markDevtoolsActive()` MUST be paired with a `release()` call
58
- inside a `try/finally` block. Failing to do so leaves `_devtoolsActive = true`
58
+ inside a `try/finally` block. Failing to do so leaves `devtoolsActive = true`
59
59
  for all subsequent tests, causing false positives in devtools-conditional
60
60
  rendering paths (e.g. `data-jr-key` wrapper spans).
61
61
 
package/api/@xmachines/play-dom/interfaces/ComponentContext.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ComponentContext\<C, K\>
4
4
 
5
- Defined in: [packages/play-dom/src/json-render/types.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/json-render/types.ts#L184)
5
+ Defined in: [packages/play-dom/src/json-render/types.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L184)
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -15,9 +15,9 @@ Defined in: [packages/play-dom/src/json-render/types.ts:184](https://gitlab.com/
15
15
 
16
16
  | Property | Type | Description | Defined in |
17
17
  | ----------------------------------------- | --------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
18
- | <a id="property-bindings"></a> `bindings` | `Record`\<`string`, `string`\> \| `undefined` | Two-way binding paths resolved from `$bindState` / `$bindItem` prop expressions. | [packages/play-dom/src/json-render/types.ts:194](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/json-render/types.ts#L194) |
19
- | <a id="property-children"></a> `children` | `Node`[] | Rendered child nodes from the spec's `children` list. | [packages/play-dom/src/json-render/types.ts:190](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/json-render/types.ts#L190) |
20
- | <a id="property-ctx"></a> `ctx` | [`DomRenderContext`](DomRenderContext.md) | Low-level render context. | [packages/play-dom/src/json-render/types.ts:206](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/json-render/types.ts#L206) |
21
- | <a id="property-emit"></a> `emit` | (`event`) => `void` | Dispatch a named event defined in the spec's `on` map. | [packages/play-dom/src/json-render/types.ts:198](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/json-render/types.ts#L198) |
22
- | <a id="property-on"></a> `on` | (`event`) => [`EventHandle`](EventHandle.md) | Get an `EventHandle` for a named event from the spec's `on` map. | [packages/play-dom/src/json-render/types.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/json-render/types.ts#L202) |
23
- | <a id="property-props"></a> `props` | `InferComponentProps`\<`C`, `K`\> | Catalog-typed, store-resolved props for this component. | [packages/play-dom/src/json-render/types.ts:186](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/json-render/types.ts#L186) |
18
+ | <a id="property-bindings"></a> `bindings` | `Record`\<`string`, `string`\> \| `undefined` | Two-way binding paths resolved from `$bindState` / `$bindItem` prop expressions. | [packages/play-dom/src/json-render/types.ts:194](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L194) |
19
+ | <a id="property-children"></a> `children` | `Node`[] | Rendered child nodes from the spec's `children` list. | [packages/play-dom/src/json-render/types.ts:190](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L190) |
20
+ | <a id="property-ctx"></a> `ctx` | [`DomRenderContext`](DomRenderContext.md) | Low-level render context. | [packages/play-dom/src/json-render/types.ts:206](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L206) |
21
+ | <a id="property-emit"></a> `emit` | (`event`) => `void` | Dispatch a named event defined in the spec's `on` map. | [packages/play-dom/src/json-render/types.ts:198](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L198) |
22
+ | <a id="property-on"></a> `on` | (`event`) => [`EventHandle`](EventHandle.md) | Get an `EventHandle` for a named event from the spec's `on` map. | [packages/play-dom/src/json-render/types.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L202) |
23
+ | <a id="property-props"></a> `props` | `InferComponentProps`\<`C`, `K`\> | Catalog-typed, store-resolved props for this component. | [packages/play-dom/src/json-render/types.ts:186](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L186) |
package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ConnectRendererOptions
4
4
 
5
- Defined in: [packages/play-dom/src/types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/types.ts#L61)
5
+ Defined in: [packages/play-dom/src/types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L61)
6
6
 
7
7
  Options for connectRenderer() — backward compat API.
8
8
 
@@ -14,15 +14,15 @@ Options for connectRenderer() — backward compat API.
14
14
 
15
15
  | Property | Type | Description | Inherited from | Defined in |
16
16
  | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <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) | - | [packages/play-dom/src/types.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/types.ts#L63) |
18
- | <a id="property-container"></a> `container` | `HTMLElement` | Container element to render into | - | [packages/play-dom/src/types.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/types.ts#L87) |
19
- | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional element shown when `currentView` is `null` on **initial mount** only. The fallback is appended immediately after `renderer.connect()` if the container is empty at that moment (i.e. the actor's initial view is `null`). **Limitation:** If the actor's view transitions to `null` after mount, the container will be cleared but this fallback will NOT be re-appended. For dynamic fallback behavior (null view after non-null), use `PlayRenderer` directly and wrap the `actor.currentView` signal to inject fallback content. | - | [packages/play-dom/src/types.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/types.ts#L100) |
20
- | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Custom computed functions available to `$computed` field expressions in specs. Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | [`UIProviderOptions`](UIProviderOptions.md).[`functions`](UIProviderOptions.md#property-functions) | [packages/play-dom/src/json-render/types.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/json-render/types.ts#L83) |
21
- | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Pre-resolved handler map — for backward compatibility. Ignored when `registryResult` is provided. | - | [packages/play-dom/src/types.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/types.ts#L112) |
22
- | <a id="property-loading"></a> `loading?` | `boolean` | When true, indicates the spec is still streaming (e.g. from an AI provider). Forwarded to PlayRenderer which threads it into renderSpec so components can read ctx.ctx.loading to show skeleton states. Also suppresses missing-child warnings. Mirrors the `loading` prop from framework renderer providers. | - | [packages/play-dom/src/types.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/types.ts#L127) |
23
- | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function forwarded to json-render computed functions that need to trigger programmatic navigation (e.g. a `navigate` action in the catalog). | [`UIProviderOptions`](UIProviderOptions.md).[`navigate`](UIProviderOptions.md#property-navigate) | [packages/play-dom/src/json-render/types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/json-render/types.ts#L77) |
24
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Forwarded as `onRenderError` to the underlying renderer. | [`UIProviderOptions`](UIProviderOptions.md).[`onRenderError`](UIProviderOptions.md#property-onrendererror) | [packages/play-dom/src/json-render/types.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/json-render/types.ts#L89) |
25
- | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | Registry of component renderers — replaces old `components` map. When also providing `registryResult`, this **must** be the `.registry` field from the **same** `defineRegistry()` call to keep component renderers and action handlers aligned. Mixing a `registry` from one catalog with a `registryResult` from another will cause component wrappers and action handlers to be mismatched, producing silent runtime failures. **Example** `const registryResult = defineRegistry(catalog, { components, actions }); connectRenderer({ registry: registryResult.registry, // ← from the same call registryResult, // ... });` | - | [packages/play-dom/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/types.ts#L84) |
26
- | <a id="property-registryresult"></a> `registryResult?` | [`DefineRegistryResult`](DefineRegistryResult.md) | The result from `defineRegistry` — wires setState/getState from the xstate store into action handlers automatically. Preferred over `handlers` for new code. | - | [packages/play-dom/src/types.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/types.ts#L106) |
27
- | <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. | - | [packages/play-dom/src/types.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/types.ts#L119) |
28
- | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions for the json-render ValidationProvider equivalent. Each function receives `(value, args?)` and returns a boolean. | [`UIProviderOptions`](UIProviderOptions.md).[`validationFunctions`](UIProviderOptions.md#property-validationfunctions) | [packages/play-dom/src/json-render/types.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-dom/src/json-render/types.ts#L68) |
17
+ | <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) | - | [packages/play-dom/src/types.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L63) |
18
+ | <a id="property-container"></a> `container` | `HTMLElement` | Container element to render into | - | [packages/play-dom/src/types.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L87) |
19
+ | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional element shown when `currentView` is `null` on **initial mount** only. The fallback is appended immediately after `renderer.connect()` if the container is empty at that moment (i.e. the actor's initial view is `null`). **Limitation:** If the actor's view transitions to `null` after mount, the container will be cleared but this fallback will NOT be re-appended. For dynamic fallback behavior (null view after non-null), use `PlayRenderer` directly and wrap the `actor.currentView` signal to inject fallback content. | - | [packages/play-dom/src/types.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L100) |
20
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Custom computed functions available to `$computed` field expressions in specs. Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | [`UIProviderOptions`](UIProviderOptions.md).[`functions`](UIProviderOptions.md#property-functions) | [packages/play-dom/src/json-render/types.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L83) |
21
+ | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Pre-resolved handler map — for backward compatibility. Ignored when `registryResult` is provided. | - | [packages/play-dom/src/types.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L112) |
22
+ | <a id="property-loading"></a> `loading?` | `boolean` | When true, indicates the spec is still streaming (e.g. from an AI provider). Forwarded to PlayRenderer which threads it into renderSpec so components can read ctx.ctx.loading to show skeleton states. Also suppresses missing-child warnings. Mirrors the `loading` prop from framework renderer providers. | - | [packages/play-dom/src/types.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L127) |
23
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function forwarded to json-render computed functions that need to trigger programmatic navigation (e.g. a `navigate` action in the catalog). | [`UIProviderOptions`](UIProviderOptions.md).[`navigate`](UIProviderOptions.md#property-navigate) | [packages/play-dom/src/json-render/types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L77) |
24
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Forwarded as `onRenderError` to the underlying renderer. | [`UIProviderOptions`](UIProviderOptions.md).[`onRenderError`](UIProviderOptions.md#property-onrendererror) | [packages/play-dom/src/json-render/types.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L89) |
25
+ | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | Registry of component renderers — replaces old `components` map. When also providing `registryResult`, this **must** be the `.registry` field from the **same** `defineRegistry()` call to keep component renderers and action handlers aligned. Mixing a `registry` from one catalog with a `registryResult` from another will cause component wrappers and action handlers to be mismatched, producing silent runtime failures. **Example** `const registryResult = defineRegistry(catalog, { components, actions }); connectRenderer({ registry: registryResult.registry, // ← from the same call registryResult, // ... });` | - | [packages/play-dom/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L84) |
26
+ | <a id="property-registryresult"></a> `registryResult?` | [`DefineRegistryResult`](DefineRegistryResult.md) | The result from `defineRegistry` — wires setState/getState from the xstate store into action handlers automatically. Preferred over `handlers` for new code. | - | [packages/play-dom/src/types.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L106) |
27
+ | <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. | - | [packages/play-dom/src/types.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/types.ts#L119) |
28
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions for the json-render ValidationProvider equivalent. Each function receives `(value, args?)` and returns a boolean. | [`UIProviderOptions`](UIProviderOptions.md).[`validationFunctions`](UIProviderOptions.md#property-validationfunctions) | [packages/play-dom/src/json-render/types.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-dom/src/json-render/types.ts#L68) |