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

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 (366) 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 -10
  6. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  7. package/api/@xmachines/play-actor/functions/typedSpec.md +7 -10
  8. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +46 -0
  9. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +33 -0
  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 +4 -4
  13. package/api/@xmachines/play-dom/README.md +98 -15
  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 +28 -0
  17. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  18. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  19. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  20. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +9 -9
  21. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +19 -11
  22. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +29 -0
  23. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +6 -6
  24. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +14 -14
  25. package/api/@xmachines/play-dom/interfaces/EventHandle.md +6 -6
  26. package/api/@xmachines/play-dom/interfaces/MountOptions.md +14 -0
  27. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +7 -7
  28. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +27 -0
  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 +4 -4
  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 +25 -0
  40. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +23 -0
  41. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  42. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  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 +1 -1
  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/RouteMap.md +3 -3
  52. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  53. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  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/README.md +165 -48
  58. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  59. package/api/@xmachines/play-react/functions/ActionProvider.md +21 -0
  60. package/api/@xmachines/play-react/functions/JSONUIProvider.md +21 -0
  61. package/api/@xmachines/play-react/functions/Renderer.md +21 -0
  62. package/api/@xmachines/play-react/functions/StateProvider.md +27 -0
  63. package/api/@xmachines/play-react/functions/ValidationProvider.md +21 -0
  64. package/api/@xmachines/play-react/functions/VisibilityProvider.md +21 -0
  65. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  66. package/api/@xmachines/play-react/functions/usePlayView.md +32 -0
  67. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  68. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +15 -0
  69. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +27 -0
  70. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +21 -0
  71. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  72. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  73. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +26 -0
  74. package/api/@xmachines/play-react/interfaces/RendererProps.md +17 -0
  75. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +16 -0
  76. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +14 -0
  77. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +20 -0
  78. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +13 -0
  79. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  80. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +3 -2
  81. package/api/@xmachines/play-react/variables/ActorProvider.md +33 -0
  82. package/api/@xmachines/play-react/variables/PlayRenderer.md +5 -50
  83. package/api/@xmachines/play-react/variables/PlayUIProvider.md +43 -0
  84. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  85. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  86. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  87. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  88. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  89. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  90. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  91. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  92. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  93. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  94. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  95. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  96. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  97. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  98. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  99. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  100. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  101. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  102. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  103. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  104. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  105. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  106. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  107. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  108. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  109. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  110. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  111. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  112. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  113. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  114. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  115. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  116. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  117. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  118. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  119. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  120. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  121. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  122. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  123. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  124. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  125. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  126. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  127. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  128. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  129. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  130. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  131. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  132. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  133. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  134. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  135. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  136. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  137. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  138. package/api/@xmachines/play-solid/README.md +158 -42
  139. package/api/@xmachines/play-solid/functions/ActionProvider.md +19 -0
  140. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +21 -0
  141. package/api/@xmachines/play-solid/functions/Renderer.md +21 -0
  142. package/api/@xmachines/play-solid/functions/StateProvider.md +19 -0
  143. package/api/@xmachines/play-solid/functions/ValidationProvider.md +19 -0
  144. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +20 -0
  145. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  146. package/api/@xmachines/play-solid/functions/useAction.md +24 -0
  147. package/api/@xmachines/play-solid/functions/useActions.md +13 -0
  148. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  149. package/api/@xmachines/play-solid/functions/useFieldValidation.md +29 -0
  150. package/api/@xmachines/play-solid/functions/useIsVisible.md +19 -0
  151. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +13 -0
  152. package/api/@xmachines/play-solid/functions/usePlayView.md +30 -0
  153. package/api/@xmachines/play-solid/functions/useStateBinding.md +25 -0
  154. package/api/@xmachines/play-solid/functions/useStateStore.md +13 -0
  155. package/api/@xmachines/play-solid/functions/useStateValue.md +25 -0
  156. package/api/@xmachines/play-solid/functions/useVisibility.md +13 -0
  157. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +12 -0
  158. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +30 -0
  159. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +15 -0
  160. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +21 -0
  161. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +26 -0
  162. package/api/@xmachines/play-solid/interfaces/RendererProps.md +17 -0
  163. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +13 -0
  164. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +11 -0
  165. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +21 -0
  166. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +17 -0
  167. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  168. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +3 -2
  169. package/api/@xmachines/play-solid/type-aliases/SetState.md +21 -0
  170. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +9 -0
  171. package/api/@xmachines/play-solid/variables/ActorContext.md +13 -0
  172. package/api/@xmachines/play-solid/variables/ActorProvider.md +27 -0
  173. package/api/@xmachines/play-solid/variables/PlayRenderer.md +5 -18
  174. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +26 -0
  175. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  176. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  177. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  178. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  179. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  180. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  181. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  182. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  183. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  184. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  185. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  186. package/api/@xmachines/play-svelte/README.md +105 -25
  187. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  188. package/api/@xmachines/play-svelte/functions/getActorContext.md +21 -0
  189. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +19 -0
  190. package/api/@xmachines/play-svelte/functions/setActorContext.md +19 -0
  191. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +40 -0
  192. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -6
  193. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +24 -0
  194. package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +9 -0
  195. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +1 -17
  196. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  197. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  198. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  199. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  200. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  201. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  202. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  203. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  204. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  205. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  206. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  207. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  208. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  209. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  210. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  211. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  212. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  213. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  214. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  215. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  216. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  217. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  218. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  219. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  220. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  221. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  222. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  223. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  224. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  225. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  226. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  227. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  228. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  229. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  230. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  231. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  232. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  233. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  234. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  235. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  236. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  237. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  238. package/api/@xmachines/play-vue/README.md +136 -40
  239. package/api/@xmachines/play-vue/functions/defineRegistry.md +2 -2
  240. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +28 -0
  241. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  242. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +12 -0
  243. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +25 -0
  244. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +15 -0
  245. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +20 -0
  246. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +24 -0
  247. package/api/@xmachines/play-vue/interfaces/RendererProps.md +17 -0
  248. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +15 -0
  249. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +11 -0
  250. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +21 -0
  251. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  252. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  253. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  254. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  255. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +3 -2
  256. package/api/@xmachines/play-vue/variables/ActionProvider.md +64 -0
  257. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +96 -0
  258. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  259. package/api/@xmachines/play-vue/variables/Renderer.md +79 -0
  260. package/api/@xmachines/play-vue/variables/StateProvider.md +79 -0
  261. package/api/@xmachines/play-vue/variables/ValidationProvider.md +55 -0
  262. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +40 -0
  263. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  264. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  265. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  266. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  267. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  268. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  269. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  270. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  271. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  272. package/api/@xmachines/play-xstate/classes/PlayerActor.md +24 -24
  273. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  274. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  275. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  276. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  277. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  278. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  279. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  280. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  281. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  282. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  283. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  284. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  285. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  286. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  287. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  288. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  289. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  290. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  291. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  292. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  293. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  294. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  295. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  296. package/api/_media/README.md +98 -15
  297. package/examples/@xmachines/play-dom-demo/README.md +42 -22
  298. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  299. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  300. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  301. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  302. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  303. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  304. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  305. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  306. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  307. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  308. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  309. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  310. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  311. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  312. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  313. package/examples/@xmachines/play-react-demo/README.md +53 -46
  314. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  315. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  316. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  317. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  318. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  319. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  320. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  321. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  322. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  323. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  324. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  325. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  326. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  327. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  328. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  329. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  330. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  331. package/examples/@xmachines/play-solid-demo/README.md +53 -34
  332. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  333. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  334. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  335. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  336. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  337. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  338. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  339. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  340. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  341. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  342. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  343. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  344. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  345. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  346. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  347. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  348. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  349. package/examples/@xmachines/play-svelte-demo/README.md +23 -20
  350. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +8 -10
  351. package/examples/@xmachines/play-sveltekit-router-demo/README.md +10 -12
  352. package/examples/@xmachines/play-vue-demo/README.md +55 -37
  353. package/examples/form-validation.md +33 -42
  354. package/guides/README.md +8 -0
  355. package/guides/actor-model.md +180 -0
  356. package/guides/getting-started.md +18 -14
  357. package/guides/signals.md +166 -0
  358. package/guides/state-machines.md +288 -0
  359. package/package.json +2 -2
  360. package/rfc/play.md +62 -35
  361. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +0 -17
  362. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +0 -24
  363. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +0 -24
  364. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +0 -22
  365. package/api/@xmachines/play-svelte/variables/getBoundProp.md +0 -7
  366. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +0 -22
@@ -0,0 +1,21 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-react](../README.md) / JSONUIProviderProps
2
+
3
+ # Interface: JSONUIProviderProps
4
+
5
+ Defined in: `@json-render/react`
6
+
7
+ Props for JSONUIProvider
8
+
9
+ ## Properties
10
+
11
+ | Property | Type | Description | Defined in |
12
+ | ---------------------------------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ---------- |
13
+ | <a id="property-children"></a> `children` | `ReactNode` | - | - |
14
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Named functions for `$computed` expressions in props | - |
15
+ | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, (`params`) => `unknown`\> | Action handlers | - |
16
+ | <a id="property-initialstate"></a> `initialState?` | `Record`\<`string`, `unknown`\> | Initial state model (uncontrolled mode) | - |
17
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function | - |
18
+ | <a id="property-onstatechange"></a> `onStateChange?` | (`changes`) => `void` | Callback when state changes (uncontrolled mode) | - |
19
+ | <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry | - |
20
+ | <a id="property-store"></a> `store?` | `StateStore` | External store (controlled mode). When provided, `initialState` and `onStateChange` are ignored. | - |
21
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions | - |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayErrorBoundaryProps
4
4
 
5
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/PlayErrorBoundary.tsx#L14)
5
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayErrorBoundary.tsx#L14)
6
6
 
7
7
  Props for PlayErrorBoundary
8
8
 
@@ -10,6 +10,6 @@ Props for PlayErrorBoundary
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ------------------------------------------ | --------------------------- | --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-children"></a> `children` | `ReactNode` | Child components to render | [packages/play-react/src/PlayErrorBoundary.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/PlayErrorBoundary.tsx#L18) |
14
- | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Fallback UI to render when a child component throws. Defaults to null. | [packages/play-react/src/PlayErrorBoundary.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/PlayErrorBoundary.tsx#L16) |
15
- | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | Optional error handler callback — forwards errors to observability tools (Sentry, etc.) | [packages/play-react/src/PlayErrorBoundary.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/PlayErrorBoundary.tsx#L20) |
13
+ | <a id="property-children"></a> `children` | `ReactNode` | Child components to render | [packages/play-react/src/PlayErrorBoundary.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayErrorBoundary.tsx#L18) |
14
+ | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Fallback UI to render when a child component throws. Defaults to null. | [packages/play-react/src/PlayErrorBoundary.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayErrorBoundary.tsx#L16) |
15
+ | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | Optional error handler callback — forwards errors to observability tools (Sentry, etc.) | [packages/play-react/src/PlayErrorBoundary.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayErrorBoundary.tsx#L20) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayErrorBoundaryState
4
4
 
5
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/PlayErrorBoundary.tsx#L28)
5
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayErrorBoundary.tsx#L28)
6
6
 
7
7
  Internal state shape for PlayErrorBoundary
8
8
 
@@ -10,5 +10,5 @@ Internal state shape for PlayErrorBoundary
10
10
 
11
11
  | Property | Type | Defined in |
12
12
  | ----------------------------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-error"></a> `error` | `Error` \| `null` | [packages/play-react/src/PlayErrorBoundary.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/PlayErrorBoundary.tsx#L30) |
14
- | <a id="property-haserror"></a> `hasError` | `boolean` | [packages/play-react/src/PlayErrorBoundary.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/PlayErrorBoundary.tsx#L29) |
13
+ | <a id="property-error"></a> `error` | `Error` \| `null` | [packages/play-react/src/PlayErrorBoundary.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayErrorBoundary.tsx#L30) |
14
+ | <a id="property-haserror"></a> `hasError` | `boolean` | [packages/play-react/src/PlayErrorBoundary.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayErrorBoundary.tsx#L29) |
@@ -0,0 +1,26 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-react](../README.md) / PlayUIProviderProps
2
+
3
+ # Interface: PlayUIProviderProps
4
+
5
+ Defined in: [packages/play-react/src/PlayUIProvider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayUIProvider.tsx#L34)
6
+
7
+ Props for PlayUIProvider — all ActorProvider props plus JSONUIProvider's own props.
8
+
9
+ ## Extends
10
+
11
+ - [`ActorProviderProps`](ActorProviderProps.md).`Partial`\<`JSONUIForwardedProps`\>
12
+
13
+ ## Properties
14
+
15
+ | Property | Type | Description | Inherited from | Defined in |
16
+ | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L154) |
18
+ | <a id="property-children"></a> `children` | `ReactNode` | Child components to render inside the provider tree | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-react/src/ActorProvider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/ActorProvider.tsx#L37) |
19
+ | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Optional component shown when currentView is null or a catalog component throws | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-react/src/ActorProvider.tsx:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/ActorProvider.tsx#L33) |
20
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Named functions for `$computed` expressions in props | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`functions`](JSONUIProviderProps.md#property-functions) | - |
21
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`navigate`](JSONUIProviderProps.md#property-navigate) | - |
22
+ | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | Optional error handler callback invoked when a catalog component throws during render | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-react/src/ActorProvider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/ActorProvider.tsx#L35) |
23
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L167) |
24
+ | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L156) |
25
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L162) |
26
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`validationFunctions`](JSONUIProviderProps.md#property-validationfunctions) | - |
@@ -0,0 +1,17 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-react](../README.md) / RendererProps
2
+
3
+ # Interface: RendererProps
4
+
5
+ Defined in: `@json-render/react`
6
+
7
+ Props for the Renderer component
8
+
9
+ ## Properties
10
+
11
+ | Property | Type | Description | Defined in |
12
+ | ---------------------------------------------------- | ------------------------------------------------------ | --------------------------------------------------------------- | ---------- |
13
+ | <a id="property-fallback"></a> `fallback?` | `ComponentRenderer`\<`Record`\<`string`, `unknown`\>\> | Fallback component for unknown types | - |
14
+ | <a id="property-loading"></a> `loading?` | `boolean` | Whether the spec is currently loading/streaming | - |
15
+ | <a id="property-onrendererror"></a> `onRenderError?` | `any` | Callback for element render errors caught by the inner boundary | - |
16
+ | <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry | - |
17
+ | <a id="property-spec"></a> `spec` | `Spec` \| `null` | The UI spec to render | - |
@@ -0,0 +1,16 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-react](../README.md) / StateProviderProps
2
+
3
+ # Interface: StateProviderProps
4
+
5
+ Defined in: `@json-render/react`
6
+
7
+ Props for StateProvider
8
+
9
+ ## Properties
10
+
11
+ | Property | Type | Description | Defined in |
12
+ | ---------------------------------------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
13
+ | <a id="property-children"></a> `children` | `ReactNode` | - | - |
14
+ | <a id="property-initialstate"></a> `initialState?` | `StateModel` | Initial state model (used only in uncontrolled mode) | - |
15
+ | <a id="property-onstatechange"></a> `onStateChange?` | (`changes`) => `void` | Callback when state changes (used only in uncontrolled mode). Called once per `set` or `update` with all changed entries. | - |
16
+ | <a id="property-store"></a> `store?` | `StateStore` | External store that owns the state. When provided, the provider operates in **controlled mode** — `initialState` and `onStateChange` are ignored and the store is the single source of truth. | - |
@@ -0,0 +1,14 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-react](../README.md) / ValidationProviderProps
2
+
3
+ # Interface: ValidationProviderProps
4
+
5
+ Defined in: `@json-render/react`
6
+
7
+ Props for ValidationProvider
8
+
9
+ ## Properties
10
+
11
+ | Property | Type | Description | Defined in |
12
+ | -------------------------------------------------------- | ------------------------------------------ | ---------------------------------------- | ---------- |
13
+ | <a id="property-children"></a> `children` | `ReactNode` | - | - |
14
+ | <a id="property-customfunctions"></a> `customFunctions?` | `Record`\<`string`, `ValidationFunction`\> | Custom validation functions from catalog | - |
@@ -0,0 +1,20 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-react](../README.md) / ViewContextValue
2
+
3
+ # Interface: ViewContextValue
4
+
5
+ Defined in: [packages/play-react/src/ActorProvider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/ActorProvider.tsx#L45)
6
+
7
+ Value provided by ViewContext (accessible via usePlayView()).
8
+
9
+ ## Extends
10
+
11
+ - [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md)\<`ComponentRegistry`\>
12
+
13
+ ## Properties
14
+
15
+ | Property | Type | Description | Inherited from | Defined in |
16
+ | ----------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L122) |
18
+ | <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L124) |
19
+ | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L120) |
20
+ | <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L126) |
@@ -0,0 +1,13 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-react](../README.md) / VisibilityProviderProps
2
+
3
+ # Interface: VisibilityProviderProps
4
+
5
+ Defined in: `@json-render/react`
6
+
7
+ Props for VisibilityProvider
8
+
9
+ ## Properties
10
+
11
+ | Property | Type | Defined in |
12
+ | ----------------------------------------- | ----------- | ---------- |
13
+ | <a id="property-children"></a> `children` | `ReactNode` | - |
@@ -6,4 +6,4 @@
6
6
  type PlayActor = AbstractActor<AnyActorLogic>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/useActor.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/useActor.ts#L26)
9
+ Defined in: [packages/play-react/src/useActor.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/useActor.ts#L27)
@@ -6,9 +6,10 @@
6
6
  type RenderErrorHandler = (error, elementType) => void;
7
7
  ```
8
8
 
9
- Defined in: `@json-render/react`
9
+ Defined in: `@json-render/core`
10
10
 
11
- Registry of component renderers
11
+ Callback invoked when an individual catalog component throws during render.
12
+ Implemented by each framework renderer's error boundary / error capture mechanism.
12
13
 
13
14
  ## Parameters
14
15
 
@@ -0,0 +1,33 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-react](../README.md) / ActorProvider
2
+
3
+ # Variable: ActorProvider
4
+
5
+ ```ts
6
+ const ActorProvider: React.FC<ActorProviderProps>;
7
+ ```
8
+
9
+ Defined in: [packages/play-react/src/ActorProvider.tsx:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/ActorProvider.tsx#L151)
10
+
11
+ ActorProvider — escape hatch primitive for composing actor lifecycle with custom providers.
12
+
13
+ Subscribes to actor.currentView signal, manages the per-view StateStore lifecycle,
14
+ wraps children in StateProvider and PlayErrorBoundary, and injects onRenderError
15
+ into the component registry.
16
+
17
+ Standard usage: prefer <PlayUIProvider> unless you need to compose providers manually.
18
+
19
+ ## Example
20
+
21
+ ```tsx
22
+ // Custom composition (escape hatch):
23
+ <ActorProvider actor={actor} registryResult={registryResult}>
24
+ <JSONUIProvider registry={registryResult.registry}>
25
+ <PlayRenderer />
26
+ </JSONUIProvider>
27
+ </ActorProvider>
28
+
29
+ // Standard usage: prefer PlayUIProvider
30
+ <PlayUIProvider actor={actor} registryResult={registryResult}>
31
+ <PlayRenderer />
32
+ </PlayUIProvider>
33
+ ```
@@ -3,57 +3,12 @@
3
3
  # Variable: PlayRenderer
4
4
 
5
5
  ```ts
6
- const PlayRenderer: React.FC<PlayRendererProps>;
6
+ const PlayRenderer: React.FC;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/PlayRenderer.tsx:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react/src/PlayRenderer.tsx#L116)
9
+ Defined in: [packages/play-react/src/PlayRenderer.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayRenderer.tsx#L39)
10
10
 
11
- Main renderer component that subscribes to actor signals and renders UI
12
- via @json-render/react Renderer.
11
+ Zero-prop leaf component that renders the current actor view.
13
12
 
14
- Architecture:
15
-
16
- - Subscribes to actor.currentView signal via useSignalEffect
17
- - Renders view.spec via StateProvider → ActionProvider → VisibilityProvider → Renderer
18
- - Routes actions via registryResult.handlers() — real async functions dispatching to actor.
19
- - State store: uses external `store` prop if provided (controlled mode); otherwise
20
- creates a fresh @xstate/store atom per view transition seeded from spec.state.
21
- The atom resets automatically when the actor transitions to a new view, mirroring
22
- the actor's currentView lifecycle.
23
-
24
- Invariant: Actor Authority - Actor decides all state transitions via guards.
25
- Invariant: Passive Infrastructure - Component observes signals and sends events.
26
- Invariant: Signal-Only Reactivity - Business logic state lives in actor signals.
27
-
28
- ## Example
29
-
30
- ```typescript
31
- import { PlayRenderer } from "@xmachines/play-react";
32
- import { defineRegistry } from "@json-render/react";
33
-
34
- const registryResult = defineRegistry(catalog, {
35
- components: { Login, Dashboard },
36
- actions: {
37
- login: async ({ username }) => actor.send({ type: 'auth.login', username }),
38
- logout: async () => actor.send({ type: 'auth.logout' }),
39
- route: async ({ to, params }) => actor.send({ type: 'play.route', to, params }),
40
- },
41
- });
42
-
43
- // Uncontrolled — fresh atom created per view, seeded from spec.state:
44
- <PlayRenderer actor={actor} registryResult={registryResult} />
45
-
46
- // Controlled — caller provides and owns the store:
47
- import { createAtom } from "@xstate/store";
48
- import { xstateStoreStateStore } from "@json-render/xstate";
49
- const store = xstateStoreStateStore({ atom: createAtom({ username: "" }) });
50
- <PlayRenderer actor={actor} registryResult={registryResult} store={store} />
51
- ```
52
-
53
- ## Param
54
-
55
- Component props
56
-
57
- ## Returns
58
-
59
- React element rendering current view from actor
13
+ Reads the current PlaySpec, handlers, and registry from the ActorProvider
14
+ context via usePlayView(), then renders via @json-render/react Renderer.
@@ -0,0 +1,43 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-react](../README.md) / PlayUIProvider
2
+
3
+ # Variable: PlayUIProvider
4
+
5
+ ```ts
6
+ const PlayUIProvider: React.FC<PlayUIProviderProps>;
7
+ ```
8
+
9
+ Defined in: [packages/play-react/src/PlayUIProvider.tsx:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayUIProvider.tsx#L102)
10
+
11
+ PlayUIProvider — batteries-included entry point for actor-driven UI rendering.
12
+
13
+ Combines actor lifecycle management (ActorProvider) with full UI provider setup
14
+ (JSONUIProvider including ActionProvider, ValidationProvider, VisibilityProvider,
15
+ StateProvider, and ConfirmDialogManager).
16
+
17
+ ## Example
18
+
19
+ ```tsx
20
+ import { PlayUIProvider, PlayRenderer } from "@xmachines/play-react";
21
+
22
+ const registryResult = defineRegistry(catalog, {
23
+ components: { Login, Dashboard },
24
+ actions: {
25
+ login: async ({ username }) => actor.send({ type: 'auth.login', username }),
26
+ logout: async () => actor.send({ type: 'auth.logout' }),
27
+ },
28
+ });
29
+
30
+ <PlayUIProvider actor={actor} registryResult={registryResult}>
31
+ <PlayRenderer />
32
+ </PlayUIProvider>
33
+
34
+ // With JSONUIProvider options:
35
+ <PlayUIProvider
36
+ actor={actor}
37
+ registryResult={registryResult}
38
+ navigate={(path) => router.push(path)}
39
+ validationFunctions={{ isEmail: (v) => /^.+@.+$/.test(String(v)) }}
40
+ >
41
+ <PlayRenderer />
42
+ </PlayUIProvider>
43
+ ```
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: ReactRouterBridge
4
4
 
5
- Defined in: [play-react-router/src/react-router-bridge.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react-router/src/react-router-bridge.ts#L28)
5
+ Defined in: [play-react-router/src/react-router-bridge.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/react-router-bridge.ts#L28)
6
6
 
7
7
  Abstract base class for all `@xmachines` router adapter bridges.
8
8
 
@@ -25,7 +25,7 @@ new ReactRouterBridge(
25
25
  routeMap): ReactRouterBridge;
26
26
  ```
27
27
 
28
- Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react-router/src/react-router-bridge.ts#L31)
28
+ Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/react-router-bridge.ts#L31)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -47,15 +47,15 @@ Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com
47
47
 
48
48
  | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
49
49
  | --------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
50
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L99) |
51
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L87) |
52
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L86) |
53
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L89) |
54
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L88) |
55
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L100) |
56
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L102) |
57
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L101) |
58
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L90) |
50
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L99) |
51
+ | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L87) |
52
+ | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L86) |
53
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L89) |
54
+ | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L88) |
55
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L100) |
56
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L102) |
57
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L101) |
58
+ | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L90) |
59
59
 
60
60
  ## Methods
61
61
 
@@ -65,7 +65,7 @@ Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com
65
65
  connect(): void;
66
66
  ```
67
67
 
68
- Defined in: [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L126)
68
+ Defined in: [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L126)
69
69
 
70
70
  Connect the router bridge to the Actor.
71
71
 
@@ -97,7 +97,7 @@ Adapters that need custom initial-sync behavior should override
97
97
  disconnect(): void;
98
98
  ```
99
99
 
100
- Defined in: [play-router/src/router-bridge-base.ts:214](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L214)
100
+ Defined in: [play-router/src/router-bridge-base.ts:214](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L214)
101
101
 
102
102
  Disconnect the router bridge from the Actor.
103
103
 
@@ -119,7 +119,7 @@ Stops signal watching and unregisters framework-specific router listener.
119
119
  protected extractParams(pathname, stateId): Record<string, string>;
120
120
  ```
121
121
 
122
- Defined in: [play-router/src/router-bridge-base.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L322)
122
+ Defined in: [play-router/src/router-bridge-base.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L322)
123
123
 
124
124
  Extract path parameters from URL using the URLPattern API.
125
125
 
@@ -157,7 +157,7 @@ When URLPattern is absent and the route is parameterized
157
157
  protected extractQuery(search): Record<string, string>;
158
158
  ```
159
159
 
160
- Defined in: [play-router/src/router-bridge-base.ts:359](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L359)
160
+ Defined in: [play-router/src/router-bridge-base.ts:359](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L359)
161
161
 
162
162
  Extract query parameters from URL search string.
163
163
 
@@ -185,7 +185,7 @@ Extracted query parameters or empty object
185
185
  protected getInitialRouterPath(): string | null;
186
186
  ```
187
187
 
188
- Defined in: [play-react-router/src/react-router-bridge.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react-router/src/react-router-bridge.ts#L49)
188
+ Defined in: [play-react-router/src/react-router-bridge.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/react-router-bridge.ts#L49)
189
189
 
190
190
  Return the router's current pathname so connect() can sync the actor to
191
191
  the URL on initial load. router.subscribe() only fires on future navigations
@@ -208,7 +208,7 @@ the page on /about would leave the actor in its default "home" state.
208
208
  protected getInitialRouterSearch(): string | undefined;
209
209
  ```
210
210
 
211
- Defined in: [play-react-router/src/react-router-bridge.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react-router/src/react-router-bridge.ts#L60)
211
+ Defined in: [play-react-router/src/react-router-bridge.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/react-router-bridge.ts#L60)
212
212
 
213
213
  Return the initial URL search string for query-param forwarding on `connect()`.
214
214
 
@@ -232,7 +232,7 @@ so `syncActorFromRouter` produces `query: {}` rather than parsing an empty strin
232
232
  protected navigateRouter(path): void;
233
233
  ```
234
234
 
235
- Defined in: [play-react-router/src/react-router-bridge.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react-router/src/react-router-bridge.ts#L39)
235
+ Defined in: [play-react-router/src/react-router-bridge.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/react-router-bridge.ts#L39)
236
236
 
237
237
  Navigate the framework router to the given path.
238
238
 
@@ -261,7 +261,7 @@ Must trigger the framework router's navigation (e.g., router.navigate(path)).
261
261
  protected resolveNavigationPath(route): string | null;
262
262
  ```
263
263
 
264
- Defined in: [play-router/src/router-bridge-base.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L344)
264
+ Defined in: [play-router/src/router-bridge-base.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L344)
265
265
 
266
266
  Resolve an actor route value to a concrete URL path for navigation.
267
267
 
@@ -300,7 +300,7 @@ Concrete URL path, or `null` if navigation should be skipped
300
300
  protected syncActorFromRouter(pathname, search?): void;
301
301
  ```
302
302
 
303
- Defined in: [play-router/src/router-bridge-base.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L264)
303
+ Defined in: [play-router/src/router-bridge-base.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L264)
304
304
 
305
305
  Sync actor state when router location changes.
306
306
 
@@ -330,7 +330,7 @@ Prevents circular updates via isProcessingNavigation flag.
330
330
  protected syncRouterFromActor(route): void;
331
331
  ```
332
332
 
333
- Defined in: [play-router/src/router-bridge-base.ts:244](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L244)
333
+ Defined in: [play-router/src/router-bridge-base.ts:244](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L244)
334
334
 
335
335
  Sync router location when actor route signal changes.
336
336
 
@@ -363,7 +363,7 @@ suppressed as circular echoes.
363
363
  protected unwatchRouterChanges(): void;
364
364
  ```
365
365
 
366
- Defined in: [play-react-router/src/react-router-bridge.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react-router/src/react-router-bridge.ts#L70)
366
+ Defined in: [play-react-router/src/react-router-bridge.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/react-router-bridge.ts#L70)
367
367
 
368
368
  Stop watching for router location changes.
369
369
 
@@ -385,7 +385,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
385
385
  protected watchRouterChanges(): void;
386
386
  ```
387
387
 
388
- Defined in: [play-react-router/src/react-router-bridge.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react-router/src/react-router-bridge.ts#L64)
388
+ Defined in: [play-react-router/src/react-router-bridge.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/react-router-bridge.ts#L64)
389
389
 
390
390
  Start watching for router location changes.
391
391
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-react-router/src/route-map.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react-router/src/route-map.ts#L12)
5
+ Defined in: [play-react-router/src/route-map.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/route-map.ts#L12)
6
6
 
7
7
  Bidirectional route mapper for React Router.
8
8
 
@@ -20,7 +20,7 @@ Alias for [BaseRouteMap](../../play-dom-router/interfaces/RouteMap.md) from `@xm
20
20
  new RouteMap(mappings, options?): RouteMap;
21
21
  ```
22
22
 
23
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L125)
23
+ Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/base-route-map.ts#L125)
24
24
 
25
25
  Build a route map from an array of state ID ↔ path mappings.
26
26
 
@@ -54,7 +54,7 @@ BaseRouteMap.constructor;
54
54
  getPathByStateId(stateId): string | null;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L209)
57
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/base-route-map.ts#L209)
58
58
 
59
59
  Look up the path pattern registered for a state ID.
60
60
 
@@ -89,7 +89,7 @@ map.getPathByStateId("missing"); // null
89
89
  getStateIdByPath(path): string | null;
90
90
  ```
91
91
 
92
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L174)
92
+ Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/base-route-map.ts#L174)
93
93
 
94
94
  Resolve a URL path to its mapped state ID.
95
95
 
@@ -6,7 +6,7 @@
6
6
  function PlayRouterProvider<TActor>(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: [play-react-router/src/play-router-provider.tsx:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-react-router/src/play-router-provider.tsx#L47)
9
+ Defined in: [play-react-router/src/play-router-provider.tsx:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/play-router-provider.tsx#L48)
10
10
 
11
11
  Connects a `PlayerActor` to React Router, keeping actor state and browser URL
12
12
  in sync bidirectionally.