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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (311) hide show
  1. package/README.md +4 -4
  2. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  3. package/api/@xmachines/play/classes/PlayError.md +4 -4
  4. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  6. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  7. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  8. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  9. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  10. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  11. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  13. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  14. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  15. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  16. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  17. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  18. package/api/@xmachines/play-dom/functions/renderSpec.md +3 -3
  19. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  20. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +13 -13
  21. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +6 -6
  22. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  23. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +12 -12
  24. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  25. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  26. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +5 -5
  27. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +5 -5
  28. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  29. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  31. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  35. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  40. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  41. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  42. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  43. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  44. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  45. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  46. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  47. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  48. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  49. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  50. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  51. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  52. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  53. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  54. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  55. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  56. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  57. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  58. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  59. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  60. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  61. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  62. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  63. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  64. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  65. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  66. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  67. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  68. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  69. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  70. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  71. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  72. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  73. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  74. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  75. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  76. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  77. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  78. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  79. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  80. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  81. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  82. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  83. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  84. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  85. package/api/@xmachines/play-router/functions/createRouteMatcher.md +1 -1
  86. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  87. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  88. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  89. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  90. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  91. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  92. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  93. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  94. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  95. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  96. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  97. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  98. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  99. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  100. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  101. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  102. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  103. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  104. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  105. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  106. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  107. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  108. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  109. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  110. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +4 -4
  111. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  112. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  113. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  114. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  115. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  116. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  117. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  118. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  119. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  120. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  121. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  122. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  123. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  124. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  125. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  126. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  127. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  128. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  129. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  130. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  131. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  132. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  133. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  134. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  135. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  136. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  137. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  138. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  139. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  140. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  141. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  142. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  143. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  144. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  145. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  146. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  147. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  148. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  149. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  150. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  151. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  152. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  153. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  154. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  155. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  156. package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +1 -1
  157. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  158. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  159. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  160. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  161. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  162. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  163. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  164. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  165. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  166. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  167. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  168. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  169. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  170. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  171. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  172. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  173. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  174. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  175. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  176. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  177. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  178. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  179. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  180. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  181. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  182. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  183. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  184. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  185. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  186. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  187. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  188. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  189. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  190. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  191. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  192. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  193. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  194. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  195. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  196. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  197. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  198. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  199. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  200. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  201. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  202. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  203. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  204. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  205. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  206. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  207. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  208. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  209. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  210. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  211. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  212. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  213. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  214. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  215. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  216. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  217. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  218. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  219. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  220. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  221. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  222. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  223. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  224. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  225. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  226. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  227. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  228. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  229. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  230. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  231. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  232. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  233. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  234. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  235. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  236. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  237. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  238. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  239. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  240. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  241. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  242. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  243. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  244. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  245. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  246. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  247. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  248. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  249. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  250. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  251. package/contributing/README.md +10 -0
  252. package/{guides → contributing}/configuration.md +19 -35
  253. package/{guides → contributing}/deployment.md +0 -22
  254. package/{guides → contributing}/development.md +2 -2
  255. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  256. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  257. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  258. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  259. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  260. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  261. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  262. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  263. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  264. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  265. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  266. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  267. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  268. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  269. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  270. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  271. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  272. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  273. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  274. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  275. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  276. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  277. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  278. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  279. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  280. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  281. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  282. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  283. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  284. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  285. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  286. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  287. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  288. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  289. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  290. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  291. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  292. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  293. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  294. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  295. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  296. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  297. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  298. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  299. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  300. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  301. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  302. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  303. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  304. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  305. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  306. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  307. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  308. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  309. package/guides/README.md +4 -0
  310. package/package.json +4 -2
  311. /package/{guides → contributing}/testing.md +0 -0
package/api/@xmachines/play-router/interfaces/RouteMatch.md CHANGED
@@ -2,11 +2,11 @@
2
2
 
3
3
  # Interface: RouteMatch
4
4
 
5
- Defined in: [router-sync.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-sync.ts#L9)
5
+ Defined in: [router-sync.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/router-sync.ts#L9)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Type | Defined in |
10
10
  | -------------------------------------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-params"></a> `params?` | `Record`\<`string`, `string`\> | [router-sync.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-sync.ts#L11) |
12
- | <a id="property-to"></a> `to` | `string` \| `null` \| `undefined` | [router-sync.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-sync.ts#L10) |
11
+ | <a id="property-params"></a> `params?` | `Record`\<`string`, `string`\> | [router-sync.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/router-sync.ts#L11) |
12
+ | <a id="property-to"></a> `to` | `string` \| `null` \| `undefined` | [router-sync.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/router-sync.ts#L10) |
package/api/@xmachines/play-router/interfaces/RouteMatcher.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMatcher
4
4
 
5
- Defined in: [create-route-matcher.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/create-route-matcher.ts#L20)
5
+ Defined in: [create-route-matcher.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/create-route-matcher.ts#L20)
6
6
 
7
7
  URL route matcher interface returned by `createRouteMatcher()`.
8
8
 
@@ -23,7 +23,7 @@ events into `play.route` actor events.
23
23
  match(path): object;
24
24
  ```
25
25
 
26
- Defined in: [create-route-matcher.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/create-route-matcher.ts#L37)
26
+ Defined in: [create-route-matcher.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/create-route-matcher.ts#L37)
27
27
 
28
28
  Match a URL path to a state ID and params.
29
29
 
@@ -52,5 +52,5 @@ if (to) {
52
52
 
53
53
  | Name | Type | Defined in |
54
54
  | -------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
55
- | `params` | `Record`\<`string`, `string`\> | [create-route-matcher.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/create-route-matcher.ts#L39) |
56
- | `to` | `string` \| `null` | [create-route-matcher.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/create-route-matcher.ts#L38) |
55
+ | `params` | `Record`\<`string`, `string`\> | [create-route-matcher.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/create-route-matcher.ts#L39) |
56
+ | `to` | `string` \| `null` | [create-route-matcher.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/create-route-matcher.ts#L38) |
package/api/@xmachines/play-router/interfaces/RouteNode.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteNode
4
4
 
5
- Defined in: [types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L77)
5
+ Defined in: [types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L77)
6
6
 
7
7
  Node in the route tree representing a single route
8
8
 
@@ -10,12 +10,12 @@ Node in the route tree representing a single route
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ----------------------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-children"></a> `children` | `RouteNode`[] | Child routes | [types.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L101) |
14
- | <a id="property-fullpath"></a> `fullPath` | `string` | The fully resolved absolute path from the root (e.g. `"/dashboard/overview"`). Always use `fullPath` for browser URL matching and route map construction. `createRouteMapFromTree` and `createRouteMap` both use this field. | [types.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L90) |
15
- | <a id="property-id"></a> `id` | `string` | Unique identifier (state ID) | [types.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L79) |
16
- | <a id="property-metadata"></a> `metadata` | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | Original meta.route metadata | [types.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L105) |
17
- | <a id="property-parent"></a> `parent` | `RouteNode` \| `null` | Parent route (null for root) | [types.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L103) |
18
- | <a id="property-path"></a> `path` | `string` | The raw route path segment as declared in `meta.route` — may be relative (e.g. `"overview"`) or absolute (e.g. `"/dashboard"`). Do not use this for URL matching; use `fullPath` instead. | [types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L84) |
19
- | <a id="property-pattern"></a> `pattern?` | `string` | Route pattern with parameters (e.g., /profile/:userId) if path contains params | [types.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L92) |
20
- | <a id="property-routable"></a> `routable` | `boolean` | Whether this state is routable (has meta.route) States with meta.route can receive play.route events | [types.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L99) |
21
- | <a id="property-stateid"></a> `stateId` | `string` | XState state ID this route maps to | [types.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L94) |
13
+ | <a id="property-children"></a> `children` | `RouteNode`[] | Child routes | [types.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L101) |
14
+ | <a id="property-fullpath"></a> `fullPath` | `string` | The fully resolved absolute path from the root (e.g. `"/dashboard/overview"`). Always use `fullPath` for browser URL matching and route map construction. `createRouteMapFromTree` and `createRouteMap` both use this field. | [types.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L90) |
15
+ | <a id="property-id"></a> `id` | `string` | Unique identifier (state ID) | [types.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L79) |
16
+ | <a id="property-metadata"></a> `metadata` | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | Original meta.route metadata | [types.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L105) |
17
+ | <a id="property-parent"></a> `parent` | `RouteNode` \| `null` | Parent route (null for root) | [types.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L103) |
18
+ | <a id="property-path"></a> `path` | `string` | The raw route path segment as declared in `meta.route` — may be relative (e.g. `"overview"`) or absolute (e.g. `"/dashboard"`). Do not use this for URL matching; use `fullPath` instead. | [types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L84) |
19
+ | <a id="property-pattern"></a> `pattern?` | `string` | Route pattern with parameters (e.g., /profile/:userId) if path contains params | [types.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L92) |
20
+ | <a id="property-routable"></a> `routable` | `boolean` | Whether this state is routable (has meta.route) States with meta.route can receive play.route events | [types.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L99) |
21
+ | <a id="property-stateid"></a> `stateId` | `string` | XState state ID this route maps to | [types.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L94) |
package/api/@xmachines/play-router/interfaces/RouteObject.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteObject
4
4
 
5
- Defined in: [types.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L39)
5
+ Defined in: [types.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L39)
6
6
 
7
7
  Route object with additional metadata.
8
8
 
@@ -18,4 +18,4 @@ Additional route metadata (title, breadcrumb, etc.)
18
18
 
19
19
  | Property | Type | Description | Defined in |
20
20
  | --------------------------------- | -------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
21
- | <a id="property-path"></a> `path` | `string` | Route path template (e.g., '/user/:id') | [types.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L41) |
21
+ | <a id="property-path"></a> `path` | `string` | Route path template (e.g., '/user/:id') | [types.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L41) |
package/api/@xmachines/play-router/interfaces/RouteTree.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteTree
4
4
 
5
- Defined in: [types.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L115)
5
+ Defined in: [types.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L115)
6
6
 
7
7
  Complete route tree with lookup maps
8
8
 
@@ -15,7 +15,7 @@ Provides bidirectional mapping between state IDs and URL paths:
15
15
 
16
16
  | Property | Type | Description | Defined in |
17
17
  | ------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
18
- | <a id="property-bypath"></a> `byPath` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | Map full path -> route node Used to look up state ID from URL path for play.route event targeting | [types.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L127) |
19
- | <a id="property-bystateid"></a> `byStateId` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | Map state ID -> route node Used to look up URL path from state ID for browser URL sync | [types.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L122) |
20
- | <a id="property-graph"></a> `graph?` | `Graph`\<[`MachineNodeData`](MachineNodeData.md), [`MachineEdgeData`](MachineEdgeData.md), `any`, `any`\> | Graph representation of the state machine for advanced queries. Populated by extractMachineRoutes() — use for hierarchy queries, reachability checks, and transition-aware navigation via @statelyai/graph algorithms. **Example** `import { getSuccessors, hasPath } from "@statelyai/graph"; const successors = getSuccessors(tree.graph!, "myMachine.home");` | [types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L139) |
21
- | <a id="property-root"></a> `root` | [`RouteNode`](RouteNode.md) | Root route node | [types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L117) |
18
+ | <a id="property-bypath"></a> `byPath` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | Map full path -> route node Used to look up state ID from URL path for play.route event targeting | [types.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L127) |
19
+ | <a id="property-bystateid"></a> `byStateId` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | Map state ID -> route node Used to look up URL path from state ID for browser URL sync | [types.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L122) |
20
+ | <a id="property-graph"></a> `graph?` | `Graph`\<[`MachineNodeData`](MachineNodeData.md), [`MachineEdgeData`](MachineEdgeData.md), `any`, `any`\> | Graph representation of the state machine for advanced queries. Populated by extractMachineRoutes() — use for hierarchy queries, reachability checks, and transition-aware navigation via @statelyai/graph algorithms. **Example** `import { getSuccessors, hasPath } from "@statelyai/graph"; const successors = getSuccessors(tree.graph!, "myMachine.home");` | [types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L139) |
21
+ | <a id="property-root"></a> `root` | [`RouteNode`](RouteNode.md) | Root route node | [types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L117) |
package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteWatcherHandle
4
4
 
5
- Defined in: [router-bridge-base.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L71)
5
+ Defined in: [router-bridge-base.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/router-bridge-base.ts#L71)
6
6
 
7
7
  Narrow interface for the TC39 Signal watcher used by `RouterBridgeBase` to
8
8
  monitor `actor.currentRoute` changes.
@@ -24,7 +24,7 @@ created and managed internally by `RouterBridgeBase`.
24
24
  unwatch(): void;
25
25
  ```
26
26
 
27
- Defined in: [router-bridge-base.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L75)
27
+ Defined in: [router-bridge-base.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/router-bridge-base.ts#L75)
28
28
 
29
29
  Stop observing and release the watcher.
30
30
 
@@ -40,7 +40,7 @@ Stop observing and release the watcher.
40
40
  watch(signal): void;
41
41
  ```
42
42
 
43
- Defined in: [router-bridge-base.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L73)
43
+ Defined in: [router-bridge-base.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/router-bridge-base.ts#L73)
44
44
 
45
45
  Arm the watcher to observe the given signal.
46
46
 
package/api/@xmachines/play-router/interfaces/RouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L271)
5
+ Defined in: [types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L271)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L287)
57
+ Defined in: [types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L287)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L303)
86
+ Defined in: [types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L303)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
package/api/@xmachines/play-router/interfaces/WindowLike.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: WindowLike
4
4
 
5
- Defined in: [types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L324)
5
+ Defined in: [types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L324)
6
6
 
7
7
  Minimal window interface required by adapters that subscribe to DOM events
8
8
  (e.g. `hashchange`). Injectable for SSR and testing — pass a mock instead of
@@ -30,7 +30,7 @@ connectRouter({ actor, routeMap, window: mockWin });
30
30
  addEventListener(type, listener): void;
31
31
  ```
32
32
 
33
- Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L325)
33
+ Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L325)
34
34
 
35
35
  #### Parameters
36
36
 
@@ -51,7 +51,7 @@ Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.
51
51
  removeEventListener(type, listener): void;
52
52
  ```
53
53
 
54
- Defined in: [types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L326)
54
+ Defined in: [types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L326)
55
55
 
56
56
  #### Parameters
57
57
 
package/api/@xmachines/play-router/type-aliases/MachineGraph.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type MachineGraph = Graph<MachineNodeData, MachineEdgeData>;
7
7
  ```
8
8
 
9
- Defined in: [machine-to-graph.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/machine-to-graph.ts#L18)
9
+ Defined in: [machine-to-graph.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/machine-to-graph.ts#L18)
10
10
 
11
11
  Typed @statelyai/graph Graph representing a state machine.
12
12
  Provides hierarchy queries, traversal algorithms, and reachability checks.
package/api/@xmachines/play-router/type-aliases/RouteMetadata.md CHANGED
@@ -6,6 +6,6 @@
6
6
  type RouteMetadata = string | RouteObject;
7
7
  ```
8
8
 
9
- Defined in: [types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/types.ts#L49)
9
+ Defined in: [types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-router/src/types.ts#L49)
10
10
 
11
11
  Route metadata from state machine `meta.route` field.
package/api/@xmachines/play-signals/functions/watchSignal.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function watchSignal<T>(signal, onValue): () => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-signals/src/watch-signal.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/watch-signal.ts#L21)
9
+ Defined in: [packages/play-signals/src/watch-signal.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/watch-signal.ts#L21)
10
10
 
11
11
  Subscribe to a single signal using the canonical one-shot watcher lifecycle.
12
12
 
package/api/@xmachines/play-signals/interfaces/ComputedOptions.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ComputedOptions\<T\>
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/types.ts#L84)
5
+ Defined in: [packages/play-signals/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/types.ts#L84)
6
6
 
7
7
  Options for creating Signal.Computed
8
8
 
@@ -31,4 +31,4 @@ const options: ComputedOptions<string> = {
31
31
 
32
32
  | Property | Type | Description | Defined in |
33
33
  | -------------------------------------- | ----------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
34
- | <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for memoization | [packages/play-signals/src/types.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/types.ts#L88) |
34
+ | <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for memoization | [packages/play-signals/src/types.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/types.ts#L88) |
package/api/@xmachines/play-signals/interfaces/SignalComputed.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: SignalComputed\<T\>
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/types.ts#L111)
5
+ Defined in: [packages/play-signals/src/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/types.ts#L111)
6
6
 
7
7
  Lazily-evaluated, memoized computed signal
8
8
 
@@ -38,7 +38,7 @@ console.log(doubled.get()); // 10 (memoized, not recomputed)
38
38
  get(): T;
39
39
  ```
40
40
 
41
- Defined in: [packages/play-signals/src/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/types.ts#L117)
41
+ Defined in: [packages/play-signals/src/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/types.ts#L117)
42
42
 
43
43
  Read computed value (recalculates only if dependencies changed)
44
44
 
package/api/@xmachines/play-signals/interfaces/SignalOptions.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: SignalOptions\<T\>
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/types.ts#L26)
5
+ Defined in: [packages/play-signals/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/types.ts#L26)
6
6
 
7
7
  Options for creating Signal.State
8
8
 
@@ -32,4 +32,4 @@ const count = new Signal.State(0, options);
32
32
 
33
33
  | Property | Type | Description | Defined in |
34
34
  | -------------------------------------- | ----------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
35
- | <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for determining if value changed | [packages/play-signals/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/types.ts#L33) |
35
+ | <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for determining if value changed | [packages/play-signals/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/types.ts#L33) |
package/api/@xmachines/play-signals/interfaces/SignalState.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: SignalState\<T\>
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/types.ts#L53)
5
+ Defined in: [packages/play-signals/src/types.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/types.ts#L53)
6
6
 
7
7
  Writable state signal holding a single reactive value
8
8
 
@@ -35,7 +35,7 @@ console.log(name.get()); // 'Bob'
35
35
  get(): T;
36
36
  ```
37
37
 
38
- Defined in: [packages/play-signals/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/types.ts#L59)
38
+ Defined in: [packages/play-signals/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/types.ts#L59)
39
39
 
40
40
  Read current value and track as dependency
41
41
 
@@ -53,7 +53,7 @@ Current value of the signal
53
53
  set(value): void;
54
54
  ```
55
55
 
56
- Defined in: [packages/play-signals/src/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/types.ts#L66)
56
+ Defined in: [packages/play-signals/src/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/types.ts#L66)
57
57
 
58
58
  Write new value and notify watchers if changed
59
59
 
package/api/@xmachines/play-signals/interfaces/SignalWatcher.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: SignalWatcher
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/types.ts#L167)
5
+ Defined in: [packages/play-signals/src/types.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/types.ts#L167)
6
6
 
7
7
  Watcher for observing signal changes and scheduling effects
8
8
 
@@ -40,7 +40,7 @@ getPending(): (
40
40
  | SignalComputed<unknown>)[];
41
41
  ```
42
42
 
43
- Defined in: [packages/play-signals/src/types.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/types.ts#L187)
43
+ Defined in: [packages/play-signals/src/types.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/types.ts#L187)
44
44
 
45
45
  Get signals that changed since last check
46
46
 
@@ -60,7 +60,7 @@ Array of signals that have pending updates
60
60
  unwatch(signal): void;
61
61
  ```
62
62
 
63
- Defined in: [packages/play-signals/src/types.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/types.ts#L180)
63
+ Defined in: [packages/play-signals/src/types.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/types.ts#L180)
64
64
 
65
65
  Stop watching a signal
66
66
 
@@ -82,7 +82,7 @@ Stop watching a signal
82
82
  watch(signal): void;
83
83
  ```
84
84
 
85
- Defined in: [packages/play-signals/src/types.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/types.ts#L173)
85
+ Defined in: [packages/play-signals/src/types.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/types.ts#L173)
86
86
 
87
87
  Start watching a signal for changes
88
88
 
package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type WatcherNotify = () => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-signals/src/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-signals/src/types.ts#L139)
9
+ Defined in: [packages/play-signals/src/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-signals/src/types.ts#L139)
10
10
 
11
11
  Notification callback for Signal.subtle.Watcher
12
12
 
package/api/@xmachines/play-solid/functions/useActor.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function useActor(): PlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/useActor.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-solid/src/useActor.ts#L36)
9
+ Defined in: [packages/play-solid/src/useActor.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/useActor.ts#L36)
10
10
 
11
11
  ## Returns
12
12
 
package/api/@xmachines/play-solid/functions/usePlayView.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function usePlayView(): ViewContextValue;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/ActorProvider.tsx:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-solid/src/ActorProvider.tsx#L69)
9
+ Defined in: [packages/play-solid/src/ActorProvider.tsx:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/ActorProvider.tsx#L69)
10
10
 
11
11
  Hook to access the current view context inside an ActorProvider tree.
12
12
 
package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ActorProviderProps
4
4
 
5
- Defined in: [packages/play-solid/src/ActorProvider.tsx:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-solid/src/ActorProvider.tsx#L83)
5
+ Defined in: [packages/play-solid/src/ActorProvider.tsx:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/ActorProvider.tsx#L83)
6
6
 
7
7
  Props for ActorProvider — the escape hatch primitive.
8
8
 
@@ -21,10 +21,10 @@ with JSONUIProvider and all required sub-providers.
21
21
 
22
22
  | Property | Type | Description | Inherited from | Defined in |
23
23
  | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
24
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-actor/src/abstract-actor.ts#L154) |
25
- | <a id="property-children"></a> `children` | `any` | Children — required; must include <PlayRenderer /> (or use PlayUIProvider shorthand) | - | [packages/play-solid/src/ActorProvider.tsx:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-solid/src/ActorProvider.tsx#L91) |
26
- | <a id="property-fallback"></a> `fallback?` | `any` | Optional fallback element shown when currentView is null or ErrorBoundary catches | - | [packages/play-solid/src/ActorProvider.tsx:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-solid/src/ActorProvider.tsx#L85) |
27
- | <a id="property-onerror"></a> `onError?` | (`error`) => `void` | Optional callback invoked when SolidJS ErrorBoundary catches an error | - | [packages/play-solid/src/ActorProvider.tsx:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-solid/src/ActorProvider.tsx#L88) |
28
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-actor/src/abstract-actor.ts#L167) |
29
- | <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-actor/src/abstract-actor.ts#L156) |
30
- | <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. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-actor/src/abstract-actor.ts#L162) |
24
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L154) |
25
+ | <a id="property-children"></a> `children` | `any` | Children — required; must include <PlayRenderer /> (or use PlayUIProvider shorthand) | - | [packages/play-solid/src/ActorProvider.tsx:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/ActorProvider.tsx#L91) |
26
+ | <a id="property-fallback"></a> `fallback?` | `any` | Optional fallback element shown when currentView is null or ErrorBoundary catches | - | [packages/play-solid/src/ActorProvider.tsx:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/ActorProvider.tsx#L85) |
27
+ | <a id="property-onerror"></a> `onError?` | (`error`) => `void` | Optional callback invoked when SolidJS ErrorBoundary catches an error | - | [packages/play-solid/src/ActorProvider.tsx:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/ActorProvider.tsx#L88) |
28
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L167) |
29
+ | <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L156) |
30
+ | <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. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L162) |
package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayUIProviderProps
4
4
 
5
- Defined in: [packages/play-solid/src/PlayUIProvider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-solid/src/PlayUIProvider.tsx#L36)
5
+ Defined in: [packages/play-solid/src/PlayUIProvider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/PlayUIProvider.tsx#L36)
6
6
 
7
7
  Props for PlayUIProvider — all ActorProvider props plus JSONUIProvider's forwarded props.
8
8
 
@@ -14,13 +14,13 @@ Props for PlayUIProvider — all ActorProvider props plus JSONUIProvider's forwa
14
14
 
15
15
  | Property | Type | Description | Inherited from | Defined in |
16
16
  | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-actor/src/abstract-actor.ts#L154) |
18
- | <a id="property-children"></a> `children` | `any` | Children — required; must include <PlayRenderer /> (or use PlayUIProvider shorthand) | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-solid/src/ActorProvider.tsx:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-solid/src/ActorProvider.tsx#L91) |
19
- | <a id="property-fallback"></a> `fallback?` | `any` | Optional fallback element shown when currentView is null or ErrorBoundary catches | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-solid/src/ActorProvider.tsx:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-solid/src/ActorProvider.tsx#L85) |
17
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L154) |
18
+ | <a id="property-children"></a> `children` | `any` | Children — required; must include <PlayRenderer /> (or use PlayUIProvider shorthand) | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-solid/src/ActorProvider.tsx:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/ActorProvider.tsx#L91) |
19
+ | <a id="property-fallback"></a> `fallback?` | `any` | Optional fallback element shown when currentView is null or ErrorBoundary catches | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-solid/src/ActorProvider.tsx:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/ActorProvider.tsx#L85) |
20
20
  | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Named functions for `$computed` expressions in props | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`functions`](JSONUIProviderProps.md#property-functions) | - |
21
21
  | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`navigate`](JSONUIProviderProps.md#property-navigate) | - |
22
- | <a id="property-onerror"></a> `onError?` | (`error`) => `void` | Optional callback invoked when SolidJS ErrorBoundary catches an error | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-solid/src/ActorProvider.tsx:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-solid/src/ActorProvider.tsx#L88) |
23
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-actor/src/abstract-actor.ts#L167) |
24
- | <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-actor/src/abstract-actor.ts#L156) |
25
- | <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. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-actor/src/abstract-actor.ts#L162) |
22
+ | <a id="property-onerror"></a> `onError?` | (`error`) => `void` | Optional callback invoked when SolidJS ErrorBoundary catches an error | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-solid/src/ActorProvider.tsx:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/ActorProvider.tsx#L88) |
23
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L167) |
24
+ | <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L156) |
25
+ | <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. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L162) |
26
26
  | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`validationFunctions`](JSONUIProviderProps.md#property-validationfunctions) | - |
package/api/@xmachines/play-solid/interfaces/ViewContextValue.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ViewContextValue
4
4
 
5
- Defined in: [packages/play-solid/src/ActorProvider.tsx:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-solid/src/ActorProvider.tsx#L50)
5
+ Defined in: [packages/play-solid/src/ActorProvider.tsx:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/ActorProvider.tsx#L50)
6
6
 
7
7
  Value provided by ActorProvider's ViewContext.
8
8
  Access via usePlayView() inside the ActorProvider tree.
@@ -15,7 +15,7 @@ Access via usePlayView() inside the ActorProvider tree.
15
15
 
16
16
  | Property | Type | Description | Inherited from | Defined in |
17
17
  | ----------------------------------------- | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
18
- | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-actor/src/abstract-actor.ts#L122) |
19
- | <a id="property-registry"></a> `registry` | [`ComponentRegistry`](../type-aliases/ComponentRegistry.md) | Component registry from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-actor/src/abstract-actor.ts#L124) |
20
- | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-actor/src/abstract-actor.ts#L120) |
21
- | <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-actor/src/abstract-actor.ts#L126) |
18
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L122) |
19
+ | <a id="property-registry"></a> `registry` | [`ComponentRegistry`](../type-aliases/ComponentRegistry.md) | Component registry from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L124) |
20
+ | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L120) |
21
+ | <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-actor/src/abstract-actor.ts#L126) |
package/api/@xmachines/play-solid/type-aliases/PlayActor.md CHANGED
@@ -6,4 +6,4 @@
6
6
  type PlayActor = AbstractActor<AnyActorLogic>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/useActor.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-solid/src/useActor.ts#L27)
9
+ Defined in: [packages/play-solid/src/useActor.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/useActor.ts#L27)
package/api/@xmachines/play-solid/variables/ActorContext.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const ActorContext: Context<PlayActor | null>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/useActor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-solid/src/useActor.ts#L34)
9
+ Defined in: [packages/play-solid/src/useActor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/useActor.ts#L34)
10
10
 
11
11
  SolidJS context for the actor — exported so consumers can use ActorContext.Provider
12
12
  directly as an escape hatch (per D-11). The smart ActorProvider component takes
package/api/@xmachines/play-solid/variables/ActorProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const ActorProvider: Component<ActorProviderProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/ActorProvider.tsx:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-solid/src/ActorProvider.tsx#L153)
9
+ Defined in: [packages/play-solid/src/ActorProvider.tsx:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.51/packages/play-solid/src/ActorProvider.tsx#L153)
10
10
 
11
11
  Smart ActorProvider component — owns actor bridging, signal subscription,
12
12
  StateStore lifecycle, handler resolution, and error boundary.