@xmachines/docs 1.0.0 → 1.1.0

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 (357) hide show
  1. package/README.md +1 -3
  2. package/api/@xmachines/play/README.md +1 -3
  3. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  4. package/api/@xmachines/play/classes/PlayError.md +4 -4
  5. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  6. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  7. package/api/@xmachines/play-actor/README.md +22 -10
  8. package/api/@xmachines/play-actor/classes/AbstractActor.md +19 -3
  9. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  10. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  11. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  12. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  13. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  14. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  15. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  16. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  17. package/api/@xmachines/play-dom/README.md +3 -2
  18. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  19. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  20. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  21. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +2 -2
  22. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  23. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +4 -4
  24. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  25. package/api/@xmachines/play-dom-router/README.md +3 -2
  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 +6 -6
  34. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  35. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  36. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  37. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  38. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  39. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  40. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  41. package/api/@xmachines/play-react/README.md +3 -2
  42. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  43. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  44. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  45. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  46. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  47. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  48. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  49. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  50. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  51. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  52. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  53. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  54. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  55. package/api/@xmachines/play-react-router/README.md +1 -2
  56. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
  57. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  58. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  59. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  60. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  61. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  62. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  63. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  64. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  65. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  66. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  67. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  68. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  69. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  70. package/api/@xmachines/play-router/README.md +3 -2
  71. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  72. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
  73. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  74. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  75. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  76. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  77. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  78. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  79. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  80. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  81. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  82. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  83. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  84. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  85. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  86. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  87. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  88. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  89. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  90. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  91. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  92. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  93. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  94. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  95. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  96. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  97. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  98. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +3 -3
  99. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  100. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  101. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  102. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  103. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  104. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  105. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  106. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  107. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  108. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  109. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  110. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  111. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  112. package/api/@xmachines/play-signals/README.md +3 -2
  113. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  114. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  115. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  116. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  117. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  118. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  119. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  120. package/api/@xmachines/play-solid/README.md +3 -2
  121. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  122. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  123. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  124. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  125. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  126. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  127. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  128. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  129. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  130. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  131. package/api/@xmachines/play-solid-router/README.md +3 -2
  132. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  133. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
  134. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  135. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  136. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +19 -3
  137. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  138. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  139. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  140. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  141. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  142. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  143. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  144. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  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-solid-router/variables/PlayRouterProvider.md +1 -1
  148. package/api/@xmachines/play-svelte/README.md +3 -2
  149. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  150. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  151. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  152. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  153. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  154. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  155. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  156. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  157. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  158. package/api/@xmachines/play-svelte-spa-router/README.md +1 -3
  159. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  160. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  161. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  162. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  163. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  164. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  165. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  166. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  167. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  168. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  169. package/api/@xmachines/play-sveltekit-router/README.md +3 -2
  170. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  171. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  172. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  173. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  174. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  175. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  176. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  177. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  178. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  179. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  180. package/api/@xmachines/play-tanstack-react-router/README.md +3 -2
  181. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  182. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
  183. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  184. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  185. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  186. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  187. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  188. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  189. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  190. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  191. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  192. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  193. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  194. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  195. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  196. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  197. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  198. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  199. package/api/@xmachines/play-tanstack-router/README.md +3 -0
  200. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
  201. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  202. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
  203. package/api/@xmachines/play-tanstack-solid-router/README.md +3 -2
  204. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  205. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
  206. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  207. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  208. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  209. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  210. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  211. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  212. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  213. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  214. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  215. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  216. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  217. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  218. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  219. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  220. package/api/@xmachines/play-vue/README.md +2 -4
  221. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  222. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  223. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  224. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  225. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  226. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  227. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  228. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  229. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  230. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  231. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  232. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  233. package/api/@xmachines/play-vue-router/README.md +3 -2
  234. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  235. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
  236. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  237. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  238. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  239. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  240. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  241. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  242. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  243. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  244. package/api/@xmachines/play-xstate/README.md +41 -23
  245. package/api/@xmachines/play-xstate/classes/PlayerActor.md +77 -53
  246. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +5 -12
  247. package/api/@xmachines/play-xstate/functions/composeGuards.md +7 -2
  248. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +7 -2
  249. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +7 -2
  250. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  251. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  252. package/api/@xmachines/play-xstate/functions/eventMatches.md +7 -2
  253. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  254. package/api/@xmachines/play-xstate/functions/hasContext.md +7 -4
  255. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  256. package/api/@xmachines/play-xstate/functions/negateGuard.md +7 -2
  257. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  258. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +4 -4
  259. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +10 -11
  260. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  261. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  262. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +7 -2
  263. package/api/@xmachines/play-xstate/type-aliases/Guard.md +7 -5
  264. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +7 -5
  265. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +11 -15
  266. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  267. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  268. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  269. package/api/@xmachines/shared/README.md +2 -2
  270. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  271. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  272. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +12 -7
  273. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  274. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  275. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  276. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  277. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  278. package/contributing/architecture.md +18 -16
  279. package/contributing/configuration.md +10 -10
  280. package/contributing/deployment.md +49 -28
  281. package/contributing/development.md +56 -17
  282. package/contributing/testing.md +12 -4
  283. package/examples/@xmachines/play-dom-demo/README.md +2 -2
  284. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  285. package/examples/@xmachines/play-dom-demo/functions/initShell.md +7 -6
  286. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  287. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  288. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  289. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  290. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  291. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  292. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  293. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  294. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  295. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  296. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  297. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  298. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  299. package/examples/@xmachines/play-dom-router-demo/README.md +2 -2
  300. package/examples/@xmachines/play-react-demo/README.md +2 -2
  301. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  302. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  303. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  304. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  305. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  306. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +3 -2
  307. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  308. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  309. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  310. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  311. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  312. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  313. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  314. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  315. package/examples/@xmachines/play-react-demo/variables/Shell.md +2 -1
  316. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  317. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  318. package/examples/@xmachines/play-react-router-demo/README.md +2 -2
  319. package/examples/@xmachines/play-solid-demo/README.md +2 -2
  320. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  321. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  322. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  323. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  324. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  325. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +4 -2
  326. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  327. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  328. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  329. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  330. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  331. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  332. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  333. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  334. package/examples/@xmachines/play-solid-demo/variables/Shell.md +2 -1
  335. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  336. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  337. package/examples/@xmachines/play-solid-router-demo/README.md +2 -2
  338. package/examples/@xmachines/play-svelte-demo/README.md +2 -2
  339. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  340. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  341. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +2 -2
  342. package/examples/@xmachines/play-sveltekit-router-demo/README.md +2 -2
  343. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +2 -2
  344. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +2 -2
  345. package/examples/@xmachines/play-vue-demo/README.md +2 -2
  346. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  347. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  348. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  349. package/examples/@xmachines/play-vue-router-demo/README.md +2 -2
  350. package/examples/basic-state-machine.md +0 -2
  351. package/examples/form-validation.md +0 -2
  352. package/examples/multi-router-integration.md +0 -2
  353. package/examples/routing-patterns.md +0 -2
  354. package/examples/traffic-light.md +0 -2
  355. package/guides/README.md +0 -2
  356. package/guides/getting-started.md +19 -11
  357. package/package.json +9 -6
package/README.md CHANGED
@@ -1,5 +1,3 @@
1
- <!-- generated-by: gsd-doc-writer -->
2
-
3
1
  # @xmachines/docs
4
2
 
5
3
  > Documentation, guides, RFCs, and generated API reference for XMachines.
@@ -7,7 +5,7 @@
7
5
  Part of the `XMachines Play monorepo`.
8
6
 
9
7
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
10
- [![Version](https://img.shields.io/badge/version-1.0.0--beta.51-blue)](https://www.npmjs.com/package/@xmachines/docs)
8
+ [![Version](https://img.shields.io/badge/version-1.1.0-blue)](https://www.npmjs.com/package/@xmachines/docs)
11
9
 
12
10
  ## Overview
13
11
 
@@ -1,13 +1,11 @@
1
1
  [API](../../README.md) / @xmachines/play
2
2
 
3
- <!-- generated-by: gsd-doc-writer -->
4
-
5
3
  # `@xmachines/play`
6
4
 
7
5
  > Core protocol layer for the Universal Player Architecture — defines `PlayEvent`, `PlayError`, and architectural contracts enabling loose coupling between business logic and runtime adapters.
8
6
 
9
7
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
10
- [![npm](https://img.shields.io/npm/v/@xmachines/play)](https://www.npmjs.com/package/@xmachines/play)
8
+ [![Version](https://img.shields.io/badge/version-1.1.0-blue)](https://www.npmjs.com/package/@xmachines/play)
11
9
 
12
10
  Part of the [XMachines JS monorepo](../../README.md).
13
11
 
@@ -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/packages/play/src/errors.ts#L111)
5
+ Defined in: [packages/play/src/errors.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/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/packages/play/src/errors.ts#L112)
38
+ Defined in: [packages/play/src/errors.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/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/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.1.0/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/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.1.0/packages/play/src/errors.ts#L66) |
64
64
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](PlayError.md).[`stack`](PlayError.md#property-stack) | - |
65
65
  | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](PlayError.md).[`stackTraceLimit`](PlayError.md#property-stacktracelimit) | - |
66
66
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayError
4
4
 
5
- Defined in: [packages/play/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play/src/errors.ts#L64)
5
+ Defined in: [packages/play/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/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/packages/play/src/errors.ts#L83)
90
+ Defined in: [packages/play/src/errors.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/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/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.1.0/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/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.1.0/packages/play/src/errors.ts#L66) |
120
120
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | `Error.stack` | - |
121
121
  | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | - |
122
122
 
@@ -6,7 +6,7 @@
6
6
  function assertNonNullable<V>(value, name?): NonNullable<V>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play/src/utils.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play/src/utils.ts#L39)
9
+ Defined in: [packages/play/src/utils.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play/src/utils.ts#L39)
10
10
 
11
11
  Assert that `value` is neither `null` nor `undefined`, and return it typed
12
12
  as `NonNullable<V>` — combining the guard and the narrowed value in a single
@@ -6,7 +6,7 @@
6
6
  type PlayEvent<TPayload> = object & TPayload;
7
7
  ```
8
8
 
9
- Defined in: [packages/play/src/types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play/src/types.ts#L69)
9
+ Defined in: [packages/play/src/types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/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/packages/play/src/types.ts#L70) |
37
+ | `type` | `string` | [packages/play/src/types.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play/src/types.ts#L70) |
38
38
 
39
39
  ## Type Parameters
40
40
 
@@ -1,11 +1,12 @@
1
1
  [API](../../README.md) / @xmachines/play-actor
2
2
 
3
- <!-- generated-by: gsd-doc-writer -->
4
-
5
3
  # @xmachines/play-actor
6
4
 
7
5
  Abstract Actor base class for XMachines Play Architecture.
8
6
 
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8
+ [![Version](https://img.shields.io/badge/version-1.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-actor)
9
+
9
10
  Part of the [xmachines-js monorepo](../../README.md).
10
11
 
11
12
  ## Installation
@@ -47,19 +48,30 @@ Concrete implementations are created by adapters such as [`@xmachines/play-xstat
47
48
 
48
49
  Abstract base class extending XState `Actor<TLogic>`.
49
50
 
51
+ A subclass **is** the actor: hand the logic and its options to `super()` so one
52
+ instance holds the running machine, and reach XState's own `send` through the
53
+ prototype — `send` is declared abstract here only to narrow the event type, and
54
+ TypeScript forbids `super` calls to an abstract member.
55
+
50
56
  ```ts
51
57
  import { AbstractActor } from "@xmachines/play-actor";
52
58
  import { Signal } from "@xmachines/play-signals";
53
- import type { AnyActorLogic } from "xstate";
59
+ import { Actor, type ActorOptions, type AnyActorLogic } from "xstate";
54
60
 
55
61
  class MyActor extends AbstractActor<AnyActorLogic> {
56
62
  // Required: reactive state signal
57
- state = new Signal.State({});
63
+ state: Signal.State<unknown>;
64
+
65
+ constructor(logic: AnyActorLogic, options?: ActorOptions<AnyActorLogic>) {
66
+ super(logic, options);
67
+ this.state = new Signal.State(this.getSnapshot());
68
+ super.subscribe((snapshot) => this.state.set(snapshot));
69
+ }
58
70
 
59
71
  // Required: typed event dispatch
60
- send = (event: { type: string }) => {
61
- /* dispatch to XState */
62
- };
72
+ override send(event: { type: string }): void {
73
+ Actor.prototype.send.call(this, event);
74
+ }
63
75
  }
64
76
  ```
65
77
 
@@ -71,9 +83,9 @@ type AuthEvent = { type: "auth.login"; username: string } | { type: "auth.logout
71
83
  class AuthActor extends AbstractActor<AnyActorLogic, AuthEvent> {
72
84
  state = new Signal.State({ isAuthenticated: false, username: null });
73
85
 
74
- send = (event: AuthEvent) => {
75
- /* dispatch */
76
- };
86
+ override send(event: AuthEvent): void {
87
+ Actor.prototype.send.call(this, event);
88
+ }
77
89
  }
78
90
  ```
79
91
 
@@ -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:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L185)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:193](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L193)
6
6
 
7
7
  Abstract base class for Play Architecture actors.
8
8
 
@@ -10,6 +10,14 @@ Provides signal-driven state observation that integrates with XState ecosystem
10
10
  tooling (devtools, inspection) while exposing reactive signals for
11
11
  Infrastructure layer communication.
12
12
 
13
+ **A subclass IS the actor.** Forward the logic _and_ its options to
14
+ `super(logic, options)`, then observe `this`. Holding a separately
15
+ constructed actor alongside leaves this instance running as an empty second
16
+ actor, and every inherited member — `system`, `sessionId`, `clock`, the
17
+ internal `_send` that receives `sendTo()` traffic, and anything a future
18
+ XState version adds — answers from that empty one until it is individually
19
+ forwarded.
20
+
13
21
  ## Extends
14
22
 
15
23
  - [`Actor`](https://www.jsdocs.io/package/xstate#Actor)\<`TLogic`\>
@@ -67,7 +75,7 @@ Actor<TLogic>.constructor
67
75
  | <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
76
  | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
69
77
  | <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:195](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L195) |
78
+ | <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:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L203) |
71
79
  | <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
80
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | - |
73
81
 
@@ -238,12 +246,20 @@ Actor.select;
238
246
  abstract send(event): void;
239
247
  ```
240
248
 
241
- Defined in: [packages/play-actor/src/abstract-actor.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L202)
249
+ Defined in: [packages/play-actor/src/abstract-actor.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L218)
242
250
 
243
251
  Send event to Actor.
244
252
 
245
253
  Constrained to TEvent for type safety in concrete implementations.
246
254
 
255
+ Note for implementations that wrap `send` (validating the event, or
256
+ notifying hooks around it): this declaration is abstract purely to narrow
257
+ the event type, and TypeScript forbids `super` calls to an abstract
258
+ member. Reach XState's own implementation with
259
+ `Actor.prototype.send.call(this, event)` instead. Making this concrete
260
+ would allow `super.send()` but would force every existing subclass to add
261
+ an `override` modifier — a breaking change for adapters outside this repo.
262
+
247
263
  #### Parameters
248
264
 
249
265
  | Parameter | Type |
@@ -6,7 +6,7 @@
6
6
  function attachRenderErrorHandler<TRegistry>(registry, handler): TRegistry;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/provider-guards.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/provider-guards.ts#L64)
9
+ Defined in: [packages/play-actor/src/provider-guards.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/provider-guards.ts#L64)
10
10
 
11
11
  Clone a component registry and inject an `onRenderError` handler.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function toAtomState(state): Record<string, unknown>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/provider-guards.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/provider-guards.ts#L36)
9
+ Defined in: [packages/play-actor/src/provider-guards.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/provider-guards.ts#L36)
10
10
 
11
11
  Safely coerce a spec's `state` field to a plain object for `createAtom`.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function typedSpec<TContext>(spec): PlaySpec;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/abstract-actor.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L88)
9
+ Defined in: [packages/play-actor/src/abstract-actor.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L88)
10
10
 
11
11
  Identity helper that constrains a `PlaySpec` object's `contextProps` to keys
12
12
  of a specific machine context type, giving compile-time validation and IDE
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BaseActorProviderProps\<TRegistry\>
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:155](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L155)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:155](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L155)
6
6
 
7
7
  Framework-agnostic base props shared by every `ActorProvider` implementation
8
8
  (React, Vue, Solid, Svelte). `TRegistry` captures the framework-specific
@@ -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:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L159) |
44
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../../play-dom/type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L172) |
45
- | <a id="property-registryresult"></a> `registryResult` | `TRegistry` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [packages/play-actor/src/abstract-actor.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L161) |
46
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L167) |
43
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L159) |
44
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../../play-dom/type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L172) |
45
+ | <a id="property-registryresult"></a> `registryResult` | `TRegistry` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [packages/play-actor/src/abstract-actor.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L161) |
46
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L167) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BaseViewContextValue\<TRegistry\>
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L123)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L123)
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:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L127) |
31
- | <a id="property-registry"></a> `registry` | `TRegistry` | Component registry from registryResult.registry. | [packages/play-actor/src/abstract-actor.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L129) |
32
- | <a id="property-spec"></a> `spec` | [`PlaySpec`](PlaySpec.md) | The current PlaySpec to render. | [packages/play-actor/src/abstract-actor.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L125) |
33
- | <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [packages/play-actor/src/abstract-actor.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L131) |
30
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L127) |
31
+ | <a id="property-registry"></a> `registry` | `TRegistry` | Component registry from registryResult.registry. | [packages/play-actor/src/abstract-actor.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L129) |
32
+ | <a id="property-spec"></a> `spec` | [`PlaySpec`](PlaySpec.md) | The current PlaySpec to render. | [packages/play-actor/src/abstract-actor.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L125) |
33
+ | <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [packages/play-actor/src/abstract-actor.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L131) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlaySpec
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L48)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L48)
6
6
 
7
7
  XMachines extension of `@xmachines/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:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L56) |
25
+ | <a id="property-contextprops"></a> `contextProps?` | `readonly` | readonly `string`[] | Explicit allowlist of machine context field names to expose as prop slots. Each named field is merged into every spec element's `props` at view derivation time, filling any slot whose current value is `undefined`. Use `typedSpec<TContext>(...)` to constrain entries to `keyof TContext & string`. | - | [packages/play-actor/src/abstract-actor.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L56) |
26
26
  | <a id="property-elements"></a> `elements` | `public` | `Record`\<`string`, `UIElement`\> | Flat map of elements by key | `Spec.elements` | - |
27
27
  | <a id="property-root"></a> `root` | `public` | `string` | Root element key | `Spec.root` | - |
28
28
  | <a id="property-state"></a> `state?` | `public` | `Record`\<`string`, `unknown`\> | Optional initial state to seed the state model. Components using statePath will read from / write to this state. | `Spec.state` | - |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: Routable
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L32)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L32)
6
6
 
7
7
  Optional capability: Routing support
8
8
 
@@ -10,5 +10,5 @@ Optional capability: Routing support
10
10
 
11
11
  | Property | Modifier | Type | Defined in |
12
12
  | ------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | [packages/play-actor/src/abstract-actor.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L33) |
14
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | [packages/play-actor/src/abstract-actor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L34) |
13
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | [packages/play-actor/src/abstract-actor.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L33) |
14
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | [packages/play-actor/src/abstract-actor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L34) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: Viewable
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L104)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L104)
6
6
 
7
7
  Actor capability for exposing renderable view state.
8
8
 
@@ -15,4 +15,4 @@ framework adapter.
15
15
 
16
16
  | Property | Modifier | Type | Description | Defined in |
17
17
  | ----------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
18
- | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](PlaySpec.md) \| `null`\> | Current view signal. Contains the json-render PlaySpec for the current machine state, or null when no view is active. Infrastructure renders view — Logic-Driven UI invariant. | [packages/play-actor/src/abstract-actor.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L111) |
18
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](PlaySpec.md) \| `null`\> | Current view signal. Contains the json-render PlaySpec for the current machine state, or null when no view is active. Infrastructure renders view — Logic-Driven UI invariant. | [packages/play-actor/src/abstract-actor.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L111) |
@@ -1,11 +1,12 @@
1
1
  [API](../../README.md) / @xmachines/play-dom
2
2
 
3
- <!-- generated-by: gsd-doc-writer -->
4
-
5
3
  # @xmachines/play-dom
6
4
 
7
5
  Vanilla DOM renderer for XMachines Play architecture with signal-driven rendering.
8
6
 
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8
+ [![Version](https://img.shields.io/badge/version-1.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-dom)
9
+
9
10
  Part of the [XMachines Play monorepo](../../README.md).
10
11
 
11
12
  ## Installation
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayRenderer
4
4
 
5
- Defined in: [packages/play-dom/src/PlayRenderer.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-dom/src/PlayRenderer.ts#L67)
5
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-dom/src/PlayRenderer.ts#L67)
6
6
 
7
7
  PlayRenderer connects an actor's `currentView` signal to the DOM renderer.
8
8
 
@@ -61,7 +61,7 @@ new PlayRenderer(
61
61
  options?): PlayRenderer;
62
62
  ```
63
63
 
64
- Defined in: [packages/play-dom/src/PlayRenderer.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-dom/src/PlayRenderer.ts#L102)
64
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-dom/src/PlayRenderer.ts#L102)
65
65
 
66
66
  #### Parameters
67
67
 
@@ -84,7 +84,7 @@ Defined in: [packages/play-dom/src/PlayRenderer.ts:102](https://gitlab.com/xmach
84
84
  connect(): void;
85
85
  ```
86
86
 
87
- Defined in: [packages/play-dom/src/PlayRenderer.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-dom/src/PlayRenderer.ts#L118)
87
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-dom/src/PlayRenderer.ts#L118)
88
88
 
89
89
  Start watching actor.currentView and render to container.
90
90
  Renders the initial view synchronously, then subscribes to signal changes.
@@ -106,7 +106,7 @@ change. Guard against this by auto-disconnecting first.
106
106
  disconnect(): void;
107
107
  ```
108
108
 
109
- Defined in: [packages/play-dom/src/PlayRenderer.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-dom/src/PlayRenderer.ts#L127)
109
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-dom/src/PlayRenderer.ts#L127)
110
110
 
111
111
  Stop watching and clear the container.
112
112
 
@@ -6,7 +6,7 @@
6
6
  function createPlayUI(registryResult, options?): MountFn;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/create-play-ui.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-dom/src/create-play-ui.ts#L93)
9
+ Defined in: [packages/play-dom/src/create-play-ui.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-dom/src/create-play-ui.ts#L93)
10
10
 
11
11
  Create a batteries-included DOM renderer mount function.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRenderer<C>(catalog, componentMap): (actor, container, options?) => () => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/create-renderer.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-dom/src/create-renderer.ts#L84)
9
+ Defined in: [packages/play-dom/src/create-renderer.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-dom/src/create-renderer.ts#L84)
10
10
 
11
11
  Create a reusable DOM renderer factory from a catalog and component map.
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: CreatePlayUIOptions
4
4
 
5
- Defined in: [packages/play-dom/src/types.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-dom/src/types.ts#L67)
5
+ Defined in: [packages/play-dom/src/types.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-dom/src/types.ts#L67)
6
6
 
7
7
  Options for `createPlayUI()` — the batteries-included DOM factory.
8
8
 
@@ -26,7 +26,7 @@ createPlayUI
26
26
  | Property | Type | Description | Inherited from | Defined in |
27
27
  | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
28
28
  | <a id="property-directives"></a> `directives?` | `DirectiveDefinition`\<`ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>\>[] | Custom directives — user-defined `$`-prefixed dynamic values that extend the spec expression language (e.g. `{ $format: "currency", value: ... }`). Each entry is a `DirectiveDefinition` built with `defineDirective` from `@xmachines/json-render-core`. The array is converted to a `DirectiveRegistry` once per render pass and forwarded to `resolveElementProps` via `PropResolutionContext.directives`. Built-in expressions (`$state`, `$cond`, etc.) always take precedence over custom directives. Mirrors the `directives` prop on `JSONUIProvider` / `JsonUIProvider` introduced in **Json-render** 0.19. **Example** `import { defineDirective, resolvePropValue } from "@xmachines/json-render-core"; import { z } from "zod"; const formatDirective = defineDirective({ name: "$format", description: "Locale-aware number formatting.", schema: z.object({ $format: z.enum(["number", "currency"]), value: z.unknown() }), resolve(value, ctx) { const resolved = resolvePropValue(value.value, ctx); return new Intl.NumberFormat().format(resolved as number); }, }); renderSpec(spec, store, registry, { directives: [formatDirective] });` | [`UIProviderOptions`](UIProviderOptions.md).[`directives`](UIProviderOptions.md#property-directives) | - |
29
- | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional fallback element shown when `currentView` is `null` on **initial mount** only. The fallback is appended immediately after `mount()` 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:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-dom/src/types.ts#L79) |
29
+ | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional fallback element shown when `currentView` is `null` on **initial mount** only. The fallback is appended immediately after `mount()` 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:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-dom/src/types.ts#L79) |
30
30
  | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Named compute functions for `{ $computed: "name", args: {...} }` prop expressions. Each function receives the resolved `args` object and returns the computed value. Forwarded directly to `resolveElementProps` via `PropResolutionContext.functions`, matching the `FunctionsContext` provider in the framework renderers. Without this option, `$computed` expressions resolve to `undefined` (no throw). **Example** `renderSpec(spec, store, registry, { functions: { fullName: (args) => `${args.first} ${args.last}`, formatCurrency: (args) => new Intl.NumberFormat().format(args.amount as number), }, });` Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | [`UIProviderOptions`](UIProviderOptions.md).[`functions`](UIProviderOptions.md#property-functions) | - |
31
31
  | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Programmatic navigation function. Called automatically when an action binding resolves with `onSuccess: { navigate: "/path" }`. The resolved path string is passed as the sole argument. Mirrors the `navigate` prop in `ActionProvider` from the framework renderers, where it is captured in the `execute()` closure. Also available to component implementations directly via `ctx.ctx.navigate` for cases where navigation needs to be triggered outside of an action binding. **Example** `import { useNavigate } from "my-router"; const navigate = useNavigate(); renderSpec(spec, store, registry, { navigate });` Spec binding that triggers navigation: `{ "on": { "click": { "action": "doSomething", "onSuccess": { "navigate": "/dashboard" } } } }` | [`UIProviderOptions`](UIProviderOptions.md).[`navigate`](UIProviderOptions.md#property-navigate) | - |
32
32
  | <a id="property-onconfirm"></a> `onConfirm?` | [`ConfirmHandler`](../type-aliases/ConfirmHandler.md) | Confirmation hook for actions that declare `confirm` in their binding. Consulted by `emit()` before executing a confirm-gated action. Return (or resolve) `true` to execute, `false` to skip. Without this handler, confirm-gated actions are skipped with a `console.warn` — they never execute unconfirmed. See [ConfirmHandler](../type-aliases/ConfirmHandler.md) for the full contract. This is the headless equivalent of the `pendingConfirmation` / `confirmAction()` / `cancelAction()` flow in the framework adapters. | [`UIProviderOptions`](UIProviderOptions.md).[`onConfirm`](UIProviderOptions.md#property-onconfirm) | - |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: MountOptions
4
4
 
5
- Defined in: [packages/play-dom/src/create-play-ui.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-dom/src/create-play-ui.ts#L48)
5
+ Defined in: [packages/play-dom/src/create-play-ui.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-dom/src/create-play-ui.ts#L48)
6
6
 
7
7
  Per-mount options passed to the `MountFn` returned by `createPlayUI`.
8
8
 
@@ -14,5 +14,5 @@ basis. Factory-level options (`functions`, `validationFunctions`, `navigate`,
14
14
 
15
15
  | Property | Type | Description | Defined in |
16
16
  | ---------------------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-loading"></a> `loading?` | `boolean` | When `true`, suppresses missing-child warnings during streaming spec ingestion and exposes `ctx.ctx.loading` to component implementations. | [packages/play-dom/src/create-play-ui.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-dom/src/create-play-ui.ts#L59) |
18
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external `StateStore` (controlled mode). When omitted, a fresh `@xstate/store` atom is created per view transition seeded from `spec.state`. | [packages/play-dom/src/create-play-ui.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-dom/src/create-play-ui.ts#L54) |
17
+ | <a id="property-loading"></a> `loading?` | `boolean` | When `true`, suppresses missing-child warnings during streaming spec ingestion and exposes `ctx.ctx.loading` to component implementations. | [packages/play-dom/src/create-play-ui.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-dom/src/create-play-ui.ts#L59) |
18
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external `StateStore` (controlled mode). When omitted, a fresh `@xstate/store` atom is created per view transition seeded from `spec.state`. | [packages/play-dom/src/create-play-ui.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-dom/src/create-play-ui.ts#L54) |