@xmachines/docs 1.0.0-beta.56 → 1.0.0-beta.57

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 (461) hide show
  1. package/README.md +4 -4
  2. package/api/@xmachines/play/README.md +3 -3
  3. package/api/@xmachines/play/classes/NonNullableError.md +7 -7
  4. package/api/@xmachines/play/classes/PlayError.md +7 -7
  5. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  6. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  7. package/api/@xmachines/play-actor/README.md +5 -5
  8. package/api/@xmachines/play-actor/classes/AbstractActor.md +14 -14
  9. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  10. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  11. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  12. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  13. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  14. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  15. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  16. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  17. package/api/@xmachines/play-dom/README.md +4 -4
  18. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  19. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  20. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  21. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  22. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  23. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +1 -1
  24. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +2 -2
  25. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +1 -1
  26. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +1 -1
  27. package/api/@xmachines/play-dom/interfaces/EventHandle.md +1 -1
  28. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  29. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +4 -4
  30. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +1 -1
  31. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  35. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  41. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  43. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  44. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
  45. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  46. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  47. package/api/@xmachines/play-dom-router/README.md +4 -4
  48. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  49. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  50. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  51. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  52. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  53. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  54. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  55. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  56. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  57. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  58. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  59. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  60. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  61. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  62. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  63. package/api/@xmachines/play-react/README.md +5 -5
  64. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +18 -18
  65. package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
  66. package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
  67. package/api/@xmachines/play-react/functions/Renderer.md +1 -1
  68. package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
  69. package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
  70. package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
  71. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  72. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  73. package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
  74. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  75. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  76. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
  77. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  78. package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
  79. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +1 -1
  80. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  81. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  82. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  83. package/api/@xmachines/play-react/interfaces/RendererProps.md +1 -1
  84. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
  85. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
  86. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  87. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
  88. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  89. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
  90. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
  91. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  92. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  93. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  94. package/api/@xmachines/play-react-router/README.md +5 -5
  95. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
  96. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  97. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  98. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  99. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  100. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  101. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  102. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  103. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  104. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  105. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  106. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  107. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  108. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  109. package/api/@xmachines/play-router/README.md +5 -5
  110. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  111. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
  112. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  113. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  114. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  115. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  116. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  117. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  118. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  119. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  120. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  121. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  122. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  123. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  124. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  125. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  126. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  127. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  128. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  129. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  130. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  131. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  132. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  133. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  134. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  135. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  136. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  137. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +3 -3
  138. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  139. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  140. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  141. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  142. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  143. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  144. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  145. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  146. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  147. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  148. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  149. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  150. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  151. package/api/@xmachines/play-signals/README.md +5 -5
  152. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  153. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  154. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  155. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  156. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  157. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  158. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +3 -3
  159. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +4 -4
  160. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
  161. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +5 -5
  162. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
  163. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
  164. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
  165. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
  166. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
  167. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
  168. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
  169. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
  170. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
  171. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
  172. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
  173. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  174. package/api/@xmachines/play-solid/README.md +6 -6
  175. package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
  176. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
  177. package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
  178. package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
  179. package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
  180. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
  181. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  182. package/api/@xmachines/play-solid/functions/useAction.md +1 -1
  183. package/api/@xmachines/play-solid/functions/useActions.md +1 -1
  184. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  185. package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
  186. package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
  187. package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
  188. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
  189. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  190. package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
  191. package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
  192. package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
  193. package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
  194. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
  195. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  196. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
  197. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
  198. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +1 -1
  199. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  200. package/api/@xmachines/play-solid/interfaces/RendererProps.md +1 -1
  201. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
  202. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
  203. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  204. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  205. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
  206. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -1
  207. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
  208. package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
  209. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
  210. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  211. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  212. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  213. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  214. package/api/@xmachines/play-solid-router/README.md +5 -5
  215. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  216. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
  217. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  218. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  219. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +13 -13
  220. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  221. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  222. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  223. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  224. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  225. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  226. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  227. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  228. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  229. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  230. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  231. package/api/@xmachines/play-svelte/README.md +5 -5
  232. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  233. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  234. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  235. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  236. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  237. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +1 -1
  238. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
  239. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  240. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  241. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  242. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +1 -1
  243. package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
  244. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  245. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
  246. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
  247. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +1 -1
  248. package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
  249. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
  250. package/api/@xmachines/play-svelte-spa-router/README.md +4 -4
  251. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  252. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  253. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  254. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  255. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  256. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  257. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  258. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  259. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  260. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  261. package/api/@xmachines/play-sveltekit-router/README.md +6 -6
  262. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  263. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  264. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  265. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  266. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  267. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  268. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  269. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  270. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  271. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  272. package/api/@xmachines/play-tanstack-react-router/README.md +6 -6
  273. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  274. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
  275. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  276. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  277. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  278. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  279. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  280. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  281. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  282. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  283. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  284. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  285. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  286. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  287. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  288. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  289. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  290. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  291. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
  292. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  293. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
  294. package/api/@xmachines/play-tanstack-solid-router/README.md +5 -5
  295. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  296. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
  297. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  298. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  299. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  300. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  301. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  302. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  303. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  304. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  305. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  306. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  307. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  308. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  309. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  310. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  311. package/api/@xmachines/play-vue/README.md +5 -5
  312. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  313. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  314. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  315. package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
  316. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
  317. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  318. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
  319. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
  320. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +1 -1
  321. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  322. package/api/@xmachines/play-vue/interfaces/RendererProps.md +1 -1
  323. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
  324. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
  325. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  326. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  327. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  328. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  329. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
  330. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  331. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  332. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
  333. package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
  334. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +1 -1
  335. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  336. package/api/@xmachines/play-vue/variables/Renderer.md +1 -1
  337. package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
  338. package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
  339. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
  340. package/api/@xmachines/play-vue-router/README.md +4 -4
  341. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  342. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
  343. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  344. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  345. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  346. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  347. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  348. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  349. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  350. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  351. package/api/@xmachines/play-xstate/README.md +3 -3
  352. package/api/@xmachines/play-xstate/classes/PlayerActor.md +19 -19
  353. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  354. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  355. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  356. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  357. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  358. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  359. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  360. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  361. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  362. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  363. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  364. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  365. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  366. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  367. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  368. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  369. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  370. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  371. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  372. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  373. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  374. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  375. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  376. package/api/@xmachines/shared/README.md +2 -2
  377. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  378. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  379. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  380. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +2 -2
  381. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  382. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  383. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  384. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  385. package/contributing/configuration.md +12 -12
  386. package/contributing/deployment.md +9 -9
  387. package/contributing/development.md +43 -43
  388. package/contributing/testing.md +15 -15
  389. package/examples/@xmachines/play-dom-demo/README.md +12 -12
  390. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  391. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  392. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  393. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  394. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  395. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  396. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  397. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  398. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  399. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  400. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  401. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  402. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  403. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  404. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  405. package/examples/@xmachines/play-dom-router-demo/README.md +12 -12
  406. package/examples/@xmachines/play-react-demo/README.md +12 -12
  407. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  408. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  409. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  410. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  411. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  412. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  413. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  414. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  415. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  416. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  417. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  418. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  419. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  420. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  421. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  422. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  423. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  424. package/examples/@xmachines/play-react-router-demo/README.md +12 -12
  425. package/examples/@xmachines/play-solid-demo/README.md +12 -12
  426. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  427. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  428. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  429. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  430. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  431. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  432. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  433. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  434. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  435. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  436. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  437. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  438. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  439. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  440. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  441. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  442. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  443. package/examples/@xmachines/play-solid-router-demo/README.md +12 -12
  444. package/examples/@xmachines/play-svelte-demo/README.md +12 -12
  445. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
  446. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  447. package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
  448. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  449. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +12 -12
  450. package/examples/@xmachines/play-sveltekit-router-demo/README.md +12 -12
  451. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +12 -12
  452. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +12 -12
  453. package/examples/@xmachines/play-vue-demo/README.md +12 -12
  454. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  455. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  456. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  457. package/examples/@xmachines/play-vue-router-demo/README.md +12 -12
  458. package/examples/README.md +3 -3
  459. package/guides/getting-started.md +31 -38
  460. package/guides/signals.md +2 -2
  461. package/package.json +2 -2
@@ -6,7 +6,7 @@
6
6
  function createRenderer<C>(catalog, componentMap): (actor, container, options?) => () => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/create-renderer.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/create-renderer.ts#L84)
9
+ Defined in: [packages/play-dom/src/create-renderer.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom/src/create-renderer.ts#L84)
10
10
 
11
11
  Create a reusable DOM renderer factory from a catalog and component map.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function defineRegistry<C>(_catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-dom`
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  function renderSpec(spec, store, registry, options?): Node | null;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-dom`
10
10
 
11
11
  Render a Spec tree into DOM nodes using the provided `DomRegistry`.
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ComponentContext\<C, K\>
4
4
 
5
- Defined in: `.pnpm`
5
+ Defined in: `@xmachines/json-render-dom`
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: CreatePlayUIOptions
4
4
 
5
- Defined in: [packages/play-dom/src/types.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/types.ts#L67)
5
+ Defined in: [packages/play-dom/src/types.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom/src/types.ts#L67)
6
6
 
7
7
  Options for `createPlayUI()` — the batteries-included DOM factory.
8
8
 
@@ -26,7 +26,7 @@ createPlayUI
26
26
  | Property | Type | Description | Inherited from | Defined in |
27
27
  | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
28
28
  | <a id="property-directives"></a> `directives?` | `DirectiveDefinition`\<`ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>\>[] | Custom directives — user-defined `$`-prefixed dynamic values that extend the spec expression language (e.g. `{ $format: "currency", value: ... }`). Each entry is a `DirectiveDefinition` built with `defineDirective` from `@xmachines/json-render-core`. The array is converted to a `DirectiveRegistry` once per render pass and forwarded to `resolveElementProps` via `PropResolutionContext.directives`. Built-in expressions (`$state`, `$cond`, etc.) always take precedence over custom directives. Mirrors the `directives` prop on `JSONUIProvider` / `JsonUIProvider` introduced in **Json-render** 0.19. **Example** `import { defineDirective, resolvePropValue } from "@xmachines/json-render-core"; import { z } from "zod"; const formatDirective = defineDirective({ name: "$format", description: "Locale-aware number formatting.", schema: z.object({ $format: z.enum(["number", "currency"]), value: z.unknown() }), resolve(value, ctx) { const resolved = resolvePropValue(value.value, ctx); return new Intl.NumberFormat().format(resolved as number); }, }); renderSpec(spec, store, registry, { directives: [formatDirective] });` | [`UIProviderOptions`](UIProviderOptions.md).[`directives`](UIProviderOptions.md#property-directives) | - |
29
- | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional fallback element shown when `currentView` is `null` on **initial mount** only. The fallback is appended immediately after `mount()` if the container is empty at that moment (i.e. the actor's initial view is `null`). **Limitation:** If the actor's view transitions to `null` after mount, the container will be cleared but this fallback will NOT be re-appended. For dynamic fallback behavior (null view after non-null), use `PlayRenderer` directly and wrap the `actor.currentView` signal to inject fallback content. | - | [packages/play-dom/src/types.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/types.ts#L79) |
29
+ | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional fallback element shown when `currentView` is `null` on **initial mount** only. The fallback is appended immediately after `mount()` if the container is empty at that moment (i.e. the actor's initial view is `null`). **Limitation:** If the actor's view transitions to `null` after mount, the container will be cleared but this fallback will NOT be re-appended. For dynamic fallback behavior (null view after non-null), use `PlayRenderer` directly and wrap the `actor.currentView` signal to inject fallback content. | - | [packages/play-dom/src/types.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom/src/types.ts#L79) |
30
30
  | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Named compute functions for `{ $computed: "name", args: {...} }` prop expressions. Each function receives the resolved `args` object and returns the computed value. Forwarded directly to `resolveElementProps` via `PropResolutionContext.functions`, matching the `FunctionsContext` provider in the framework renderers. Without this option, `$computed` expressions resolve to `undefined` (no throw). **Example** `renderSpec(spec, store, registry, { functions: { fullName: (args) => `${args.first} ${args.last}`, formatCurrency: (args) => new Intl.NumberFormat().format(args.amount as number), }, });` Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | [`UIProviderOptions`](UIProviderOptions.md).[`functions`](UIProviderOptions.md#property-functions) | - |
31
31
  | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Programmatic navigation function. Called automatically when an action binding resolves with `onSuccess: { navigate: "/path" }`. The resolved path string is passed as the sole argument. Mirrors the `navigate` prop in `ActionProvider` from the framework renderers, where it is captured in the `execute()` closure. Also available to component implementations directly via `ctx.ctx.navigate` for cases where navigation needs to be triggered outside of an action binding. **Example** `import { useNavigate } from "my-router"; const navigate = useNavigate(); renderSpec(spec, store, registry, { navigate });` Spec binding that triggers navigation: `{ "on": { "click": { "action": "doSomething", "onSuccess": { "navigate": "/dashboard" } } } }` | [`UIProviderOptions`](UIProviderOptions.md).[`navigate`](UIProviderOptions.md#property-navigate) | - |
32
32
  | <a id="property-onconfirm"></a> `onConfirm?` | [`ConfirmHandler`](../type-aliases/ConfirmHandler.md) | Confirmation hook for actions that declare `confirm` in their binding. Consulted by `emit()` before executing a confirm-gated action. Return (or resolve) `true` to execute, `false` to skip. Without this handler, confirm-gated actions are skipped with a `console.warn` — they never execute unconfirmed. See [ConfirmHandler](../type-aliases/ConfirmHandler.md) for the full contract. This is the headless equivalent of the `pendingConfirmation` / `confirmAction()` / `cancelAction()` flow in the framework adapters. | [`UIProviderOptions`](UIProviderOptions.md).[`onConfirm`](UIProviderOptions.md#property-onconfirm) | - |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DefineRegistryResult
4
4
 
5
- Defined in: `.pnpm`
5
+ Defined in: `@xmachines/json-render-dom`
6
6
 
7
7
  Result returned by `defineRegistry`.
8
8
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DomRenderContext
4
4
 
5
- Defined in: `.pnpm`
5
+ Defined in: `@xmachines/json-render-dom`
6
6
 
7
7
  Low-level render context passed to each `DomComponentRenderer`.
8
8
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: EventHandle
4
4
 
5
- Defined in: `.pnpm`
5
+ Defined in: `@xmachines/json-render-dom`
6
6
 
7
7
  Handle returned by `ComponentContext.on(eventName)`.
8
8
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: MountOptions
4
4
 
5
- Defined in: [packages/play-dom/src/create-play-ui.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/create-play-ui.ts#L48)
5
+ Defined in: [packages/play-dom/src/create-play-ui.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom/src/create-play-ui.ts#L48)
6
6
 
7
7
  Per-mount options passed to the `MountFn` returned by `createPlayUI`.
8
8
 
@@ -14,5 +14,5 @@ basis. Factory-level options (`functions`, `validationFunctions`, `navigate`,
14
14
 
15
15
  | Property | Type | Description | Defined in |
16
16
  | ---------------------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-loading"></a> `loading?` | `boolean` | When `true`, suppresses missing-child warnings during streaming spec ingestion and exposes `ctx.ctx.loading` to component implementations. | [packages/play-dom/src/create-play-ui.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/create-play-ui.ts#L59) |
18
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external `StateStore` (controlled mode). When omitted, a fresh `@xstate/store` atom is created per view transition seeded from `spec.state`. | [packages/play-dom/src/create-play-ui.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/create-play-ui.ts#L54) |
17
+ | <a id="property-loading"></a> `loading?` | `boolean` | When `true`, suppresses missing-child warnings during streaming spec ingestion and exposes `ctx.ctx.loading` to component implementations. | [packages/play-dom/src/create-play-ui.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom/src/create-play-ui.ts#L59) |
18
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external `StateStore` (controlled mode). When omitted, a fresh `@xstate/store` atom is created per view transition seeded from `spec.state`. | [packages/play-dom/src/create-play-ui.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom/src/create-play-ui.ts#L54) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayDomOptions
4
4
 
5
- Defined in: [packages/play-dom/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/types.ts#L23)
5
+ Defined in: [packages/play-dom/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom/src/types.ts#L23)
6
6
 
7
7
  Options for `PlayRenderer`.
8
8
 
@@ -21,10 +21,10 @@ by component implementations via `ctx.ctx.*`.
21
21
  | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
22
22
  | <a id="property-directives"></a> `directives?` | `DirectiveDefinition`\<`ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>\>[] | Custom directives — user-defined `$`-prefixed dynamic values that extend the spec expression language (e.g. `{ $format: "currency", value: ... }`). Each entry is a `DirectiveDefinition` built with `defineDirective` from `@xmachines/json-render-core`. The array is converted to a `DirectiveRegistry` once per render pass and forwarded to `resolveElementProps` via `PropResolutionContext.directives`. Built-in expressions (`$state`, `$cond`, etc.) always take precedence over custom directives. Mirrors the `directives` prop on `JSONUIProvider` / `JsonUIProvider` introduced in **Json-render** 0.19. **Example** `import { defineDirective, resolvePropValue } from "@xmachines/json-render-core"; import { z } from "zod"; const formatDirective = defineDirective({ name: "$format", description: "Locale-aware number formatting.", schema: z.object({ $format: z.enum(["number", "currency"]), value: z.unknown() }), resolve(value, ctx) { const resolved = resolvePropValue(value.value, ctx); return new Intl.NumberFormat().format(resolved as number); }, }); renderSpec(spec, store, registry, { directives: [formatDirective] });` | [`UIProviderOptions`](UIProviderOptions.md).[`directives`](UIProviderOptions.md#property-directives) | - |
23
23
  | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Named compute functions for `{ $computed: "name", args: {...} }` prop expressions. Each function receives the resolved `args` object and returns the computed value. Forwarded directly to `resolveElementProps` via `PropResolutionContext.functions`, matching the `FunctionsContext` provider in the framework renderers. Without this option, `$computed` expressions resolve to `undefined` (no throw). **Example** `renderSpec(spec, store, registry, { functions: { fullName: (args) => `${args.first} ${args.last}`, formatCurrency: (args) => new Intl.NumberFormat().format(args.amount as number), }, });` Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | [`UIProviderOptions`](UIProviderOptions.md).[`functions`](UIProviderOptions.md#property-functions) | - |
24
- | <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 component implementations can read `ctx.ctx.loading` to render skeleton states. Also suppresses missing-child warnings during stream ingestion, since referenced elements may not yet have arrived in the incremental spec. Mirrors the `loading` prop from framework renderer providers. | - | [packages/play-dom/src/types.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/types.ts#L52) |
24
+ | <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 component implementations can read `ctx.ctx.loading` to render skeleton states. Also suppresses missing-child warnings during stream ingestion, since referenced elements may not yet have arrived in the incremental spec. Mirrors the `loading` prop from framework renderer providers. | - | [packages/play-dom/src/types.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom/src/types.ts#L52) |
25
25
  | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Programmatic navigation function. Called automatically when an action binding resolves with `onSuccess: { navigate: "/path" }`. The resolved path string is passed as the sole argument. Mirrors the `navigate` prop in `ActionProvider` from the framework renderers, where it is captured in the `execute()` closure. Also available to component implementations directly via `ctx.ctx.navigate` for cases where navigation needs to be triggered outside of an action binding. **Example** `import { useNavigate } from "my-router"; const navigate = useNavigate(); renderSpec(spec, store, registry, { navigate });` Spec binding that triggers navigation: `{ "on": { "click": { "action": "doSomething", "onSuccess": { "navigate": "/dashboard" } } } }` | [`UIProviderOptions`](UIProviderOptions.md).[`navigate`](UIProviderOptions.md#property-navigate) | - |
26
26
  | <a id="property-onconfirm"></a> `onConfirm?` | [`ConfirmHandler`](../type-aliases/ConfirmHandler.md) | Confirmation hook for actions that declare `confirm` in their binding. Consulted by `emit()` before executing a confirm-gated action. Return (or resolve) `true` to execute, `false` to skip. Without this handler, confirm-gated actions are skipped with a `console.warn` — they never execute unconfirmed. See [ConfirmHandler](../type-aliases/ConfirmHandler.md) for the full contract. This is the headless equivalent of the `pendingConfirmation` / `confirmAction()` / `cancelAction()` flow in the framework adapters. | [`UIProviderOptions`](UIProviderOptions.md).[`onConfirm`](UIProviderOptions.md#property-onconfirm) | - |
27
27
  | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Unified error handler for component render errors and action handler rejections. Matches `RenderErrorHandler = (error: unknown, name: string) => void`. Invoked for three distinct error classes: - `(error, elementType)` — when a component renderer throws synchronously during `renderSpec` - `(error, actionName)` — when an action handler rejects during `emit()` (on-event path) - `(error, actionName)` — when an action handler rejects during a `watch` binding callback When provided, suppresses the `console.error` fallback for all three error types. Forwarded into `renderSpec` as the `onRenderError` parameter and into `DomRenderContext.onRenderError` so both `emit()` and `watch` handlers route their errors through the same channel as component render errors. **Example** `renderSpec(spec, store, registry, { onRenderError: (err, name) => { myErrorReporter.capture(err, { context: name }); }, });` | [`UIProviderOptions`](UIProviderOptions.md).[`onRenderError`](UIProviderOptions.md#property-onrendererror) | - |
28
- | <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. | - | [packages/play-dom/src/types.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/types.ts#L31) |
29
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @xmachines/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:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/types.ts#L41) |
28
+ | <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. | - | [packages/play-dom/src/types.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom/src/types.ts#L31) |
29
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @xmachines/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:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom/src/types.ts#L41) |
30
30
  | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions for inline field validation. Each function receives `(value, args?)` and returns `true` (valid) or `false` (invalid). Functions are available to component implementations via `ctx.ctx.validationFunctions` and should be passed as `customFunctions` to `runValidationCheck` / `runValidation` from `@xmachines/json-render-core`. Mirrors `customFunctions` in `ValidationProvider` from the framework renderers. The DOM renderer has no automatic `ValidationProvider` tree — validation must be invoked explicitly by component implementations. **Example** `import { runValidationCheck } from "@xmachines/json-render-core"; renderSpec(spec, store, registry, { validationFunctions: { isEven: (value) => typeof value === "number" && value % 2 === 0, phoneNumber: (value) => /^\+?[\d\s\-()]{7,}$/.test(String(value)), }, }); // Inside a ComponentFn: const MyField: ComponentFn<typeof catalog, "MyField"> = ({ ctx }) => { const result = runValidationCheck( { type: "isEven", message: "must be even" }, { value: someValue, stateModel: {}, customFunctions: ctx.ctx.validationFunctions }, ); // result.valid, result.message };` | [`UIProviderOptions`](UIProviderOptions.md).[`validationFunctions`](UIProviderOptions.md#property-validationfunctions) | - |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RenderSpecOptions
4
4
 
5
- Defined in: `.pnpm`
5
+ Defined in: `@xmachines/json-render-dom`
6
6
 
7
7
  Named options for [renderSpec](../functions/renderSpec.md).
8
8
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: UIProviderOptions
4
4
 
5
- Defined in: `.pnpm`
5
+ Defined in: `@xmachines/json-render-dom`
6
6
 
7
7
  Shared UI-provider options — the configurable rendering behaviours that sit
8
8
  above the core actor/registry wiring.
@@ -6,7 +6,7 @@
6
6
  type ActionFn<C, K> = (params, setState, state) => Promise<void>;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-dom`
10
10
 
11
11
  Catalog-typed action function — mirrors `ActionFn<C, K>` from @xmachines/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: `.pnpm`
9
+ Defined in: `@xmachines/json-render-dom`
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: `.pnpm`
9
+ Defined in: `@xmachines/json-render-dom`
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: `.pnpm`
44
+ Defined in: `@xmachines/json-render-dom`
45
45
 
46
46
  ---
47
47
 
@@ -51,7 +51,7 @@ Defined in: `.pnpm`
51
51
  children: Node[];
52
52
  ```
53
53
 
54
- Defined in: `.pnpm`
54
+ Defined in: `@xmachines/json-render-dom`
55
55
 
56
56
  ---
57
57
 
@@ -61,7 +61,7 @@ Defined in: `.pnpm`
61
61
  ctx: DomRenderContext;
62
62
  ```
63
63
 
64
- Defined in: `.pnpm`
64
+ Defined in: `@xmachines/json-render-dom`
65
65
 
66
66
  ---
67
67
 
@@ -71,7 +71,7 @@ Defined in: `.pnpm`
71
71
  emit: (event) => void;
72
72
  ```
73
73
 
74
- Defined in: `.pnpm`
74
+ Defined in: `@xmachines/json-render-dom`
75
75
 
76
76
  #### Parameters
77
77
 
@@ -91,7 +91,7 @@ Defined in: `.pnpm`
91
91
  on: (event) => EventHandle;
92
92
  ```
93
93
 
94
- Defined in: `.pnpm`
94
+ Defined in: `@xmachines/json-render-dom`
95
95
 
96
96
  #### Parameters
97
97
 
@@ -111,4 +111,4 @@ Defined in: `.pnpm`
111
111
  props: P;
112
112
  ```
113
113
 
114
- Defined in: `.pnpm`
114
+ Defined in: `@xmachines/json-render-dom`
@@ -10,7 +10,7 @@ type CatalogHasActions<C> = [InferCatalogActions<C>] extends [never]
10
10
  : true;
11
11
  ```
12
12
 
13
- Defined in: `.pnpm`
13
+ Defined in: `@xmachines/json-render-dom`
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: `.pnpm`
9
+ Defined in: `@xmachines/json-render-dom`
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: `.pnpm`
9
+ Defined in: `@xmachines/json-render-dom`
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  type ConfirmHandler = (confirm, action) => boolean | Promise<boolean>;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-dom`
10
10
 
11
11
  Hook consulted before executing an action binding that declares `confirm`.
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: `.pnpm`
9
+ Defined in: `@xmachines/json-render-dom`
10
10
 
11
11
  Options for `defineRegistry`.
12
12
 
@@ -6,7 +6,7 @@
6
6
  type DomComponentRenderer = (element, ctx) => HTMLElement | Text | null;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-dom`
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: `.pnpm`
9
+ Defined in: `@xmachines/json-render-dom`
@@ -6,4 +6,4 @@
6
6
  type DomSchema = typeof schema;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-dom`
@@ -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:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom/src/create-play-ui.ts#L69)
9
+ Defined in: [packages/play-dom/src/create-play-ui.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom/src/create-play-ui.ts#L69)
10
10
 
11
11
  The mount function returned by `createPlayUI`.
12
12
 
@@ -6,7 +6,7 @@
6
6
  type RenderErrorHandler = (error, elementType) => void;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-core`
10
10
 
11
11
  Callback invoked when an individual catalog component throws during render.
12
12
  Implemented by each framework renderer's error boundary / error capture mechanism.
@@ -6,7 +6,7 @@
6
6
  type SetState = (updater) => void;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-dom`
10
10
 
11
11
  Function to update the local state store.
12
12
 
@@ -52,7 +52,7 @@ const schema: _json_render_core.Schema<{
52
52
  }>;
53
53
  ```
54
54
 
55
- Defined in: `.pnpm`
55
+ Defined in: `@xmachines/json-render-dom`
56
56
 
57
57
  The schema for @xmachines/json-render-dom
58
58
 
@@ -11,13 +11,13 @@ Framework-agnostic router integration that synchronizes a Play actor's `currentR
11
11
  ## Installation
12
12
 
13
13
  ```bash
14
- npm install @xmachines/play-dom-router @xmachines/play-router @xmachines/play-actor
14
+ pnpm add @xmachines/play-dom-router @xmachines/play-router @xmachines/play-actor
15
15
  ```
16
16
 
17
17
  Peer dependency:
18
18
 
19
19
  ```bash
20
- npm install xstate@^5.31.0
20
+ pnpm add xstate@^5.31.0
21
21
  ```
22
22
 
23
23
  ## Overview
@@ -192,9 +192,9 @@ This package uses the [URLPattern API](https://developer.mozilla.org/en-US/docs/
192
192
  Run tests in isolation:
193
193
 
194
194
  ```bash
195
- npm test
195
+ pnpm test
196
196
  # or from monorepo root:
197
- npm test -w @xmachines/play-dom-router
197
+ pnpm --filter @xmachines/play-dom-router test
198
198
  ```
199
199
 
200
200
  Tests run in Node.js environment with `URLPattern` polyfill setup. Browser-specific tests are in `test/browser/` and run separately via `vitest.browser.config.ts`.
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [play-dom-router/src/connect-router.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/connect-router.ts#L51)
9
+ Defined in: [play-dom-router/src/connect-router.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/connect-router.ts#L51)
10
10
 
11
11
  Connect vanilla router to actor (pure browser integration).
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createBrowserHistory(options): BrowserHistory;
7
7
  ```
8
8
 
9
- Defined in: [play-dom-router/src/create-browser-history.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L120)
9
+ Defined in: [play-dom-router/src/create-browser-history.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L120)
10
10
 
11
11
  Create browser history that wraps window.history
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/create-route-map.ts#L45)
9
+ Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/create-route-map.ts#L45)
10
10
 
11
11
  Create a `RouteMap` from an XState state machine.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouter(options): VanillaRouter;
7
7
  ```
8
8
 
9
- Defined in: [play-dom-router/src/create-router.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-router.ts#L52)
9
+ Defined in: [play-dom-router/src/create-router.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-router.ts#L52)
10
10
 
11
11
  Create vanilla router for framework-agnostic routing.
12
12
 
@@ -2,17 +2,17 @@
2
2
 
3
3
  # Interface: BrowserHistory
4
4
 
5
- Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L1)
5
+ Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L1)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Modifier | Type | Description | Defined in |
10
10
  | ----------------------------------------- | ---------- | --------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-location"></a> `location` | `readonly` | `object` | Get current location state | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L5) |
12
- | `location.hash` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L8) |
13
- | `location.pathname` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L6) |
14
- | `location.search` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L7) |
15
- | `location.state` | `public` | `unknown` | - | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L9) |
11
+ | <a id="property-location"></a> `location` | `readonly` | `object` | Get current location state | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L5) |
12
+ | `location.hash` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L8) |
13
+ | `location.pathname` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L6) |
14
+ | `location.search` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L7) |
15
+ | `location.state` | `public` | `unknown` | - | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L9) |
16
16
 
17
17
  ## Methods
18
18
 
@@ -22,7 +22,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com
22
22
  back(): void;
23
23
  ```
24
24
 
25
- Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L26)
25
+ Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L26)
26
26
 
27
27
  #### Returns
28
28
 
@@ -36,7 +36,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.co
36
36
  createHref(path): string;
37
37
  ```
38
38
 
39
- Defined in: [play-dom-router/src/create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L38)
39
+ Defined in: [play-dom-router/src/create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L38)
40
40
 
41
41
  Create href from path
42
42
 
@@ -58,7 +58,7 @@ Create href from path
58
58
  destroy(): void;
59
59
  ```
60
60
 
61
- Defined in: [play-dom-router/src/create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L47)
61
+ Defined in: [play-dom-router/src/create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L47)
62
62
 
63
63
  Cleanup.
64
64
 
@@ -78,7 +78,7 @@ wrapper is destroyed.
78
78
  forward(): void;
79
79
  ```
80
80
 
81
- Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L27)
81
+ Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L27)
82
82
 
83
83
  #### Returns
84
84
 
@@ -92,7 +92,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.co
92
92
  go(delta): void;
93
93
  ```
94
94
 
95
- Defined in: [play-dom-router/src/create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L25)
95
+ Defined in: [play-dom-router/src/create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L25)
96
96
 
97
97
  Go back/forward
98
98
 
@@ -114,7 +114,7 @@ Go back/forward
114
114
  push(path, state?): void;
115
115
  ```
116
116
 
117
- Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L15)
117
+ Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L15)
118
118
 
119
119
  Push new URL to history
120
120
 
@@ -137,7 +137,7 @@ Push new URL to history
137
137
  replace(path, state?): void;
138
138
  ```
139
139
 
140
- Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L20)
140
+ Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L20)
141
141
 
142
142
  Replace current URL in history
143
143
 
@@ -160,7 +160,7 @@ Replace current URL in history
160
160
  subscribe(listener): () => void;
161
161
  ```
162
162
 
163
- Defined in: [play-dom-router/src/create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L33)
163
+ Defined in: [play-dom-router/src/create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-dom-router/src/create-browser-history.ts#L33)
164
164
 
165
165
  Subscribe to history changes
166
166
  Returns unsubscribe function