@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
@@ -22,7 +22,7 @@ npm install @xmachines/play-svelte
22
22
 
23
23
  ```svelte
24
24
  <script lang="ts">
25
- import { PlayRenderer, defineRegistry } from "@xmachines/play-svelte";
25
+ import { PlayUIProvider, PlayRenderer, defineRegistry } from "@xmachines/play-svelte";
26
26
  import { defineCatalog, schema } from "@json-render/core";
27
27
  import { z } from "zod";
28
28
  import Login from "./Login.svelte";
@@ -50,9 +50,19 @@ npm install @xmachines/play-svelte
50
50
  });
51
51
  </script>
52
52
 
53
- <PlayRenderer actor={actor} {registryResult} />
53
+ <PlayUIProvider {actor} {registryResult}>
54
+ <PlayRenderer />
55
+ </PlayUIProvider>
54
56
  ```
55
57
 
58
+ ## Primary Exports
59
+
60
+ - `PlayUIProvider` — batteries-included composite provider (wraps `ActorProvider` + `JSONUIProvider`); pass `actor` and `registryResult` here
61
+ - `ActorProvider` — escape hatch primitive for direct control over actor bridging and store lifecycle
62
+ - `PlayRenderer` — zero-prop leaf; renders inside a `PlayUIProvider` or `ActorProvider` tree
63
+ - `getActorContext()` — Svelte equivalent of `useActor()`; access the actor from inside a component rendered in the provider tree
64
+ - `getPlayViewContext()` — access the current view spec (`PlaySpec`) from inside the provider tree
65
+
56
66
  ## Re-exports
57
67
 
58
68
  This package re-exports from `@json-render/svelte`:
@@ -64,26 +74,27 @@ Types: `BaseComponentProps`, `ComponentFn`, `ComponentContext`, `RenderErrorHand
64
74
 
65
75
  For anything else (`schema`, `Renderer`, `JsonUIProvider`, context helpers), import from `@json-render/svelte` directly.
66
76
 
67
- ## PlayRenderer behavior
77
+ ## PlayUIProvider / PlayRenderer behavior
68
78
 
69
- - `PlayRenderer` watches `actor.currentView` and rerenders when the active view changes.
79
+ - `PlayUIProvider` owns actor bridging, signal observation, and store lifecycle. `PlayRenderer` is a zero-prop leaf that renders inside the provider tree.
80
+ - `PlayRenderer` watches `actor.currentView` (via provider context) and rerenders when the active view changes.
70
81
  - Action handlers are defined as async functions in `defineRegistry({ actions: { login: async (params) => actor.send(...) } })` and bundled in `registryResult`. There is no `actions` prop on `PlayRenderer`.
71
- - If you do not pass a `store`, `PlayRenderer` creates an internal `@xstate/store` atom from `view.spec.state`.
72
- - If you do pass a `store`, that external store wins and no internal store is created for the view.
82
+ - If you do not pass a `store` to `PlayUIProvider`, it creates an internal `@xstate/store` atom from `view.spec.state`.
83
+ - If you do pass a `store` to `PlayUIProvider`, that external store wins and no internal store is created for the view.
73
84
 
74
85
  ## Error handling
75
86
 
76
- `PlayRenderer` has two layers of error boundaries:
87
+ The provider tree has two layers of error boundaries:
77
88
 
78
89
  ### Outer boundary — `onError` and `fallback`
79
90
 
80
- Wraps the entire renderer. Triggered when the spec state or store setup throws, or when the inner boundary is not present.
91
+ Wraps the entire renderer. Triggered when the spec state or store setup throws, or when the inner boundary is not present. These props are passed to `PlayUIProvider` (or `ActorProvider`).
81
92
 
82
93
  - **`fallback`** — a Svelte snippet rendered when `currentView` is `null` or when the outer boundary catches an error.
83
94
  - **`onError`** — called when the outer boundary catches an error. Receives the error and a `reset` callback.
84
95
 
85
96
  ```svelte
86
- <PlayRenderer
97
+ <PlayUIProvider
87
98
  {actor}
88
99
  {registryResult}
89
100
  fallback={errorSnippet}
@@ -91,25 +102,29 @@ Wraps the entire renderer. Triggered when the spec state or store setup throws,
91
102
  console.error("Outer render error:", error);
92
103
  // reset(); // attempt recovery
93
104
  }}
94
- />
105
+ >
106
+ <PlayRenderer />
107
+ </PlayUIProvider>
95
108
  ```
96
109
 
97
110
  ### Inner boundary — `onRenderError`
98
111
 
99
112
  Each catalog element rendered by `@json-render/svelte` is individually wrapped in a `<svelte:boundary>`. When an element component throws, the failed component is silently removed from the DOM while the rest of the spec continues rendering. The outer `onError` / `fallback` are **not** triggered.
100
113
 
101
- Pass `onRenderError` to `PlayRenderer` (or to `defineRegistry`) to receive these per-element errors instead of the default `console.error` logging:
114
+ Pass `onRenderError` to `PlayUIProvider` (or `ActorProvider`) overrides any registry-level handler or bake it into `defineRegistry`. `PlayRenderer` no longer accepts this prop.
102
115
 
103
116
  ```svelte
104
- <!-- via PlayRenderer prop -->
105
- <PlayRenderer
117
+ <!-- via PlayUIProvider prop -->
118
+ <PlayUIProvider
106
119
  {actor}
107
120
  {registryResult}
108
121
  onRenderError={(error, elementType) => {
109
122
  console.warn(`<${elementType}> crashed:`, error);
110
123
  reportToSentry(error, { component: elementType });
111
124
  }}
112
- />
125
+ >
126
+ <PlayRenderer />
127
+ </PlayUIProvider>
113
128
  ```
114
129
 
115
130
  ```ts
@@ -123,48 +138,113 @@ const registryResult = defineRegistry(catalog, {
123
138
  });
124
139
  ```
125
140
 
126
- When both are provided, the `PlayRenderer` prop wins — it creates a fresh registry copy with its own handler for that render.
141
+ When both are provided, the `PlayUIProvider` prop wins — it creates a fresh registry copy with its own handler for that render.
127
142
 
128
143
  `onRenderError` is typed as `RenderErrorHandler` and exported from `@xmachines/play-svelte`.
129
144
 
130
145
  @xmachines/play-svelte - Svelte renderer for XMachines Play architecture
131
146
 
132
- Provides a thin Svelte rendering layer that passively observes actor signals
133
- and renders UI components via @json-render/svelte. Svelte reactivity is only
134
- used to trigger re-renders signals are the source of truth.
147
+ Provides a provider/renderer split that mirrors @json-render/svelte patterns:
148
+
149
+ - ActorProvider: primitive escape-hatch (owns actor lifecycle, signal subscription,
150
+ per-view StateStore, onRenderError injection)
151
+ - PlayUIProvider: batteries-included composite (ActorProvider + JsonUIProvider)
152
+ - PlayRenderer: zero-prop leaf — reads getPlayViewContext() and renders Renderer
135
153
 
136
- Re-exports `defineRegistry` (catalog-typed action params are inferred from
137
- the catalog schema), `getBoundProp`, `BaseComponentProps`, and `ComponentFn`
138
- from `@json-render/svelte` so consumers import everything from
139
- `@xmachines/play-svelte` rather than `@json-render/svelte` directly.
154
+ Re-exports primitives from @json-render/svelte so consumers import everything
155
+ from @xmachines/play-svelte rather than @json-render/svelte directly.
140
156
 
141
157
  ## Interfaces
142
158
 
159
+ - [ActorProviderProps](interfaces/ActorProviderProps.md)
143
160
  - [BaseComponentProps](interfaces/BaseComponentProps.md)
144
161
  - [ComponentContext](interfaces/ComponentContext.md)
145
162
  - [DefineRegistryOptions](interfaces/DefineRegistryOptions.md)
146
- - [PlayRendererProps](interfaces/PlayRendererProps.md)
163
+ - [ViewContextValue](interfaces/ViewContextValue.md)
147
164
 
148
165
  ## Type Aliases
149
166
 
150
167
  - [ActionFn](type-aliases/ActionFn.md)
151
168
  - [Actions](type-aliases/Actions.md)
152
169
  - [ComponentFn](type-aliases/ComponentFn.md)
170
+ - [PlayActor](type-aliases/PlayActor.md)
153
171
  - [PlayRenderer](type-aliases/PlayRenderer.md)
154
172
  - [RenderErrorHandler](type-aliases/RenderErrorHandler.md)
155
173
  - [SetState](type-aliases/SetState.md)
156
174
 
157
175
  ## Variables
158
176
 
159
- - [getBoundProp](variables/getBoundProp.md)
160
177
  - [PlayRenderer](variables/PlayRenderer.md)
161
178
 
162
179
  ## Functions
163
180
 
164
181
  - [defineRegistry](functions/defineRegistry.md)
182
+ - [getActorContext](functions/getActorContext.md)
183
+ - [getPlayViewContext](functions/getPlayViewContext.md)
184
+ - [setActorContext](functions/setActorContext.md)
165
185
 
166
186
  ## References
167
187
 
188
+ ### ActionProvider
189
+
190
+ Renames and re-exports [PlayRenderer](variables/PlayRenderer.md)
191
+
192
+ ---
193
+
194
+ ### ActorProvider
195
+
196
+ Renames and re-exports [PlayRenderer](variables/PlayRenderer.md)
197
+
198
+ ---
199
+
200
+ ### getBoundProp
201
+
202
+ Renames and re-exports [RenderErrorHandler](type-aliases/RenderErrorHandler.md)
203
+
204
+ ---
205
+
168
206
  ### getStateValue
169
207
 
170
- Renames and re-exports [getBoundProp](variables/getBoundProp.md)
208
+ Renames and re-exports [RenderErrorHandler](type-aliases/RenderErrorHandler.md)
209
+
210
+ ---
211
+
212
+ ### JsonUIProvider
213
+
214
+ Renames and re-exports [PlayRenderer](variables/PlayRenderer.md)
215
+
216
+ ---
217
+
218
+ ### JSONUIProviderProps
219
+
220
+ Renames and re-exports [RenderErrorHandler](type-aliases/RenderErrorHandler.md)
221
+
222
+ ---
223
+
224
+ ### PlayUIProvider
225
+
226
+ Renames and re-exports [PlayRenderer](variables/PlayRenderer.md)
227
+
228
+ ---
229
+
230
+ ### Renderer
231
+
232
+ Renames and re-exports [PlayRenderer](variables/PlayRenderer.md)
233
+
234
+ ---
235
+
236
+ ### StateProvider
237
+
238
+ Renames and re-exports [PlayRenderer](variables/PlayRenderer.md)
239
+
240
+ ---
241
+
242
+ ### ValidationProvider
243
+
244
+ Renames and re-exports [PlayRenderer](variables/PlayRenderer.md)
245
+
246
+ ---
247
+
248
+ ### VisibilityProvider
249
+
250
+ Renames and re-exports [PlayRenderer](variables/PlayRenderer.md)
@@ -6,7 +6,7 @@
6
6
  function defineRegistry<C>(catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/define-registry.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/define-registry.ts#L152)
9
+ Defined in: [packages/play-svelte/src/define-registry.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte/src/define-registry.ts#L153)
10
10
 
11
11
  Create a component registry, restoring catalog-typed `params` on action handlers.
12
12
 
@@ -0,0 +1,21 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / getActorContext
2
+
3
+ # Function: getActorContext()
4
+
5
+ ```ts
6
+ function getActorContext(): PlayActor;
7
+ ```
8
+
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte/src/actor-context.svelte.ts#L37)
10
+
11
+ Get the actor from the nearest ActorProvider ancestor.
12
+
13
+ Renamed from useActor() to match @json-render/svelte's get\*Context() convention (D-07).
14
+
15
+ ## Returns
16
+
17
+ [`PlayActor`](../type-aliases/PlayActor.md)
18
+
19
+ ## Throws
20
+
21
+ if called outside <ActorProvider> or <PlayUIProvider>
@@ -0,0 +1,19 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / getPlayViewContext
2
+
3
+ # Function: getPlayViewContext()
4
+
5
+ ```ts
6
+ function getPlayViewContext(): ViewContextValue;
7
+ ```
8
+
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte/src/actor-context.svelte.ts#L58)
10
+
11
+ Get the current view context from the nearest ActorProvider ancestor.
12
+
13
+ ## Returns
14
+
15
+ [`ViewContextValue`](../interfaces/ViewContextValue.md)
16
+
17
+ ## Throws
18
+
19
+ if called outside <ActorProvider> or <PlayUIProvider>
@@ -0,0 +1,19 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / setActorContext
2
+
3
+ # Function: setActorContext()
4
+
5
+ ```ts
6
+ function setActorContext(actor): void;
7
+ ```
8
+
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte/src/actor-context.svelte.ts#L27)
10
+
11
+ ## Parameters
12
+
13
+ | Parameter | Type |
14
+ | --------- | ------------------------------------------- |
15
+ | `actor` | [`PlayActor`](../type-aliases/PlayActor.md) |
16
+
17
+ ## Returns
18
+
19
+ `void`
@@ -0,0 +1,40 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / ActorProviderProps
2
+
3
+ # Interface: ActorProviderProps
4
+
5
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte/src/actor-context.svelte.ts#L67)
6
+
7
+ Framework-agnostic base props shared by every `ActorProvider` implementation
8
+ (React, Vue, Solid, Svelte). `TRegistry` captures the framework-specific
9
+ `DefineRegistryResult` type; `RenderErrorHandler` is sourced from
10
+ `@json-render/core` so no second generic is needed.
11
+
12
+ Framework packages extend this with their `fallback`, `onError`, and `children` fields.
13
+
14
+ ## Example
15
+
16
+ ```ts
17
+ import type { BaseActorProviderProps } from "@xmachines/play-actor";
18
+ import type { DefineRegistryResult } from "@json-render/react";
19
+
20
+ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult> {
21
+ fallback?: React.ReactNode;
22
+ children: React.ReactNode;
23
+ }
24
+ ```
25
+
26
+ ## Extends
27
+
28
+ - [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md)\<`DefineRegistryResult`\>
29
+
30
+ ## Properties
31
+
32
+ | Property | Type | Description | Inherited from | Defined in |
33
+ | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
34
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L154) |
35
+ | <a id="property-children"></a> `children` | `Snippet` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte/src/actor-context.svelte.ts#L70) |
36
+ | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte/src/actor-context.svelte.ts#L68) |
37
+ | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte/src/actor-context.svelte.ts#L69) |
38
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../../play-dom/type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L167) |
39
+ | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L156) |
40
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L162) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DefineRegistryOptions\<C\>
4
4
 
5
- Defined in: [packages/play-svelte/src/define-registry.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/define-registry.ts#L91)
5
+ Defined in: [packages/play-svelte/src/define-registry.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte/src/define-registry.ts#L92)
6
6
 
7
7
  Options for `defineRegistry`.
8
8
 
@@ -17,8 +17,8 @@ Mirrors the upstream shape but replaces the untyped
17
17
 
18
18
  ## Properties
19
19
 
20
- | Property | Type | Description | Defined in |
21
- | ---------------------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22
- | <a id="property-actions"></a> `actions?` | [`Actions`](../type-aliases/Actions.md)\<`C`\> | Catalog-typed action handler map. Each handler receives `params` typed to the exact schema defined in the catalog action (or `undefined` if no params were provided), plus the upstream `setState` and `state` arguments. Guard against `undefined` before accessing params: **Example** `actions: { login: async (params) => { if (!params) return; actor.send({ type: "auth.login", username: params.username }); }, logout: async () => actor.send({ type: "auth.logout" }), }` | [packages/play-svelte/src/define-registry.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/define-registry.ts#L115) |
23
- | <a id="property-components"></a> `components?` | `Components`\<`C`\> | Svelte component implementations — keyed by catalog component name. | [packages/play-svelte/src/define-registry.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/define-registry.ts#L95) |
24
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Callback invoked when a catalog component throws during render. The error is caught by `@json-render/svelte`'s inner `<svelte:boundary>` that wraps each rendered element. When provided, this callback replaces the default `console.error(...)` fallback — the component is silently removed from the DOM and your callback receives the error and the element type name for custom error reporting or recovery logic. **Example** `const { registry, handlers } = defineRegistry(authCatalog, { components: { Login, Dashboard }, actions: { ... }, onRenderError(error, elementType) { console.warn(`Component <${elementType}> crashed:`, error); reportToSentry(error, { componentType: elementType }); }, });` **Param** The thrown value (not necessarily an `Error` instance). **Param** The catalog component name that crashed (e.g. `"Dashboard"`). | [packages/play-svelte/src/define-registry.ts:140](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte/src/define-registry.ts#L140) |
20
+ | Property | Type | Description | Defined in |
21
+ | ---------------------------------------------------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22
+ | <a id="property-actions"></a> `actions?` | [`Actions`](../type-aliases/Actions.md)\<`C`\> | Catalog-typed action handler map. Each handler receives `params` typed to the exact schema defined in the catalog action (or `undefined` if no params were provided), plus the upstream `setState` and `state` arguments. Guard against `undefined` before accessing params: **Example** `actions: { login: async (params) => { if (!params) return; actor.send({ type: "auth.login", username: params.username }); }, logout: async () => actor.send({ type: "auth.logout" }), }` | [packages/play-svelte/src/define-registry.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte/src/define-registry.ts#L116) |
23
+ | <a id="property-components"></a> `components?` | `Components`\<`C`\> | Svelte component implementations — keyed by catalog component name. | [packages/play-svelte/src/define-registry.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte/src/define-registry.ts#L96) |
24
+ | <a id="property-onrendererror"></a> `onRenderError?` | `any` | Callback invoked when a catalog component throws during render. The error is caught by `@json-render/svelte`'s inner `<svelte:boundary>` that wraps each rendered element. When provided, this callback replaces the default `console.error(...)` fallback — the component is silently removed from the DOM and your callback receives the error and the element type name for custom error reporting or recovery logic. **Example** `const { registry, handlers } = defineRegistry(authCatalog, { components: { Login, Dashboard }, actions: { ... }, onRenderError(error, elementType) { console.warn(`Component <${elementType}> crashed:`, error); reportToSentry(error, { componentType: elementType }); }, });` **Param** The thrown value (not necessarily an `Error` instance). **Param** The catalog component name that crashed (e.g. `"Dashboard"`). | [packages/play-svelte/src/define-registry.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte/src/define-registry.ts#L141) |
@@ -0,0 +1,24 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / ViewContextValue
2
+
3
+ # Interface: ViewContextValue
4
+
5
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte/src/actor-context.svelte.ts#L46)
6
+
7
+ Framework-agnostic base for every framework's `ViewContextValue`.
8
+
9
+ Holds the three fields that are identical across React, Vue, Solid, and Svelte.
10
+ `registry` is framework-specific (each framework has its own `ComponentRegistry`
11
+ type) so it is typed via `TRegistry` — the same generic used in `BaseActorProviderProps`.
12
+
13
+ ## Extends
14
+
15
+ - [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md)\<`ComponentRegistry`\>
16
+
17
+ ## Properties
18
+
19
+ | Property | Type | Description | Inherited from | Defined in |
20
+ | ----------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | <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) |
22
+ | <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) |
23
+ | <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) |
24
+ | <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,9 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / PlayActor
2
+
3
+ # Type Alias: PlayActor
4
+
5
+ ```ts
6
+ type PlayActor = AbstractActor<AnyActorLogic> & Viewable;
7
+ ```
8
+
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte/src/actor-context.svelte.ts#L21)
@@ -3,21 +3,5 @@
3
3
  # Type Alias: RenderErrorHandler
4
4
 
5
5
  ```ts
6
- type RenderErrorHandler = (error, elementType) => void;
6
+ type RenderErrorHandler = any;
7
7
  ```
8
-
9
- Defined in: `@json-render/svelte`
10
-
11
- Registry of component renderers.
12
- Maps component type names to Svelte components.
13
-
14
- ## Parameters
15
-
16
- | Parameter | Type |
17
- | ------------- | --------- |
18
- | `error` | `unknown` |
19
- | `elementType` | `string` |
20
-
21
- ## Returns
22
-
23
- `void`
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L100)
5
+ Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/base-route-map.ts#L100)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -50,7 +50,7 @@ map.getPathByStateId("missing"); // null
50
50
  new RouteMap(mappings, options?): BaseRouteMap;
51
51
  ```
52
52
 
53
- 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)
53
+ 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)
54
54
 
55
55
  Build a route map from an array of state ID ↔ path mappings.
56
56
 
@@ -78,7 +78,7 @@ buckets for efficient candidate selection.
78
78
  getPathByStateId(stateId): string | null;
79
79
  ```
80
80
 
81
- 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)
81
+ 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)
82
82
 
83
83
  Look up the path pattern registered for a state ID.
84
84
 
@@ -109,7 +109,7 @@ map.getPathByStateId("missing"); // null
109
109
  getStateIdByPath(path): string | null;
110
110
  ```
111
111
 
112
- 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)
112
+ 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)
113
113
 
114
114
  Resolve a URL path to its mapped state ID.
115
115
 
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [play-svelte-spa-router/src/connect-router.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte-spa-router/src/connect-router.ts#L30)
9
+ Defined in: [play-svelte-spa-router/src/connect-router.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte-spa-router/src/connect-router.ts#L30)
10
10
 
11
11
  Connect svelte-spa-router to actor.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/create-route-map-from-machine.ts#L26)
9
+ Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/create-route-map-from-machine.ts#L26)
10
10
 
11
11
  Create a `BaseRouteMap` from an XState state machine.
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ConnectRouterOptions
4
4
 
5
- Defined in: [play-svelte-spa-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte-spa-router/src/connect-router.ts#L7)
5
+ Defined in: [play-svelte-spa-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte-spa-router/src/connect-router.ts#L7)
6
6
 
7
7
  @xmachines/play-svelte-spa-router
8
8
 
@@ -12,6 +12,6 @@ Svelte SPA router adapter for XMachines Play architecture.
12
12
 
13
13
  | Property | Modifier | Type | Description | Defined in |
14
14
  | ----------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
- | <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) | - | [play-svelte-spa-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte-spa-router/src/connect-router.ts#L8) |
16
- | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-svelte-spa-router/src/connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte-spa-router/src/connect-router.ts#L9) |
17
- | <a id="property-window"></a> `window?` | `readonly` | [`WindowLike`](WindowLike.md) | Window-like object for `hashchange` subscriptions. Defaults to the global `window`. Pass a mock in tests or a no-op in SSR environments. | [play-svelte-spa-router/src/connect-router.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-svelte-spa-router/src/connect-router.ts#L14) |
15
+ | <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) | - | [play-svelte-spa-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte-spa-router/src/connect-router.ts#L8) |
16
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-svelte-spa-router/src/connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte-spa-router/src/connect-router.ts#L9) |
17
+ | <a id="property-window"></a> `window?` | `readonly` | [`WindowLike`](WindowLike.md) | Window-like object for `hashchange` subscriptions. Defaults to the global `window`. Pass a mock in tests or a no-op in SSR environments. | [play-svelte-spa-router/src/connect-router.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-svelte-spa-router/src/connect-router.ts#L14) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L223)
5
+ Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/types.ts#L223)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -112,8 +112,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
112
112
 
113
113
  | Property | Modifier | Type | Defined in |
114
114
  | -------------------------------------- | ---------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
115
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L228) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L226) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L227) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L225) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L224) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/types.ts#L228) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/types.ts#L226) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/types.ts#L227) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/types.ts#L225) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/types.ts#L224) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L57)
5
+ Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/base-route-map.ts#L57)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: BaseRouteMapping = { stateId: "settings", path: "/setting
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L61) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L59) |
26
+ | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/base-route-map.ts#L61) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/base-route-map.ts#L59) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L271)
5
+ Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/types.ts#L271)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L287)
57
+ Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/types.ts#L287)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L303)
86
+ Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/types.ts#L303)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89