@xmachines/docs 1.0.0 → 2.0.0-alpha.1

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 (342) hide show
  1. package/README.md +1 -1
  2. package/api/@xmachines/play/classes/NonNullableError.md +11 -11
  3. package/api/@xmachines/play/classes/PlayError.md +11 -11
  4. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +4 -4
  6. package/api/@xmachines/play-actor/classes/AbstractActor.md +20 -19
  7. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  8. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  9. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  10. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +7 -7
  11. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +7 -7
  12. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +7 -7
  13. package/api/@xmachines/play-actor/interfaces/Routable.md +5 -5
  14. package/api/@xmachines/play-actor/interfaces/Viewable.md +4 -4
  15. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  16. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  17. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  18. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +10 -10
  19. package/api/@xmachines/play-dom/interfaces/MountOptions.md +5 -5
  20. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +12 -12
  21. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  22. package/api/@xmachines/play-dom-router/README.md +1 -1
  23. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  24. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  25. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +2 -2
  26. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  27. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +16 -16
  28. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +16 -16
  29. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +6 -6
  30. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +8 -8
  31. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +6 -6
  32. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  33. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  34. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +4 -4
  35. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +5 -5
  36. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  37. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +6 -6
  38. package/api/@xmachines/play-react/README.md +1 -1
  39. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  40. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  41. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  42. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  43. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +10 -10
  44. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
  45. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +5 -5
  46. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +13 -13
  47. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +7 -7
  48. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  49. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  50. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  51. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  52. package/api/@xmachines/play-react-router/README.md +1 -1
  53. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
  54. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  55. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  56. package/api/@xmachines/play-react-router/functions/createRouteMap.md +2 -2
  57. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  58. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +7 -7
  59. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +8 -8
  60. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +7 -7
  61. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  62. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +4 -4
  63. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +5 -5
  64. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  65. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  66. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  67. package/api/@xmachines/play-router/README.md +15 -7
  68. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  69. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
  70. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  71. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  72. package/api/@xmachines/play-router/functions/createRouteMap.md +2 -2
  73. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  74. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  75. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +2 -2
  76. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  77. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  78. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  79. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  80. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  81. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  82. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  83. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  84. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  85. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  86. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  87. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  88. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  89. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +6 -6
  90. package/api/@xmachines/play-router/interfaces/LocationLike.md +5 -5
  91. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +7 -5
  92. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +7 -7
  93. package/api/@xmachines/play-router/interfaces/PlayActor.md +7 -7
  94. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +8 -8
  95. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +5 -5
  96. package/api/@xmachines/play-router/interfaces/RoutableActor.md +6 -6
  97. package/api/@xmachines/play-router/interfaces/RouteInfo.md +10 -10
  98. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +4 -4
  99. package/api/@xmachines/play-router/interfaces/RouteMapping.md +5 -5
  100. package/api/@xmachines/play-router/interfaces/RouteMatch.md +5 -5
  101. package/api/@xmachines/play-router/interfaces/RouteNode.md +12 -12
  102. package/api/@xmachines/play-router/interfaces/RouteObject.md +4 -4
  103. package/api/@xmachines/play-router/interfaces/RouteTree.md +7 -7
  104. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  105. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  106. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  107. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  108. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  109. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  110. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +4 -4
  111. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  112. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +4 -4
  113. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  114. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  115. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  116. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  117. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  118. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +10 -10
  119. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +13 -13
  120. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +7 -7
  121. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  122. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  123. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  124. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  125. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  126. package/api/@xmachines/play-solid-router/README.md +5 -5
  127. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  128. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
  129. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  130. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +2 -2
  131. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +20 -19
  132. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +7 -7
  133. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +8 -8
  134. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +7 -7
  135. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  136. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +4 -4
  137. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +5 -5
  138. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  139. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  140. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  141. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  142. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  143. package/api/@xmachines/play-svelte/README.md +1 -1
  144. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  145. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  146. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  147. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  148. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +10 -10
  149. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -6
  150. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +13 -13
  151. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +7 -7
  152. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  153. package/api/@xmachines/play-svelte-spa-router/README.md +24 -18
  154. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  155. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  156. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +2 -2
  157. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +6 -6
  158. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +8 -8
  159. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +4 -4
  160. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +5 -5
  161. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  162. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  163. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  164. package/api/@xmachines/play-sveltekit-router/README.md +5 -5
  165. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  166. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  167. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +2 -2
  168. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +6 -6
  169. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +5 -5
  170. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +8 -8
  171. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +4 -4
  172. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +5 -5
  173. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  174. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  175. package/api/@xmachines/play-tanstack-react-router/README.md +1 -1
  176. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  177. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
  178. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  179. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +2 -2
  180. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  181. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +2 -2
  182. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +7 -7
  183. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +8 -8
  184. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +7 -7
  185. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  186. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +4 -4
  187. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +5 -5
  188. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +5 -5
  189. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  190. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  191. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  192. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  193. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  194. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
  195. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  196. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
  197. package/api/@xmachines/play-tanstack-solid-router/README.md +5 -5
  198. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  199. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
  200. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  201. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +2 -2
  202. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +7 -7
  203. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +8 -8
  204. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +7 -7
  205. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  206. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +4 -4
  207. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +5 -5
  208. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  209. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  210. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  211. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  212. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  213. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  214. package/api/@xmachines/play-vue/README.md +1 -1
  215. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  216. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  217. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  218. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +7 -7
  219. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +10 -10
  220. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +7 -7
  221. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  222. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  223. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  224. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  225. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +4 -4
  226. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  227. package/api/@xmachines/play-vue-router/README.md +1 -1
  228. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  229. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
  230. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +2 -2
  231. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +7 -7
  232. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +8 -8
  233. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +4 -4
  234. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +5 -5
  235. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  236. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  237. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  238. package/api/@xmachines/play-xstate/README.md +88 -25
  239. package/api/@xmachines/play-xstate/classes/PlayerActor.md +34 -33
  240. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  241. package/api/@xmachines/play-xstate/functions/composeGuards.md +23 -17
  242. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +16 -16
  243. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  244. package/api/@xmachines/play-xstate/functions/createRoutedMachine.md +87 -0
  245. package/api/@xmachines/play-xstate/functions/definePlayer.md +3 -3
  246. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  247. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  248. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +45 -11
  249. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  250. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  251. package/api/@xmachines/play-xstate/functions/negateGuard.md +15 -15
  252. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +5 -5
  253. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +4 -4
  254. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +8 -8
  255. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +7 -7
  256. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +4 -4
  257. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +26 -5
  258. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  259. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  260. package/api/@xmachines/play-xstate/type-aliases/PlayRoutePayload.md +30 -0
  261. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  262. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +13 -6
  263. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  264. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +16 -4
  265. package/api/@xmachines/play-xstate/type-aliases/SetupLike.md +33 -0
  266. package/api/@xmachines/play-xstate/type-aliases/WithOptional.md +31 -0
  267. package/api/@xmachines/play-xstate/variables/emptyEventSchema.md +37 -0
  268. package/api/@xmachines/play-xstate/variables/playMetaSchema.md +40 -0
  269. package/api/@xmachines/play-xstate/variables/playRouteEventSchema.md +9 -0
  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 +1 -1
  273. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  274. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +4 -4
  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 +6 -6
  278. package/contributing/architecture.md +9 -6
  279. package/contributing/development.md +1 -1
  280. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  281. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  282. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  283. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  284. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  285. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  286. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  287. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  288. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  289. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  290. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  291. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  292. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  293. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  294. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  295. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  296. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  297. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  298. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  299. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  300. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  301. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  302. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  303. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  304. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  305. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  306. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  307. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  308. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  309. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  310. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  311. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  312. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  313. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  314. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  315. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  316. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  317. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  318. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  319. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  320. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  321. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  322. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  323. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  324. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  325. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  326. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  327. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  328. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  329. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  330. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  331. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  332. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  333. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  334. package/examples/README.md +1 -1
  335. package/examples/basic-state-machine.md +22 -24
  336. package/examples/form-validation.md +118 -109
  337. package/examples/routing-patterns.md +92 -60
  338. package/examples/traffic-light.md +46 -57
  339. package/guides/getting-started.md +79 -68
  340. package/guides/state-machines.md +68 -52
  341. package/package.json +2 -2
  342. package/rfc/play.md +4 -4
package/README.md CHANGED
@@ -102,7 +102,7 @@ Practical code examples demonstrating XMachines patterns:
102
102
 
103
103
  - **[Basic State Machine](examples/basic-state-machine.md)** — `setup().createMachine()` + `definePlayer()` + TC39 Signals
104
104
  - **[Traffic Light](examples/traffic-light.md)** — Multi-state machine with `meta.route` and `formatPlayRouteTransitions`
105
- - **[Form Validation](examples/form-validation.md)** — Typed context mutations with `setup.assign`, guards, and `$bindState`
105
+ - **[Form Validation](examples/form-validation.md)** — Typed context patches, guard logic in transition functions, and `$bindState`
106
106
  - **[Routing Patterns](examples/routing-patterns.md)** — `meta.route`, `play.route` events, `always` auth guards
107
107
  - **[Multi-Router Integration](examples/multi-router-integration.md)** — All 8 router adapters
108
108
 
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/packages/play/src/errors.ts#L111)
5
+ Defined in: [packages/play/src/errors.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/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/v2.0.0-alpha.1/packages/play/src/errors.ts#L112)
39
39
 
40
40
  #### Parameters
41
41
 
@@ -54,15 +54,15 @@ Defined in: [packages/play/src/errors.ts:112](https://gitlab.com/xmachin-es/xmac
54
54
 
55
55
  ## Properties
56
56
 
57
- | Property | Modifier | Type | Description | Inherited from | Defined in |
58
- | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
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) |
61
- | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](PlayError.md).[`message`](PlayError.md#property-message) | - |
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) |
64
- | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](PlayError.md).[`stack`](PlayError.md#property-stack) | - |
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) | - |
57
+ | Property | Modifier | Type | Description | Inherited from | Defined in |
58
+ | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
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/v2.0.0-alpha.1/packages/play/src/errors.ts#L75) |
61
+ | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](PlayError.md).[`message`](PlayError.md#property-message) | - |
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/v2.0.0-alpha.1/packages/play/src/errors.ts#L66) |
64
+ | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](PlayError.md).[`stack`](PlayError.md#property-stack) | - |
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
 
67
67
  ## Methods
68
68
 
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/packages/play/src/errors.ts#L64)
5
+ Defined in: [packages/play/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/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/v2.0.0-alpha.1/packages/play/src/errors.ts#L83)
91
91
 
92
92
  #### Parameters
93
93
 
@@ -110,15 +110,15 @@ Error.constructor;
110
110
 
111
111
  ## Properties
112
112
 
113
- | Property | Modifier | Type | Description | Inherited from | Defined in |
114
- | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------- |
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) |
117
- | <a id="property-message"></a> `message` | `public` | `string` | - | `Error.message` | - |
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) |
120
- | <a id="property-stack"></a> `stack?` | `public` | `string` | - | `Error.stack` | - |
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` | - |
113
+ | Property | Modifier | Type | Description | Inherited from | Defined in |
114
+ | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
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/v2.0.0-alpha.1/packages/play/src/errors.ts#L75) |
117
+ | <a id="property-message"></a> `message` | `public` | `string` | - | `Error.message` | - |
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/v2.0.0-alpha.1/packages/play/src/errors.ts#L66) |
120
+ | <a id="property-stack"></a> `stack?` | `public` | `string` | - | `Error.stack` | - |
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
 
123
123
  ## Methods
124
124
 
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/packages/play/src/utils.ts#L39)
9
+ Defined in: [packages/play/src/utils.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/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/packages/play/src/types.ts#L69)
9
+ Defined in: [packages/play/src/types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play/src/types.ts#L69)
10
10
 
11
11
  Generic event type for Play Architecture
12
12
 
@@ -32,9 +32,9 @@ Robot, and other state machine libraries.
32
32
 
33
33
  ## Type Declaration
34
34
 
35
- | Name | Type | Defined in |
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) |
35
+ | Name | Type | Defined in |
36
+ | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
37
+ | `type` | `string` | [packages/play/src/types.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/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: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:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-actor/src/abstract-actor.ts#L185)
6
6
 
7
7
  Abstract base class for Play Architecture actors.
8
8
 
@@ -57,19 +57,20 @@ Actor<TLogic>.constructor
57
57
 
58
58
  ## Properties
59
59
 
60
- | Property | Modifier | Type | Description | Inherited from | Defined in |
61
- | ------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
62
- | <a id="property-_parent"></a> `_parent?` | `public` | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef) | - | `Actor._parent` | - |
63
- | <a id="property-clock"></a> `clock` | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock) | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions. | `Actor.clock` | - |
64
- | <a id="property-id"></a> `id` | `public` | `string` | The unique identifier for this actor relative to its parent. | `Actor.id` | - |
65
- | <a id="property-logic"></a> `logic` | `public` | `TLogic` | - | `Actor.logic` | - |
66
- | <a id="property-options"></a> `options` | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\> | - | `Actor.options` | - |
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
- | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
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:195](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L195) |
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
- | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | - |
60
+ | Property | Modifier | Type | Description | Inherited from | Defined in |
61
+ | ----------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
62
+ | <a id="property-_parent"></a> `_parent?` | `public` | `AnyActor` | - | `Actor._parent` | - |
63
+ | <a id="property-clock"></a> `clock` | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock) | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions. | `Actor.clock` | - |
64
+ | <a id="property-id"></a> `id` | `public` | `string` | The unique identifier for this actor relative to its parent. | `Actor.id` | - |
65
+ | <a id="property-logic"></a> `logic` | `public` | `TLogic` | - | `Actor.logic` | - |
66
+ | <a id="property-options"></a> `options` | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\> | - | `Actor.options` | - |
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`\>, `SendableEventFromLogic`\<`TLogic`\>\> | - | `Actor.ref` | - |
68
+ | <a id="property-registrykey"></a> `registryKey` | `public` | `string` \| `undefined` | - | `Actor.registryKey` | - |
69
+ | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
70
+ | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` | - |
71
+ | <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/v2.0.0-alpha.1/packages/play-actor/src/abstract-actor.ts#L195) |
72
+ | <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | `Actor.system` | - |
73
+ | <a id="property-trigger"></a> `trigger` | `public` | `ActorTrigger`\<`SendableEventFromLogic`\<`TLogic`\>\> | - | `Actor.trigger` | - |
73
74
 
74
75
  ## Methods
75
76
 
@@ -151,7 +152,7 @@ When an actor receives an event, its internal state may change. An actor
151
152
  may emit a snapshot when a state transition occurs.
152
153
 
153
154
  Note that some actors, such as callback actors generated with
154
- `fromCallback`, will not emit snapshots.
155
+ `createCallbackLogic`, will not emit snapshots.
155
156
 
156
157
  #### See
157
158
 
@@ -176,9 +177,9 @@ Defined in: `xstate`
176
177
 
177
178
  #### Type Parameters
178
179
 
179
- | Type Parameter |
180
- | ----------------------- |
181
- | `TType` _extends_ `any` |
180
+ | Type Parameter |
181
+ | -------------------------- |
182
+ | `TType` _extends_ `string` |
182
183
 
183
184
  #### Parameters
184
185
 
@@ -238,7 +239,7 @@ Actor.select;
238
239
  abstract send(event): void;
239
240
  ```
240
241
 
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)
242
+ Defined in: [packages/play-actor/src/abstract-actor.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-actor/src/abstract-actor.ts#L202)
242
243
 
243
244
  Send event to Actor.
244
245
 
package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md CHANGED
@@ -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/v2.0.0-alpha.1/packages/play-actor/src/provider-guards.ts#L64)
10
10
 
11
11
  Clone a component registry and inject an `onRenderError` handler.
12
12
 
package/api/@xmachines/play-actor/functions/toAtomState.md CHANGED
@@ -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/v2.0.0-alpha.1/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
 
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: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/v2.0.0-alpha.1/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
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: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/v2.0.0-alpha.1/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
@@ -38,9 +38,9 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
38
38
 
39
39
  ## Properties
40
40
 
41
- | Property | Type | Description | Defined in |
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) |
41
+ | Property | Type | Description | Defined in |
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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/packages/play-actor/src/abstract-actor.ts#L167) |
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: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/v2.0.0-alpha.1/packages/play-actor/src/abstract-actor.ts#L123)
6
6
 
7
7
  Framework-agnostic base for every framework's `ViewContextValue`.
8
8
 
@@ -25,9 +25,9 @@ type) so it is typed via `TRegistry` — the same generic used in `BaseActorProv
25
25
 
26
26
  ## Properties
27
27
 
28
- | Property | Type | Description | Defined in |
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) |
28
+ | Property | Type | Description | Defined in |
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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/packages/play-actor/src/abstract-actor.ts#L131) |
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: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/v2.0.0-alpha.1/packages/play-actor/src/abstract-actor.ts#L48)
6
6
 
7
7
  XMachines extension of `@xmachines/json-render-core` `Spec`.
8
8
 
@@ -20,9 +20,9 @@ entries against your machine's context type at compile time.
20
20
 
21
21
  ## Properties
22
22
 
23
- | Property | Modifier | Type | Description | Inherited from | Defined in |
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) |
26
- | <a id="property-elements"></a> `elements` | `public` | `Record`\<`string`, `UIElement`\> | Flat map of elements by key | `Spec.elements` | - |
27
- | <a id="property-root"></a> `root` | `public` | `string` | Root element key | `Spec.root` | - |
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` | - |
23
+ | Property | Modifier | Type | Description | Inherited from | Defined in |
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/v2.0.0-alpha.1/packages/play-actor/src/abstract-actor.ts#L56) |
26
+ | <a id="property-elements"></a> `elements` | `public` | `Record`\<`string`, `UIElement`\> | Flat map of elements by key | `Spec.elements` | - |
27
+ | <a id="property-root"></a> `root` | `public` | `string` | Root element key | `Spec.root` | - |
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,13 +2,13 @@
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/v2.0.0-alpha.1/packages/play-actor/src/abstract-actor.ts#L32)
6
6
 
7
7
  Optional capability: Routing support
8
8
 
9
9
  ## Properties
10
10
 
11
- | Property | Modifier | Type | Defined in |
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) |
11
+ | Property | Modifier | Type | Defined in |
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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/packages/play-actor/src/abstract-actor.ts#L34) |
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: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/v2.0.0-alpha.1/packages/play-actor/src/abstract-actor.ts#L104)
6
6
 
7
7
  Actor capability for exposing renderable view state.
8
8
 
@@ -13,6 +13,6 @@ framework adapter.
13
13
 
14
14
  ## Properties
15
15
 
16
- | Property | Modifier | Type | Description | Defined in |
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) |
16
+ | Property | Modifier | Type | Description | Defined in |
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/v2.0.0-alpha.1/packages/play-actor/src/abstract-actor.ts#L111) |
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: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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/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/v2.0.0-alpha.1/packages/play-dom/src/PlayRenderer.ts#L127)
110
110
 
111
111
  Stop watching and clear the container.
112
112
 
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: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/v2.0.0-alpha.1/packages/play-dom/src/create-play-ui.ts#L93)
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: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/v2.0.0-alpha.1/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