@xmachines/docs 1.0.0-beta.34 → 1.0.0-beta.35

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 (321) hide show
  1. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  2. package/api/@xmachines/play/classes/PlayError.md +4 -4
  3. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  4. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  5. package/api/@xmachines/play-actor/README.md +9 -9
  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/README.md +4 -3
  14. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  15. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  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/functions/defineRegistry.md +1 -23
  19. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  20. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  21. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +13 -13
  22. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +8 -8
  23. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  24. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +12 -12
  25. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  26. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  27. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +5 -5
  28. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +5 -5
  29. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  31. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  32. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  36. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  41. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  42. package/api/@xmachines/play-dom-router/README.md +3 -3
  43. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  44. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  45. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +3 -3
  46. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  47. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  48. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  49. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  50. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  51. package/api/@xmachines/play-dom-router/interfaces/{RouteMapLike.md → RouteLookupContract.md} +7 -7
  52. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +6 -11
  53. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +8 -8
  54. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  55. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  56. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  57. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  58. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  59. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  60. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  61. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  62. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  63. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  64. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  65. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  66. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  67. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  68. package/api/@xmachines/play-react/variables/PlayRenderer.md +2 -2
  69. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  70. package/api/@xmachines/play-react-router/README.md +1 -0
  71. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +24 -24
  72. package/api/@xmachines/play-react-router/classes/RouteMap.md +38 -22
  73. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  74. package/api/@xmachines/play-react-router/functions/createRouteMap.md +21 -0
  75. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +5 -5
  76. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  77. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  78. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +8 -8
  79. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  80. package/api/@xmachines/play-router/README.md +6 -6
  81. package/api/@xmachines/play-router/classes/{BaseRouteMap.md → RouteMap.md} +11 -11
  82. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +24 -24
  83. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +2 -2
  84. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  85. package/api/@xmachines/play-router/functions/createRouteMap.md +6 -6
  86. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +5 -5
  87. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +6 -6
  88. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  89. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  90. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  91. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  92. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  93. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  94. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  95. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  96. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  97. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  98. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  99. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  100. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  101. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  102. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  103. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  104. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  105. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  106. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  107. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  108. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  109. package/api/@xmachines/play-router/interfaces/RouteMapping.md +8 -8
  110. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  111. package/api/@xmachines/play-router/interfaces/{RouteMap.md → RouteMatcher.md} +13 -13
  112. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  113. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  114. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  115. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  116. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  117. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  118. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  119. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  120. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  121. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  122. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  123. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  124. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  125. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  126. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  127. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  128. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  129. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  130. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  131. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  132. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  133. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  134. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  135. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  136. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  137. package/api/@xmachines/play-solid-router/README.md +2 -2
  138. package/api/@xmachines/play-solid-router/classes/RouteMap.md +9 -9
  139. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +25 -25
  140. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  141. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +3 -3
  142. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  143. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  144. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  145. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +8 -8
  146. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  147. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  148. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  149. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  150. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  151. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  152. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  153. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  154. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  155. package/api/@xmachines/play-svelte/interfaces/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 +9 -9
  158. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  159. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +3 -3
  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/RouteMapping.md +8 -8
  163. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  164. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  165. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  166. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +9 -9
  167. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  168. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +3 -3
  169. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  170. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  171. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  172. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +8 -8
  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 +38 -22
  177. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +24 -24
  178. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  179. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +7 -39
  180. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +5 -5
  181. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  182. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  183. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  184. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +8 -8
  185. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  186. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  187. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  188. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  189. package/api/@xmachines/play-tanstack-solid-router/README.md +1 -1
  190. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +9 -9
  191. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +25 -25
  192. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  193. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +3 -3
  194. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  195. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  196. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +8 -8
  197. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  198. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  199. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  200. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  201. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  202. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  203. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  204. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  205. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  206. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  207. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  208. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  209. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  210. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  211. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  212. package/api/@xmachines/play-vue-router/README.md +9 -4
  213. package/api/@xmachines/play-vue-router/classes/RouteMap.md +38 -20
  214. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +25 -25
  215. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  216. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  217. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +8 -8
  218. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  219. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  220. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  221. package/api/@xmachines/play-xstate/README.md +1 -1
  222. package/api/@xmachines/play-xstate/classes/PlayerActor.md +14 -14
  223. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  224. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  225. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  226. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  227. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  228. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  229. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  230. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  231. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  232. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  233. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  234. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  235. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  236. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  237. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  238. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  239. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  240. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  241. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  242. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  243. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  244. package/api/@xmachines/shared/README.md +47 -47
  245. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  246. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  247. package/api/llms.txt +4 -2
  248. package/examples/@xmachines/play-dom-demo/README.md +2 -2
  249. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +4 -3
  250. package/examples/@xmachines/play-dom-demo/functions/initShell.md +5 -1
  251. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  252. package/examples/@xmachines/play-dom-demo/variables/About.md +4 -1
  253. package/examples/@xmachines/play-dom-demo/variables/Contact.md +4 -1
  254. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +5 -1
  255. package/examples/@xmachines/play-dom-demo/variables/Home.md +5 -1
  256. package/examples/@xmachines/play-dom-demo/variables/Login.md +5 -1
  257. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +8 -1
  258. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +5 -1
  259. package/examples/@xmachines/play-dom-demo/variables/Overview.md +5 -1
  260. package/examples/@xmachines/play-dom-demo/variables/Profile.md +5 -1
  261. package/examples/@xmachines/play-dom-demo/variables/Settings.md +5 -1
  262. package/examples/@xmachines/play-dom-demo/variables/Stats.md +5 -1
  263. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  264. package/examples/@xmachines/play-dom-router-demo/README.md +26 -22
  265. package/examples/@xmachines/play-react-demo/README.md +2 -2
  266. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  267. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  268. package/examples/@xmachines/play-react-demo/variables/About.md +6 -1
  269. package/examples/@xmachines/play-react-demo/variables/Contact.md +6 -1
  270. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +7 -1
  271. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +5 -1
  272. package/examples/@xmachines/play-react-demo/variables/Home.md +6 -1
  273. package/examples/@xmachines/play-react-demo/variables/Login.md +8 -1
  274. package/examples/@xmachines/play-react-demo/variables/NavBar.md +6 -1
  275. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +7 -1
  276. package/examples/@xmachines/play-react-demo/variables/Navigation.md +6 -1
  277. package/examples/@xmachines/play-react-demo/variables/Overview.md +6 -1
  278. package/examples/@xmachines/play-react-demo/variables/Profile.md +6 -1
  279. package/examples/@xmachines/play-react-demo/variables/Settings.md +6 -1
  280. package/examples/@xmachines/play-react-demo/variables/Shell.md +6 -1
  281. package/examples/@xmachines/play-react-demo/variables/Stats.md +6 -1
  282. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  283. package/examples/@xmachines/play-react-router-demo/README.md +5 -3
  284. package/examples/@xmachines/play-solid-demo/README.md +2 -2
  285. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  286. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  287. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  288. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  289. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  290. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +5 -1
  291. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  292. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  293. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  294. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +6 -3
  295. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  296. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  297. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  298. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  299. package/examples/@xmachines/play-solid-demo/variables/Shell.md +5 -1
  300. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  301. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  302. package/examples/@xmachines/play-solid-router-demo/README.md +6 -4
  303. package/examples/@xmachines/play-svelte-demo/README.md +11 -1
  304. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +9 -0
  305. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +9 -0
  306. package/examples/@xmachines/play-svelte-demo/variables/App.md +9 -0
  307. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +172 -0
  308. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +2 -2
  309. package/examples/@xmachines/play-sveltekit-router-demo/README.md +2 -2
  310. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +3 -3
  311. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +4 -4
  312. package/examples/@xmachines/play-vue-demo/README.md +11 -2
  313. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +9 -0
  314. package/examples/@xmachines/play-vue-demo/variables/App.md +9 -0
  315. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +172 -0
  316. package/examples/@xmachines/play-vue-router-demo/README.md +21 -24
  317. package/examples/README.md +2 -0
  318. package/package.json +2 -2
  319. package/rfc/play.md +19 -19
  320. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +0 -141
  321. package/api/_media/README.md +0 -404
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ConnectRendererOptions
4
4
 
5
- Defined in: [packages/play-dom/src/types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L61)
5
+ Defined in: [packages/play-dom/src/types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L61)
6
6
 
7
7
  Options for connectRenderer() — backward compat API.
8
8
 
@@ -14,15 +14,15 @@ Options for connectRenderer() — backward compat API.
14
14
 
15
15
  | Property | Type | Description | Inherited from | Defined in |
16
16
  | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | - | [packages/play-dom/src/types.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L63) |
18
- | <a id="property-container"></a> `container` | `HTMLElement` | Container element to render into | - | [packages/play-dom/src/types.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L87) |
19
- | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional element shown when `currentView` is `null` on **initial mount** only. The fallback is appended immediately after `renderer.connect()` if the container is empty at that moment (i.e. the actor's initial view is `null`). **Limitation:** If the actor's view transitions to `null` after mount, the container will be cleared but this fallback will NOT be re-appended. For dynamic fallback behavior (null view after non-null), use `PlayRenderer` directly and wrap the `actor.currentView` signal to inject fallback content. | - | [packages/play-dom/src/types.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L100) |
20
- | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Custom computed functions available to `$computed` field expressions in specs. Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | [`UIProviderOptions`](UIProviderOptions.md).[`functions`](UIProviderOptions.md#property-functions) | [packages/play-dom/src/json-render/types.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L80) |
21
- | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Pre-resolved handler map — for backward compatibility. Ignored when `registryResult` is provided. | - | [packages/play-dom/src/types.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L112) |
22
- | <a id="property-loading"></a> `loading?` | `boolean` | When true, indicates the spec is still streaming (e.g. from an AI provider). Forwarded to PlayRenderer which threads it into renderSpec so components can read ctx.ctx.loading to show skeleton states. Also suppresses missing-child warnings. Mirrors the `loading` prop from framework renderer providers. | - | [packages/play-dom/src/types.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L127) |
23
- | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function forwarded to json-render computed functions that need to trigger programmatic navigation (e.g. a `navigate` action in the catalog). | [`UIProviderOptions`](UIProviderOptions.md).[`navigate`](UIProviderOptions.md#property-navigate) | [packages/play-dom/src/json-render/types.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L74) |
24
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Forwarded as `onRenderError` to the underlying renderer. | [`UIProviderOptions`](UIProviderOptions.md).[`onRenderError`](UIProviderOptions.md#property-onrendererror) | [packages/play-dom/src/json-render/types.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L86) |
25
- | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | Registry of component renderers — replaces old `components` map. When also providing `registryResult`, this **must** be the `.registry` field from the **same** `defineRegistry()` call to keep component renderers and action handlers aligned. Mixing a `registry` from one catalog with a `registryResult` from another will cause component wrappers and action handlers to be mismatched, producing silent runtime failures. **Example** `const registryResult = defineRegistry(catalog, { components, actions }); connectRenderer({ registry: registryResult.registry, // ← from the same call registryResult, // ... });` | - | [packages/play-dom/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L84) |
26
- | <a id="property-registryresult"></a> `registryResult?` | [`DefineRegistryResult`](DefineRegistryResult.md) | The result from `defineRegistry` — wires setState/getState from the xstate store into action handlers automatically. Preferred over `handlers` for new code. | - | [packages/play-dom/src/types.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L106) |
27
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored. When omitted, a fresh @xstate/store atom is created internally per view transition. | - | [packages/play-dom/src/types.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L119) |
28
- | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions for the json-render ValidationProvider equivalent. Each function receives `(value, args?)` and returns a boolean. | [`UIProviderOptions`](UIProviderOptions.md).[`validationFunctions`](UIProviderOptions.md#property-validationfunctions) | [packages/play-dom/src/json-render/types.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L68) |
17
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | - | [packages/play-dom/src/types.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L63) |
18
+ | <a id="property-container"></a> `container` | `HTMLElement` | Container element to render into | - | [packages/play-dom/src/types.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L87) |
19
+ | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional element shown when `currentView` is `null` on **initial mount** only. The fallback is appended immediately after `renderer.connect()` if the container is empty at that moment (i.e. the actor's initial view is `null`). **Limitation:** If the actor's view transitions to `null` after mount, the container will be cleared but this fallback will NOT be re-appended. For dynamic fallback behavior (null view after non-null), use `PlayRenderer` directly and wrap the `actor.currentView` signal to inject fallback content. | - | [packages/play-dom/src/types.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L100) |
20
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Custom computed functions available to `$computed` field expressions in specs. Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | [`UIProviderOptions`](UIProviderOptions.md).[`functions`](UIProviderOptions.md#property-functions) | [packages/play-dom/src/json-render/types.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L83) |
21
+ | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Pre-resolved handler map — for backward compatibility. Ignored when `registryResult` is provided. | - | [packages/play-dom/src/types.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L112) |
22
+ | <a id="property-loading"></a> `loading?` | `boolean` | When true, indicates the spec is still streaming (e.g. from an AI provider). Forwarded to PlayRenderer which threads it into renderSpec so components can read ctx.ctx.loading to show skeleton states. Also suppresses missing-child warnings. Mirrors the `loading` prop from framework renderer providers. | - | [packages/play-dom/src/types.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L127) |
23
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function forwarded to json-render computed functions that need to trigger programmatic navigation (e.g. a `navigate` action in the catalog). | [`UIProviderOptions`](UIProviderOptions.md).[`navigate`](UIProviderOptions.md#property-navigate) | [packages/play-dom/src/json-render/types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L77) |
24
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Forwarded as `onRenderError` to the underlying renderer. | [`UIProviderOptions`](UIProviderOptions.md).[`onRenderError`](UIProviderOptions.md#property-onrendererror) | [packages/play-dom/src/json-render/types.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L89) |
25
+ | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | Registry of component renderers — replaces old `components` map. When also providing `registryResult`, this **must** be the `.registry` field from the **same** `defineRegistry()` call to keep component renderers and action handlers aligned. Mixing a `registry` from one catalog with a `registryResult` from another will cause component wrappers and action handlers to be mismatched, producing silent runtime failures. **Example** `const registryResult = defineRegistry(catalog, { components, actions }); connectRenderer({ registry: registryResult.registry, // ← from the same call registryResult, // ... });` | - | [packages/play-dom/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L84) |
26
+ | <a id="property-registryresult"></a> `registryResult?` | [`DefineRegistryResult`](DefineRegistryResult.md) | The result from `defineRegistry` — wires setState/getState from the xstate store into action handlers automatically. Preferred over `handlers` for new code. | - | [packages/play-dom/src/types.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L106) |
27
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored. When omitted, a fresh @xstate/store atom is created internally per view transition. | - | [packages/play-dom/src/types.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L119) |
28
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions for the json-render ValidationProvider equivalent. Each function receives `(value, args?)` and returns a boolean. | [`UIProviderOptions`](UIProviderOptions.md).[`validationFunctions`](UIProviderOptions.md#property-validationfunctions) | [packages/play-dom/src/json-render/types.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L68) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: CreatePlayUIOptions
4
4
 
5
- Defined in: [packages/play-dom/src/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L139)
5
+ Defined in: [packages/play-dom/src/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L139)
6
6
 
7
7
  Options for createPlayUI() — the batteries-included DOM factory.
8
8
 
@@ -20,10 +20,10 @@ createPlayUI
20
20
 
21
21
  ## Properties
22
22
 
23
- | Property | Type | Description | Inherited from | Defined in |
24
- | ---------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25
- | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional fallback element shown when currentView is null on initial mount. Forwarded to connectRenderer/PlayRenderer as the fallback. | - | [packages/play-dom/src/types.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L144) |
26
- | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Custom computed functions available to `$computed` field expressions in specs. Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | [`UIProviderOptions`](UIProviderOptions.md).[`functions`](UIProviderOptions.md#property-functions) | [packages/play-dom/src/json-render/types.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L80) |
27
- | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function forwarded to json-render computed functions that need to trigger programmatic navigation (e.g. a `navigate` action in the catalog). | [`UIProviderOptions`](UIProviderOptions.md).[`navigate`](UIProviderOptions.md#property-navigate) | [packages/play-dom/src/json-render/types.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L74) |
28
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Forwarded as `onRenderError` to the underlying renderer. | [`UIProviderOptions`](UIProviderOptions.md).[`onRenderError`](UIProviderOptions.md#property-onrendererror) | [packages/play-dom/src/json-render/types.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L86) |
29
- | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions for the json-render ValidationProvider equivalent. Each function receives `(value, args?)` and returns a boolean. | [`UIProviderOptions`](UIProviderOptions.md).[`validationFunctions`](UIProviderOptions.md#property-validationfunctions) | [packages/play-dom/src/json-render/types.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L68) |
23
+ | Property | Type | Description | Inherited from | Defined in |
24
+ | ---------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25
+ | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional fallback element shown when `currentView` is `null` on **initial mount** only. The fallback is appended immediately after `mount()` if the container is empty at that moment (i.e. the actor's initial view is `null`). **Limitation:** If the actor's view transitions to `null` after mount, the container will be cleared but this fallback will NOT be re-appended. For dynamic fallback behavior (null view after non-null), use `PlayRenderer` directly and wrap the `actor.currentView` signal to inject fallback content. | - | [packages/play-dom/src/types.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L151) |
26
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Custom computed functions available to `$computed` field expressions in specs. Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | [`UIProviderOptions`](UIProviderOptions.md).[`functions`](UIProviderOptions.md#property-functions) | [packages/play-dom/src/json-render/types.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L83) |
27
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function forwarded to json-render computed functions that need to trigger programmatic navigation (e.g. a `navigate` action in the catalog). | [`UIProviderOptions`](UIProviderOptions.md).[`navigate`](UIProviderOptions.md#property-navigate) | [packages/play-dom/src/json-render/types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L77) |
28
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Forwarded as `onRenderError` to the underlying renderer. | [`UIProviderOptions`](UIProviderOptions.md).[`onRenderError`](UIProviderOptions.md#property-onrendererror) | [packages/play-dom/src/json-render/types.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L89) |
29
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions for the json-render ValidationProvider equivalent. Each function receives `(value, args?)` and returns a boolean. | [`UIProviderOptions`](UIProviderOptions.md).[`validationFunctions`](UIProviderOptions.md#property-validationfunctions) | [packages/play-dom/src/json-render/types.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L68) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DefineRegistryResult
4
4
 
5
- Defined in: [packages/play-dom/src/json-render/types.ts:331](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L331)
5
+ Defined in: [packages/play-dom/src/json-render/types.ts:334](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L334)
6
6
 
7
7
  Result returned by `defineRegistry`.
8
8
 
@@ -12,6 +12,6 @@ Matches `DefineRegistryResult` from @json-render/react, /solid, /svelte, /vue.
12
12
 
13
13
  | Property | Type | Description | Defined in |
14
14
  | --------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
15
- | <a id="property-executeaction"></a> `executeAction` | (`actionName`, `params`, `setState`, `state?`) => `Promise`\<`void`\> | Execute a named action by name, with optional params. Mirrors `executeAction` on `DefineRegistryResult` from @json-render/react, /solid, /vue, /svelte. Useful for programmatically triggering actions outside of the emit/on flow. | [packages/play-dom/src/json-render/types.ts:361](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L361) |
16
- | <a id="property-handlers"></a> `handlers` | (`getSetState`, `getState`) => `Record`\<`string`, `ActionHandler`\> | Create ActionProvider-compatible handlers. Accepts getter functions (called lazily at action-invocation time) so handlers always see the latest setState and state snapshot — matching the pattern from the framework renderers. In `PlayRenderer`, these are wired automatically from the xstate store. Pass `() => undefined, () => ({})` only in tests or when state management is not needed. | [packages/play-dom/src/json-render/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L346) |
17
- | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | The built `DomRegistry`, ready to pass to `connectRenderer` or `PlayRenderer`. | [packages/play-dom/src/json-render/types.ts:335](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L335) |
15
+ | <a id="property-executeaction"></a> `executeAction` | (`actionName`, `params`, `setState`, `state?`) => `Promise`\<`void`\> | Execute a named action by name, with optional params. Mirrors `executeAction` on `DefineRegistryResult` from @json-render/react, /solid, /vue, /svelte. Useful for programmatically triggering actions outside of the emit/on flow. | [packages/play-dom/src/json-render/types.ts:364](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L364) |
16
+ | <a id="property-handlers"></a> `handlers` | (`getSetState`, `getState`) => `Record`\<`string`, `ActionHandler`\> | Create ActionProvider-compatible handlers. Accepts getter functions (called lazily at action-invocation time) so handlers always see the latest setState and state snapshot — matching the pattern from the framework renderers. In `PlayRenderer`, these are wired automatically from the xstate store. Pass `() => undefined, () => ({})` only in tests or when state management is not needed. | [packages/play-dom/src/json-render/types.ts:349](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L349) |
17
+ | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | The built `DomRegistry`, ready to pass to `connectRenderer` or `PlayRenderer`. | [packages/play-dom/src/json-render/types.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L338) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DomRenderContext
4
4
 
5
- Defined in: [packages/play-dom/src/json-render/types.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L125)
5
+ Defined in: [packages/play-dom/src/json-render/types.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L128)
6
6
 
7
7
  Low-level render context passed to each `DomComponentRenderer`.
8
8
 
@@ -10,14 +10,14 @@ Low-level render context passed to each `DomComponentRenderer`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | -------------------------------------------------------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-elementbindings"></a> `elementBindings?` | `Record`\<`string`, `string`\> | Pre-computed two-way binding paths for this element's props. | [packages/play-dom/src/json-render/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L139) |
14
- | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Optional map of named compute functions, forwarded to PropResolutionContext. Enables { $computed: "funcName", args: {...} } prop expressions to resolve. Mirrors the `functions` prop from framework renderer providers. | [packages/play-dom/src/json-render/types.ts:146](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L146) |
15
- | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Map of json-render catalog action names → async ActionHandler functions. | [packages/play-dom/src/json-render/types.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L133) |
16
- | <a id="property-loading"></a> `loading?` | `boolean` | When true, indicates the spec is still streaming (e.g. from an AI provider). Component implementations can use this to show skeleton/loading states. When loading=true, missing-child warnings are suppressed. Mirrors the `loading` prop from framework renderer providers. | [packages/play-dom/src/json-render/types.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L154) |
17
- | <a id="property-renderchildren"></a> `renderChildren` | (`keys`) => `Node`[] | Render a list of child element keys into DOM nodes. | [packages/play-dom/src/json-render/types.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L135) |
18
- | <a id="property-repeatbasepath"></a> `repeatBasePath?` | `string` | Absolute JSON Pointer path to the current repeat item (e.g. "/todos/0"). Mirrors `repeatBasePath` in `PropResolutionContext`. | [packages/play-dom/src/json-render/types.ts:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L169) |
19
- | <a id="property-repeatindex"></a> `repeatIndex?` | `number` | Current repeat array index when inside a repeat scope. Mirrors `repeatIndex` in `PropResolutionContext`. | [packages/play-dom/src/json-render/types.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L164) |
20
- | <a id="property-repeatitem"></a> `repeatItem?` | `unknown` | Current repeat item when inside a repeat scope. Mirrors `repeatItem` in `@json-render/core`'s `PropResolutionContext`. | [packages/play-dom/src/json-render/types.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L159) |
21
- | <a id="property-send"></a> `send` | (`event`) => `void` | Dispatch an event (e.g. to an XState actor). | [packages/play-dom/src/json-render/types.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L131) |
22
- | <a id="property-spec"></a> `spec` | `Spec` | Full spec tree for this render pass. | [packages/play-dom/src/json-render/types.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L127) |
23
- | <a id="property-store"></a> `store` | `StateStore` | Live state store bound to `spec.state`. | [packages/play-dom/src/json-render/types.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L129) |
13
+ | <a id="property-elementbindings"></a> `elementBindings?` | `Record`\<`string`, `string`\> | Pre-computed two-way binding paths for this element's props. | [packages/play-dom/src/json-render/types.ts:142](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L142) |
14
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Optional map of named compute functions, forwarded to PropResolutionContext. Enables { $computed: "funcName", args: {...} } prop expressions to resolve. Mirrors the `functions` prop from framework renderer providers. | [packages/play-dom/src/json-render/types.ts:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L149) |
15
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Map of json-render catalog action names → async ActionHandler functions. | [packages/play-dom/src/json-render/types.ts:136](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L136) |
16
+ | <a id="property-loading"></a> `loading?` | `boolean` | When true, indicates the spec is still streaming (e.g. from an AI provider). Component implementations can use this to show skeleton/loading states. When loading=true, missing-child warnings are suppressed. Mirrors the `loading` prop from framework renderer providers. | [packages/play-dom/src/json-render/types.ts:157](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L157) |
17
+ | <a id="property-renderchildren"></a> `renderChildren` | (`keys`) => `Node`[] | Render a list of child element keys into DOM nodes. | [packages/play-dom/src/json-render/types.ts:138](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L138) |
18
+ | <a id="property-repeatbasepath"></a> `repeatBasePath?` | `string` | Absolute JSON Pointer path to the current repeat item (e.g. "/todos/0"). Mirrors `repeatBasePath` in `PropResolutionContext`. | [packages/play-dom/src/json-render/types.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L172) |
19
+ | <a id="property-repeatindex"></a> `repeatIndex?` | `number` | Current repeat array index when inside a repeat scope. Mirrors `repeatIndex` in `PropResolutionContext`. | [packages/play-dom/src/json-render/types.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L167) |
20
+ | <a id="property-repeatitem"></a> `repeatItem?` | `unknown` | Current repeat item when inside a repeat scope. Mirrors `repeatItem` in `@json-render/core`'s `PropResolutionContext`. | [packages/play-dom/src/json-render/types.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L162) |
21
+ | <a id="property-send"></a> `send` | (`event`) => `void` | Dispatch an event (e.g. to an XState actor). | [packages/play-dom/src/json-render/types.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L134) |
22
+ | <a id="property-spec"></a> `spec` | `Spec` | Full spec tree for this render pass. | [packages/play-dom/src/json-render/types.ts:130](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L130) |
23
+ | <a id="property-store"></a> `store` | `StateStore` | Live state store bound to `spec.state`. | [packages/play-dom/src/json-render/types.ts:132](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L132) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: EventHandle
4
4
 
5
- Defined in: [packages/play-dom/src/json-render/types.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L109)
5
+ Defined in: [packages/play-dom/src/json-render/types.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L112)
6
6
 
7
7
  Handle returned by `ComponentContext.on(eventName)`.
8
8
 
@@ -10,6 +10,6 @@ Handle returned by `ComponentContext.on(eventName)`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ----------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-bound"></a> `bound` | `boolean` | `true` if an `on` binding exists for this event name; `false` otherwise. | [packages/play-dom/src/json-render/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L117) |
14
- | <a id="property-emit"></a> `emit` | () => `void` | Fire the bound action, resolving params from the current state store. | [packages/play-dom/src/json-render/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L111) |
15
- | <a id="property-shouldpreventdefault"></a> `shouldPreventDefault` | `boolean` | Whether any binding for this event has `preventDefault: true`. | [packages/play-dom/src/json-render/types.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L115) |
13
+ | <a id="property-bound"></a> `bound` | `boolean` | `true` if an `on` binding exists for this event name; `false` otherwise. | [packages/play-dom/src/json-render/types.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L120) |
14
+ | <a id="property-emit"></a> `emit` | () => `void` | Fire the bound action, resolving params from the current state store. | [packages/play-dom/src/json-render/types.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L114) |
15
+ | <a id="property-shouldpreventdefault"></a> `shouldPreventDefault` | `boolean` | Whether any binding for this event has `preventDefault: true`. | [packages/play-dom/src/json-render/types.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L118) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: MountOptions
4
4
 
5
- Defined in: [packages/play-dom/src/create-play-ui.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/create-play-ui.ts#L35)
5
+ Defined in: [packages/play-dom/src/create-play-ui.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/create-play-ui.ts#L35)
6
6
 
7
7
  Per-mount options that can override factory-level settings.
8
8
 
@@ -10,5 +10,5 @@ Per-mount options that can override factory-level settings.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ---------------------------------------- | ------------ | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-loading"></a> `loading?` | `boolean` | When true, suppresses missing-child warnings during streaming spec ingestion. | [packages/play-dom/src/create-play-ui.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/create-play-ui.ts#L39) |
14
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When omitted, a fresh atom is created per view. | [packages/play-dom/src/create-play-ui.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/create-play-ui.ts#L37) |
13
+ | <a id="property-loading"></a> `loading?` | `boolean` | When true, suppresses missing-child warnings during streaming spec ingestion. | [packages/play-dom/src/create-play-ui.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/create-play-ui.ts#L39) |
14
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When omitted, a fresh atom is created per view. | [packages/play-dom/src/create-play-ui.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/create-play-ui.ts#L37) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayDomOptions
4
4
 
5
- Defined in: [packages/play-dom/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L20)
5
+ Defined in: [packages/play-dom/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L20)
6
6
 
7
7
  Options for PlayRenderer.
8
8
 
@@ -10,7 +10,7 @@ Options for PlayRenderer.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ------------------------------------------------------ | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Pre-resolved handler map — for backward compatibility or advanced use cases. When `registryResult` is provided, this is ignored. If you need actions to receive `setState` and `state`, use `registryResult` instead. | [packages/play-dom/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L38) |
14
- | <a id="property-loading"></a> `loading?` | `boolean` | When true, indicates the spec is still streaming (e.g. from an AI provider). Forwarded to renderSpec so ComponentFn implementations can read ctx.ctx.loading to show skeleton states. Also suppresses missing-child warnings during stream ingestion. Mirrors the `loading` prop from framework renderer providers. | [packages/play-dom/src/types.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L55) |
15
- | <a id="property-registryresult"></a> `registryResult?` | [`DefineRegistryResult`](DefineRegistryResult.md) | The result from `defineRegistry` — provides both the registry and the handlers factory. When provided, `PlayRenderer` wires `setState` and `getState` from the @xstate/store-backed `StateStore` into the handlers factory automatically. This is the preferred approach as it ensures actions always receive live `setState` and `state` bound to the current store. Mutually exclusive with `handlers`. | [packages/play-dom/src/types.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L30) |
16
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [packages/play-dom/src/types.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/types.ts#L47) |
13
+ | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Pre-resolved handler map — for backward compatibility or advanced use cases. When `registryResult` is provided, this is ignored. If you need actions to receive `setState` and `state`, use `registryResult` instead. | [packages/play-dom/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L38) |
14
+ | <a id="property-loading"></a> `loading?` | `boolean` | When true, indicates the spec is still streaming (e.g. from an AI provider). Forwarded to renderSpec so ComponentFn implementations can read ctx.ctx.loading to show skeleton states. Also suppresses missing-child warnings during stream ingestion. Mirrors the `loading` prop from framework renderer providers. | [packages/play-dom/src/types.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L55) |
15
+ | <a id="property-registryresult"></a> `registryResult?` | [`DefineRegistryResult`](DefineRegistryResult.md) | The result from `defineRegistry` — provides both the registry and the handlers factory. When provided, `PlayRenderer` wires `setState` and `getState` from the @xstate/store-backed `StateStore` into the handlers factory automatically. This is the preferred approach as it ensures actions always receive live `setState` and `state` bound to the current store. Mutually exclusive with `handlers`. | [packages/play-dom/src/types.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L30) |
16
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [packages/play-dom/src/types.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/types.ts#L47) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: UIProviderOptions
4
4
 
5
- Defined in: [packages/play-dom/src/json-render/types.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L63)
5
+ Defined in: [packages/play-dom/src/json-render/types.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L63)
6
6
 
7
7
  Shared UI-provider options — the configurable rendering behaviours that sit
8
8
  above the core actor/registry wiring.
@@ -21,7 +21,7 @@ in `types.ts` extend a single source of truth.
21
21
 
22
22
  | Property | Type | Description | Defined in |
23
23
  | ---------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
24
- | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Custom computed functions available to `$computed` field expressions in specs. Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | [packages/play-dom/src/json-render/types.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L80) |
25
- | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function forwarded to json-render computed functions that need to trigger programmatic navigation (e.g. a `navigate` action in the catalog). | [packages/play-dom/src/json-render/types.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L74) |
26
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Forwarded as `onRenderError` to the underlying renderer. | [packages/play-dom/src/json-render/types.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L86) |
27
- | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions for the json-render ValidationProvider equivalent. Each function receives `(value, args?)` and returns a boolean. | [packages/play-dom/src/json-render/types.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L68) |
24
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Custom computed functions available to `$computed` field expressions in specs. Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | [packages/play-dom/src/json-render/types.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L83) |
25
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function forwarded to json-render computed functions that need to trigger programmatic navigation (e.g. a `navigate` action in the catalog). | [packages/play-dom/src/json-render/types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L77) |
26
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Forwarded as `onRenderError` to the underlying renderer. | [packages/play-dom/src/json-render/types.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L89) |
27
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions for the json-render ValidationProvider equivalent. Each function receives `(value, args?)` and returns a boolean. | [packages/play-dom/src/json-render/types.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L68) |
@@ -6,7 +6,7 @@
6
6
  type ActionFn<C, K> = (params, setState, state) => Promise<void>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:272](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L272)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L275)
10
10
 
11
11
  Catalog-typed action function — mirrors `ActionFn<C, K>` from @json-render/react, /solid, /vue.
12
12
 
@@ -6,7 +6,7 @@
6
6
  type Actions<C> = { [K in keyof InferCatalogActions<C>]: ActionFn<C, K> };
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L282)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:285](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L285)
10
10
 
11
11
  Map of catalog-typed action handler functions.
12
12
  Each key is a catalog action name; each value is an `ActionFn<C, K>` for that action.
@@ -6,7 +6,7 @@
6
6
  type BaseComponentProps<P> = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L227)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L230)
10
10
 
11
11
  Catalog-agnostic component props type.
12
12
 
@@ -41,7 +41,7 @@ function MyButton({ props, emit }: BaseComponentProps<{ label: string }>) {
41
41
  bindings: Record<string, string> | undefined;
42
42
  ```
43
43
 
44
- Defined in: [packages/play-dom/src/json-render/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L230)
44
+ Defined in: [packages/play-dom/src/json-render/types.ts:233](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L233)
45
45
 
46
46
  ---
47
47
 
@@ -51,7 +51,7 @@ Defined in: [packages/play-dom/src/json-render/types.ts:230](https://gitlab.com/
51
51
  children: Node[];
52
52
  ```
53
53
 
54
- Defined in: [packages/play-dom/src/json-render/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L229)
54
+ Defined in: [packages/play-dom/src/json-render/types.ts:232](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L232)
55
55
 
56
56
  ---
57
57
 
@@ -61,7 +61,7 @@ Defined in: [packages/play-dom/src/json-render/types.ts:229](https://gitlab.com/
61
61
  ctx: DomRenderContext;
62
62
  ```
63
63
 
64
- Defined in: [packages/play-dom/src/json-render/types.ts:233](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L233)
64
+ Defined in: [packages/play-dom/src/json-render/types.ts:236](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L236)
65
65
 
66
66
  ---
67
67
 
@@ -71,7 +71,7 @@ Defined in: [packages/play-dom/src/json-render/types.ts:233](https://gitlab.com/
71
71
  emit: (event) => void;
72
72
  ```
73
73
 
74
- Defined in: [packages/play-dom/src/json-render/types.ts:231](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L231)
74
+ Defined in: [packages/play-dom/src/json-render/types.ts:234](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L234)
75
75
 
76
76
  #### Parameters
77
77
 
@@ -91,7 +91,7 @@ Defined in: [packages/play-dom/src/json-render/types.ts:231](https://gitlab.com/
91
91
  on: (event) => EventHandle;
92
92
  ```
93
93
 
94
- Defined in: [packages/play-dom/src/json-render/types.ts:232](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L232)
94
+ Defined in: [packages/play-dom/src/json-render/types.ts:235](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L235)
95
95
 
96
96
  #### Parameters
97
97
 
@@ -111,4 +111,4 @@ Defined in: [packages/play-dom/src/json-render/types.ts:232](https://gitlab.com/
111
111
  props: P;
112
112
  ```
113
113
 
114
- Defined in: [packages/play-dom/src/json-render/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L228)
114
+ Defined in: [packages/play-dom/src/json-render/types.ts:231](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L231)
@@ -10,7 +10,7 @@ type CatalogHasActions<C> = [InferCatalogActions<C>] extends [never]
10
10
  : true;
11
11
  ```
12
12
 
13
- Defined in: [packages/play-dom/src/json-render/types.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L98)
13
+ Defined in: [packages/play-dom/src/json-render/types.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L101)
14
14
 
15
15
  Evaluates to `true` when a catalog declares at least one action; `false` otherwise.
16
16
 
@@ -6,7 +6,7 @@
6
6
  type ComponentFn<C, K> = (ctx) => HTMLElement | Text | null;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L238)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:241](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L241)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  type ComponentRegistry<C> = { [K in keyof InferCatalogComponents<C>]: ComponentFn<C, K> };
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:244](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L244)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:247](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L247)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  type DefineRegistryOptions<C> = object & CatalogHasActions<C> extends true ? object : object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:304](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L304)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:307](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L307)
10
10
 
11
11
  Options for `defineRegistry`.
12
12
 
@@ -18,7 +18,7 @@ fully typed. When the catalog declares actions, `actions` is required; otherwise
18
18
 
19
19
  | Name | Type | Description | Defined in |
20
20
  | ------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
21
- | `components?` | [`ComponentRegistry`](ComponentRegistry.md)\<`C`\> | Catalog-typed component implementations. If omitted, all elements fall through to the `fallback` renderer (if provided) or return `null` — the container will be empty. | [packages/play-dom/src/json-render/types.ts:310](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L310) |
21
+ | `components?` | [`ComponentRegistry`](ComponentRegistry.md)\<`C`\> | Catalog-typed component implementations. If omitted, all elements fall through to the `fallback` renderer (if provided) or return `null` — the container will be empty. | [packages/play-dom/src/json-render/types.ts:313](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L313) |
22
22
 
23
23
  ## Type Parameters
24
24
 
@@ -6,7 +6,7 @@
6
6
  type DomComponentRenderer = (element, ctx) => HTMLElement | Text | null;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L174)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L177)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -6,4 +6,4 @@
6
6
  type DomRegistry = Record<string, DomComponentRenderer>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:250](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L250)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:253](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L253)
@@ -6,4 +6,4 @@
6
6
  type DomSchema = typeof schema;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/schema.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/schema.ts#L60)
9
+ Defined in: [packages/play-dom/src/json-render/schema.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/schema.ts#L60)
@@ -6,7 +6,7 @@
6
6
  type MountFn = (actor, container, options?) => () => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/create-play-ui.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/create-play-ui.ts#L47)
9
+ Defined in: [packages/play-dom/src/create-play-ui.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/create-play-ui.ts#L47)
10
10
 
11
11
  The mount function returned by createPlayUI.
12
12
  Call with (actor, container, mountOptions?) to start the renderer.
@@ -6,7 +6,7 @@
6
6
  type SetState = (updater) => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/types.ts#L46)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/types.ts#L46)
10
10
 
11
11
  Function to update the local state store.
12
12
 
@@ -46,7 +46,7 @@ const schema: Schema<{
46
46
  }>;
47
47
  ```
48
48
 
49
- Defined in: [packages/play-dom/src/json-render/schema.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-dom/src/json-render/schema.ts#L20)
49
+ Defined in: [packages/play-dom/src/json-render/schema.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-dom/src/json-render/schema.ts#L20)
50
50
 
51
51
  The schema for @xmachines/play-dom
52
52
 
@@ -240,8 +240,8 @@ interface BrowserHistory {
240
240
 
241
241
  ## Learn More
242
242
 
243
- - [Vanilla DOM renderer `@xmachines/play-dom`](../play-dom/README.md)
244
- - [Router core `@xmachines/play-router`](../play-router/README.md)
243
+ - [Vanilla DOM renderer `@xmachines/play-dom`](../play-dom)
244
+ - [Router core `@xmachines/play-router`](../play-router)
245
245
  - [Routing Patterns guide](../../packages/docs/examples/routing-patterns.md)
246
246
  - [Play RFC](../../packages/docs/rfc/play.md)
247
247
 
@@ -251,8 +251,8 @@ interface BrowserHistory {
251
251
  - [BrowserWindow](interfaces/BrowserWindow.md)
252
252
  - [ConnectRouterOptions](interfaces/ConnectRouterOptions.md)
253
253
  - [PlayRouteEvent](interfaces/PlayRouteEvent.md)
254
+ - [RouteLookupContract](interfaces/RouteLookupContract.md)
254
255
  - [RouteMap](interfaces/RouteMap.md)
255
- - [RouteMapLike](interfaces/RouteMapLike.md)
256
256
  - [RouteMapping](interfaces/RouteMapping.md)
257
257
  - [RouterBridge](interfaces/RouterBridge.md)
258
258
  - [VanillaRouter](interfaces/VanillaRouter.md)