@xmachines/docs 1.0.0-beta.43 → 1.0.0-beta.45

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 (432) hide show
  1. package/api/@xmachines/play/README.md +5 -5
  2. package/api/@xmachines/play/classes/NonNullableError.md +5 -5
  3. package/api/@xmachines/play/classes/PlayError.md +5 -5
  4. package/api/@xmachines/play/functions/assertNonNullable.md +2 -2
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +4 -4
  6. package/api/@xmachines/play-actor/README.md +7 -7
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +4 -4
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +2 -2
  9. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +6 -6
  10. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +6 -6
  11. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Routable.md +4 -4
  13. package/api/@xmachines/play-actor/interfaces/Viewable.md +3 -3
  14. package/api/@xmachines/play-dom/README.md +3 -2
  15. package/api/@xmachines/play-dom/classes/PlayRenderer.md +5 -5
  16. package/api/@xmachines/play-dom/functions/connectRenderer.md +2 -2
  17. package/api/@xmachines/play-dom/functions/createPlayUI.md +2 -2
  18. package/api/@xmachines/play-dom/functions/createRenderer.md +2 -2
  19. package/api/@xmachines/play-dom/functions/defineRegistry.md +2 -2
  20. package/api/@xmachines/play-dom/functions/renderSpec.md +2 -2
  21. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +8 -8
  22. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +14 -14
  23. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +7 -7
  24. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +5 -5
  25. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +13 -13
  26. package/api/@xmachines/play-dom/interfaces/EventHandle.md +5 -5
  27. package/api/@xmachines/play-dom/interfaces/MountOptions.md +4 -4
  28. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +6 -6
  29. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +6 -6
  30. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +2 -2
  31. package/api/@xmachines/play-dom/type-aliases/Actions.md +2 -2
  32. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +8 -8
  33. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +2 -2
  34. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +2 -2
  35. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +2 -2
  36. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +3 -3
  37. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +2 -2
  38. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +2 -2
  39. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +2 -2
  40. package/api/@xmachines/play-dom/type-aliases/MountFn.md +2 -2
  41. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/SetState.md +2 -2
  43. package/api/@xmachines/play-dom/variables/schema.md +2 -2
  44. package/api/@xmachines/play-dom-router/README.md +13 -11
  45. package/api/@xmachines/play-dom-router/functions/connectRouter.md +2 -2
  46. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +2 -2
  47. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +9 -8
  48. package/api/@xmachines/play-dom-router/functions/createRouter.md +3 -3
  49. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +15 -15
  50. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +15 -15
  51. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +5 -5
  52. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +8 -8
  53. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +4 -4
  54. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +4 -4
  55. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +13 -0
  56. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +4 -4
  57. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +5 -5
  58. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +5 -5
  59. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +2 -2
  60. package/api/@xmachines/play-react/README.md +10 -4
  61. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
  62. package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
  63. package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
  64. package/api/@xmachines/play-react/functions/Renderer.md +1 -1
  65. package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
  66. package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
  67. package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
  68. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  69. package/api/@xmachines/play-react/functions/useActor.md +2 -2
  70. package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
  71. package/api/@xmachines/play-react/functions/usePlayView.md +2 -2
  72. package/api/@xmachines/play-react/functions/useSignalEffect.md +2 -2
  73. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
  74. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +9 -9
  75. package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
  76. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +1 -1
  77. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +5 -5
  78. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
  79. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +9 -9
  80. package/api/@xmachines/play-react/interfaces/RendererProps.md +1 -1
  81. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
  82. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
  83. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +6 -6
  84. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
  85. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
  86. package/api/@xmachines/play-react/type-aliases/PlayActor.md +2 -2
  87. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
  88. package/api/@xmachines/play-react/variables/ActorProvider.md +2 -2
  89. package/api/@xmachines/play-react/variables/PlayRenderer.md +2 -2
  90. package/api/@xmachines/play-react/variables/PlayUIProvider.md +2 -2
  91. package/api/@xmachines/play-react-router/README.md +13 -7
  92. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +34 -30
  93. package/api/@xmachines/play-react-router/classes/RouteMap.md +5 -5
  94. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +2 -2
  95. package/api/@xmachines/play-react-router/functions/createRouteMap.md +25 -7
  96. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +12 -11
  97. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +8 -8
  98. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +8 -8
  99. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +13 -0
  100. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +4 -4
  101. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +5 -5
  102. package/api/@xmachines/play-router/README.md +14 -13
  103. package/api/@xmachines/play-router/classes/RouteMap.md +5 -5
  104. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +38 -34
  105. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +2 -2
  106. package/api/@xmachines/play-router/functions/buildRouteTree.md +2 -2
  107. package/api/@xmachines/play-router/functions/createRouteMap.md +22 -36
  108. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +12 -11
  109. package/api/@xmachines/play-router/functions/createRouteMatcher.md +53 -0
  110. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +2 -2
  111. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +2 -2
  112. package/api/@xmachines/play-router/functions/extractQuery.md +2 -2
  113. package/api/@xmachines/play-router/functions/extractRouteParams.md +2 -2
  114. package/api/@xmachines/play-router/functions/findRouteById.md +2 -2
  115. package/api/@xmachines/play-router/functions/findRouteByPath.md +2 -2
  116. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +2 -2
  117. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +2 -2
  118. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +2 -2
  119. package/api/@xmachines/play-router/functions/isRouteReachable.md +2 -2
  120. package/api/@xmachines/play-router/functions/machineToGraph.md +2 -2
  121. package/api/@xmachines/play-router/functions/routeExists.md +2 -2
  122. package/api/@xmachines/play-router/functions/sanitizePathname.md +2 -2
  123. package/api/@xmachines/play-router/functions/validateRouteFormat.md +2 -2
  124. package/api/@xmachines/play-router/functions/validateStateExists.md +2 -2
  125. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +5 -5
  126. package/api/@xmachines/play-router/interfaces/LocationLike.md +4 -4
  127. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +4 -4
  128. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +6 -6
  129. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +8 -8
  130. package/api/@xmachines/play-router/interfaces/RouteInfo.md +9 -9
  131. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +13 -0
  132. package/api/@xmachines/play-router/interfaces/RouteMapping.md +4 -4
  133. package/api/@xmachines/play-router/interfaces/RouteMatch.md +4 -4
  134. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +9 -9
  135. package/api/@xmachines/play-router/interfaces/RouteNode.md +13 -13
  136. package/api/@xmachines/play-router/interfaces/RouteObject.md +3 -3
  137. package/api/@xmachines/play-router/interfaces/RouteTree.md +6 -6
  138. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +4 -4
  139. package/api/@xmachines/play-router/interfaces/RouterBridge.md +5 -5
  140. package/api/@xmachines/play-router/interfaces/WindowLike.md +4 -4
  141. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +2 -2
  142. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +2 -2
  143. package/api/@xmachines/play-signals/README.md +3 -3
  144. package/api/@xmachines/play-signals/functions/watchSignal.md +2 -2
  145. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +3 -3
  146. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +3 -3
  147. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +3 -3
  148. package/api/@xmachines/play-signals/interfaces/SignalState.md +4 -4
  149. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +5 -5
  150. package/api/@xmachines/play-signals/namespaces/Signal/README.md +1 -1
  151. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +1 -1
  152. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +1 -1
  153. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
  154. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/README.md +1 -1
  155. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +1 -1
  156. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
  157. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
  158. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
  159. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
  160. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
  161. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
  162. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
  163. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
  164. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
  165. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
  166. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
  167. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +2 -2
  168. package/api/@xmachines/play-solid/README.md +11 -5
  169. package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
  170. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
  171. package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
  172. package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
  173. package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
  174. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
  175. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  176. package/api/@xmachines/play-solid/functions/useAction.md +1 -1
  177. package/api/@xmachines/play-solid/functions/useActions.md +1 -1
  178. package/api/@xmachines/play-solid/functions/useActor.md +2 -2
  179. package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
  180. package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
  181. package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
  182. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
  183. package/api/@xmachines/play-solid/functions/usePlayView.md +2 -2
  184. package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
  185. package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
  186. package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
  187. package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
  188. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
  189. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +9 -9
  190. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
  191. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
  192. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +1 -1
  193. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +9 -9
  194. package/api/@xmachines/play-solid/interfaces/RendererProps.md +1 -1
  195. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
  196. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
  197. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +6 -6
  198. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
  199. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -1
  200. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +2 -2
  201. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
  202. package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
  203. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
  204. package/api/@xmachines/play-solid/variables/ActorContext.md +2 -2
  205. package/api/@xmachines/play-solid/variables/ActorProvider.md +2 -2
  206. package/api/@xmachines/play-solid/variables/PlayRenderer.md +2 -2
  207. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +2 -2
  208. package/api/@xmachines/play-solid-router/README.md +18 -13
  209. package/api/@xmachines/play-solid-router/classes/RouteMap.md +5 -5
  210. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +35 -31
  211. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +2 -2
  212. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +9 -8
  213. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +4 -4
  214. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +8 -8
  215. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +6 -6
  216. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +13 -0
  217. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +4 -4
  218. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +5 -5
  219. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +2 -2
  220. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +5 -5
  221. package/api/@xmachines/play-svelte/README.md +9 -2
  222. package/api/@xmachines/play-svelte/functions/defineRegistry.md +2 -2
  223. package/api/@xmachines/play-svelte/functions/getActorContext.md +2 -2
  224. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +2 -2
  225. package/api/@xmachines/play-svelte/functions/setActorContext.md +2 -2
  226. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +13 -9
  227. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +1 -1
  228. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
  229. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +5 -5
  230. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +43 -0
  231. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +6 -6
  232. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +1 -1
  233. package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
  234. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
  235. package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +2 -2
  236. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
  237. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +1 -1
  238. package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
  239. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
  240. package/api/@xmachines/play-svelte-spa-router/README.md +7 -1
  241. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +5 -5
  242. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +2 -2
  243. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +9 -8
  244. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +5 -5
  245. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +8 -8
  246. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +13 -0
  247. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +4 -4
  248. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +5 -5
  249. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +4 -4
  250. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +2 -2
  251. package/api/@xmachines/play-sveltekit-router/README.md +8 -2
  252. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +5 -5
  253. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +2 -2
  254. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +9 -8
  255. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +5 -5
  256. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +4 -4
  257. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +8 -8
  258. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +13 -0
  259. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +4 -4
  260. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +5 -5
  261. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +2 -2
  262. package/api/@xmachines/play-tanstack-react-router/README.md +15 -9
  263. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +5 -5
  264. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +34 -30
  265. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +2 -2
  266. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +25 -7
  267. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +12 -11
  268. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +2 -2
  269. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +8 -8
  270. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +8 -8
  271. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +13 -0
  272. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +4 -4
  273. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +4 -4
  274. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +5 -5
  275. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +2 -2
  276. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  277. package/api/@xmachines/play-tanstack-solid-router/README.md +17 -11
  278. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +5 -5
  279. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +35 -31
  280. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +2 -2
  281. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +9 -8
  282. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +8 -8
  283. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +6 -6
  284. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +13 -0
  285. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +4 -4
  286. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +5 -5
  287. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +2 -2
  288. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +2 -2
  289. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  290. package/api/@xmachines/play-vue/README.md +12 -6
  291. package/api/@xmachines/play-vue/functions/defineRegistry.md +2 -2
  292. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +2 -2
  293. package/api/@xmachines/play-vue/functions/useActor.md +2 -2
  294. package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
  295. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
  296. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +6 -6
  297. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
  298. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
  299. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +1 -1
  300. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +9 -9
  301. package/api/@xmachines/play-vue/interfaces/RendererProps.md +1 -1
  302. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
  303. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
  304. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +6 -6
  305. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +5 -0
  306. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +2 -2
  307. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
  308. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +2 -2
  309. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +3 -3
  310. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +2 -2
  311. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
  312. package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
  313. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +1 -1
  314. package/api/@xmachines/play-vue/variables/PlayRenderer.md +2 -2
  315. package/api/@xmachines/play-vue/variables/Renderer.md +1 -1
  316. package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
  317. package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
  318. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
  319. package/api/@xmachines/play-vue-router/README.md +18 -13
  320. package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
  321. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +41 -31
  322. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +26 -6
  323. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +8 -8
  324. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +13 -0
  325. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  326. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +5 -5
  327. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +2 -2
  328. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +2 -2
  329. package/api/@xmachines/play-xstate/README.md +11 -11
  330. package/api/@xmachines/play-xstate/classes/PlayerActor.md +14 -14
  331. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +2 -2
  332. package/api/@xmachines/play-xstate/functions/composeGuards.md +2 -2
  333. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +2 -2
  334. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +5 -3
  335. package/api/@xmachines/play-xstate/functions/definePlayer.md +3 -3
  336. package/api/@xmachines/play-xstate/functions/deriveRoute.md +3 -3
  337. package/api/@xmachines/play-xstate/functions/eventMatches.md +2 -2
  338. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +2 -2
  339. package/api/@xmachines/play-xstate/functions/hasContext.md +2 -2
  340. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +2 -2
  341. package/api/@xmachines/play-xstate/functions/negateGuard.md +2 -2
  342. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +4 -4
  343. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +3 -3
  344. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
  345. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +6 -6
  346. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +2 -2
  347. package/api/@xmachines/play-xstate/type-aliases/Guard.md +2 -2
  348. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +2 -2
  349. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +2 -2
  350. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +5 -5
  351. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +5 -5
  352. package/api/@xmachines/shared/README.md +1 -1
  353. package/api/@xmachines/shared/vite-aliases/README.md +1 -1
  354. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +2 -2
  355. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +2 -2
  356. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +2 -2
  357. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +2 -2
  358. package/api/@xmachines/shared/vitest/README.md +1 -1
  359. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +2 -2
  360. package/api/llms.txt +2 -2
  361. package/examples/@xmachines/play-dom-demo/README.md +4 -4
  362. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +2 -2
  363. package/examples/@xmachines/play-dom-demo/functions/initShell.md +2 -2
  364. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +2 -2
  365. package/examples/@xmachines/play-dom-demo/variables/About.md +2 -2
  366. package/examples/@xmachines/play-dom-demo/variables/Contact.md +2 -2
  367. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +2 -2
  368. package/examples/@xmachines/play-dom-demo/variables/Home.md +2 -2
  369. package/examples/@xmachines/play-dom-demo/variables/Login.md +2 -2
  370. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +2 -2
  371. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +2 -2
  372. package/examples/@xmachines/play-dom-demo/variables/Overview.md +2 -2
  373. package/examples/@xmachines/play-dom-demo/variables/Profile.md +2 -2
  374. package/examples/@xmachines/play-dom-demo/variables/Settings.md +2 -2
  375. package/examples/@xmachines/play-dom-demo/variables/Stats.md +2 -2
  376. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +2 -2
  377. package/examples/@xmachines/play-dom-router-demo/README.md +5 -5
  378. package/examples/@xmachines/play-react-demo/README.md +4 -4
  379. package/examples/@xmachines/play-react-demo/functions/App.md +2 -2
  380. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +2 -2
  381. package/examples/@xmachines/play-react-demo/variables/About.md +2 -2
  382. package/examples/@xmachines/play-react-demo/variables/Contact.md +2 -2
  383. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +2 -2
  384. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +2 -2
  385. package/examples/@xmachines/play-react-demo/variables/Home.md +2 -2
  386. package/examples/@xmachines/play-react-demo/variables/Login.md +2 -2
  387. package/examples/@xmachines/play-react-demo/variables/NavBar.md +2 -2
  388. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +2 -2
  389. package/examples/@xmachines/play-react-demo/variables/Navigation.md +2 -2
  390. package/examples/@xmachines/play-react-demo/variables/Overview.md +2 -2
  391. package/examples/@xmachines/play-react-demo/variables/Profile.md +2 -2
  392. package/examples/@xmachines/play-react-demo/variables/Settings.md +2 -2
  393. package/examples/@xmachines/play-react-demo/variables/Shell.md +2 -2
  394. package/examples/@xmachines/play-react-demo/variables/Stats.md +2 -2
  395. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +2 -2
  396. package/examples/@xmachines/play-react-router-demo/README.md +4 -4
  397. package/examples/@xmachines/play-solid-demo/README.md +4 -4
  398. package/examples/@xmachines/play-solid-demo/functions/App.md +2 -2
  399. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +2 -2
  400. package/examples/@xmachines/play-solid-demo/variables/About.md +2 -2
  401. package/examples/@xmachines/play-solid-demo/variables/Contact.md +2 -2
  402. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +2 -2
  403. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +2 -2
  404. package/examples/@xmachines/play-solid-demo/variables/Home.md +2 -2
  405. package/examples/@xmachines/play-solid-demo/variables/Login.md +2 -2
  406. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +2 -2
  407. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +2 -2
  408. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +2 -2
  409. package/examples/@xmachines/play-solid-demo/variables/Overview.md +2 -2
  410. package/examples/@xmachines/play-solid-demo/variables/Profile.md +2 -2
  411. package/examples/@xmachines/play-solid-demo/variables/Settings.md +2 -2
  412. package/examples/@xmachines/play-solid-demo/variables/Shell.md +2 -2
  413. package/examples/@xmachines/play-solid-demo/variables/Stats.md +2 -2
  414. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +2 -2
  415. package/examples/@xmachines/play-solid-router-demo/README.md +5 -5
  416. package/examples/@xmachines/play-svelte-demo/README.md +3 -3
  417. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
  418. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +2 -2
  419. package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
  420. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +2 -2
  421. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +4 -4
  422. package/examples/@xmachines/play-sveltekit-router-demo/README.md +4 -4
  423. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +5 -5
  424. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +6 -6
  425. package/examples/@xmachines/play-vue-demo/README.md +4 -4
  426. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +2 -2
  427. package/examples/@xmachines/play-vue-demo/variables/App.md +2 -2
  428. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +2 -2
  429. package/examples/@xmachines/play-vue-router-demo/README.md +4 -4
  430. package/package.json +2 -2
  431. package/rfc/play.md +1 -1
  432. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +0 -38
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / getPlayViewContext
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / getPlayViewContext
2
2
 
3
3
  # Function: getPlayViewContext()
4
4
 
@@ -6,7 +6,7 @@
6
6
  function getPlayViewContext(): ViewContextValue;
7
7
  ```
8
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.43/packages/play-svelte/src/actor-context.svelte.ts#L58)
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-svelte/src/actor-context.svelte.ts#L58)
10
10
 
11
11
  Get the current view context from the nearest ActorProvider ancestor.
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / setActorContext
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / setActorContext
2
2
 
3
3
  # Function: setActorContext()
4
4
 
@@ -6,7 +6,7 @@
6
6
  function setActorContext(actor): void;
7
7
  ```
8
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.43/packages/play-svelte/src/actor-context.svelte.ts#L27)
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-svelte/src/actor-context.svelte.ts#L27)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / ActorProviderProps
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / ActorProviderProps
2
2
 
3
3
  # Interface: ActorProviderProps
4
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.43/packages/play-svelte/src/actor-context.svelte.ts#L67)
5
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-svelte/src/actor-context.svelte.ts#L67)
6
6
 
7
7
  Framework-agnostic base props shared by every `ActorProvider` implementation
8
8
  (React, Vue, Solid, Svelte). `TRegistry` captures the framework-specific
@@ -27,14 +27,18 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
27
27
 
28
28
  - [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md)\<`DefineRegistryResult`\>
29
29
 
30
+ ## Extended by
31
+
32
+ - [`PlayUIProviderProps`](PlayUIProviderProps.md)
33
+
30
34
  ## Properties
31
35
 
32
36
  | Property | Type | Description | Inherited from | Defined in |
33
37
  | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
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.43/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.43/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.43/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.43/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.43/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.43/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.43/packages/play-actor/src/abstract-actor.ts#L162) |
38
+ | <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.45/packages/play-actor/src/abstract-actor.ts#L154) |
39
+ | <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.45/packages/play-svelte/src/actor-context.svelte.ts#L70) |
40
+ | <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.45/packages/play-svelte/src/actor-context.svelte.ts#L68) |
41
+ | <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.45/packages/play-svelte/src/actor-context.svelte.ts#L69) |
42
+ | <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.45/packages/play-actor/src/abstract-actor.ts#L167) |
43
+ | <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.45/packages/play-actor/src/abstract-actor.ts#L156) |
44
+ | <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.45/packages/play-actor/src/abstract-actor.ts#L162) |
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / BaseComponentProps
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / BaseComponentProps
2
2
 
3
3
  # Interface: BaseComponentProps\<P\>
4
4
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / ComponentContext
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / ComponentContext
2
2
 
3
3
  # Interface: ComponentContext\<C, K\>
4
4
 
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / DefineRegistryOptions
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / DefineRegistryOptions
2
2
 
3
3
  # Interface: DefineRegistryOptions\<C\>
4
4
 
5
- Defined in: [packages/play-svelte/src/define-registry.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-svelte/src/define-registry.ts#L92)
5
+ Defined in: [packages/play-svelte/src/define-registry.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-svelte/src/define-registry.ts#L92)
6
6
 
7
7
  Options for `defineRegistry`.
8
8
 
@@ -19,6 +19,6 @@ Mirrors the upstream shape but replaces the untyped
19
19
 
20
20
  | Property | Type | Description | Defined in |
21
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.43/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.43/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.43/packages/play-svelte/src/define-registry.ts#L141) |
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.45/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.45/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.45/packages/play-svelte/src/define-registry.ts#L141) |
@@ -0,0 +1,43 @@
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / PlayUIProviderProps
2
+
3
+ # Interface: PlayUIProviderProps
4
+
5
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-svelte/src/actor-context.svelte.ts#L77)
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
+ - [`ActorProviderProps`](ActorProviderProps.md)
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). | [`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.45/packages/play-actor/src/abstract-actor.ts#L154) |
35
+ | <a id="property-children"></a> `children` | `Snippet` | - | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-svelte/src/actor-context.svelte.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-svelte/src/actor-context.svelte.ts#L70) |
36
+ | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | - | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-svelte/src/actor-context.svelte.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-svelte/src/actor-context.svelte.ts#L68) |
37
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `unknown`\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-svelte/src/actor-context.svelte.ts#L83) |
38
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-svelte/src/actor-context.svelte.ts#L82) |
39
+ | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | - | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-svelte/src/actor-context.svelte.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-svelte/src/actor-context.svelte.ts#L69) |
40
+ | <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. | [`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.45/packages/play-actor/src/abstract-actor.ts#L167) |
41
+ | <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.45/packages/play-actor/src/abstract-actor.ts#L156) |
42
+ | <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.45/packages/play-actor/src/abstract-actor.ts#L162) |
43
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-svelte/src/actor-context.svelte.ts#L78) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / ViewContextValue
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / ViewContextValue
2
2
 
3
3
  # Interface: ViewContextValue
4
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.43/packages/play-svelte/src/actor-context.svelte.ts#L46)
5
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-svelte/src/actor-context.svelte.ts#L46)
6
6
 
7
7
  Framework-agnostic base for every framework's `ViewContextValue`.
8
8
 
@@ -18,7 +18,7 @@ type) so it is typed via `TRegistry` — the same generic used in `BaseActorProv
18
18
 
19
19
  | Property | Type | Description | Inherited from | Defined in |
20
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.43/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.43/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.43/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.43/packages/play-actor/src/abstract-actor.ts#L126) |
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.45/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.45/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.45/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.45/packages/play-actor/src/abstract-actor.ts#L126) |
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / ActionFn
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / ActionFn
2
2
 
3
3
  # Type Alias: ActionFn\<C, K\>
4
4
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / Actions
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / Actions
2
2
 
3
3
  # Type Alias: Actions\<C\>
4
4
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / ComponentFn
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / ComponentFn
2
2
 
3
3
  # Type Alias: ComponentFn\<C, K\>
4
4
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / PlayActor
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / PlayActor
2
2
 
3
3
  # Type Alias: PlayActor
4
4
 
@@ -6,4 +6,4 @@
6
6
  type PlayActor = AbstractActor<AnyActorLogic> & Viewable;
7
7
  ```
8
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.43/packages/play-svelte/src/actor-context.svelte.ts#L21)
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-svelte/src/actor-context.svelte.ts#L21)
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / PlayRenderer
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / PlayRenderer
2
2
 
3
3
  # Type Alias: PlayRenderer
4
4
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / RenderErrorHandler
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / RenderErrorHandler
2
2
 
3
3
  # Type Alias: RenderErrorHandler
4
4
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / SetState
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / SetState
2
2
 
3
3
  # Type Alias: SetState
4
4
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / PlayRenderer
1
+ [API](../../../README.md) / [@xmachines/play-svelte](../README.md) / PlayRenderer
2
2
 
3
3
  # Variable: PlayRenderer
4
4
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../README.md) / @xmachines/play-svelte-spa-router
1
+ [API](../../README.md) / @xmachines/play-svelte-spa-router
2
2
 
3
3
  # @xmachines/play-svelte-spa-router
4
4
 
@@ -32,6 +32,11 @@ const disconnect = connectRouter({ actor, routeMap });
32
32
  - The adapter uses the shared Play router helpers for route resolution and event formatting.
33
33
  - Actor routes may be either state IDs or resolved paths; the adapter normalizes both before pushing hash navigation.
34
34
 
35
+ ## Learn More
36
+
37
+ - [Demo](../../../examples/@xmachines/play-svelte-spa-router-demo/README.md)
38
+ - [Svelte renderer](../play-svelte/README.md)
39
+
35
40
  ## Classes
36
41
 
37
42
  - [RouteMap](classes/RouteMap.md)
@@ -40,6 +45,7 @@ const disconnect = connectRouter({ actor, routeMap });
40
45
 
41
46
  - [ConnectRouterOptions](interfaces/ConnectRouterOptions.md)
42
47
  - [PlayRouteEvent](interfaces/PlayRouteEvent.md)
48
+ - [RouteMapOptions](interfaces/RouteMapOptions.md)
43
49
  - [RouteMapping](interfaces/RouteMapping.md)
44
50
  - [RouterBridge](interfaces/RouterBridge.md)
45
51
  - [WindowLike](interfaces/WindowLike.md)
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / RouteMap
1
+ [API](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / RouteMap
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.43/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.45/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?): RouteMap;
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.43/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.45/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.43/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.45/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.43/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.45/packages/play-router/src/base-route-map.ts#L174)
113
113
 
114
114
  Resolve a URL path to its mapped state ID.
115
115
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / connectRouter
1
+ [API](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / connectRouter
2
2
 
3
3
  # Function: connectRouter()
4
4
 
@@ -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.43/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.45/packages/play-svelte-spa-router/src/connect-router.ts#L30)
10
10
 
11
11
  Connect svelte-spa-router to actor.
12
12
 
@@ -1,12 +1,12 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / createRouteMap
1
+ [API](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / createRouteMap
2
2
 
3
3
  # Function: createRouteMap()
4
4
 
5
5
  ```ts
6
- function createRouteMap(machine): RouteMap;
6
+ function createRouteMap(machine, options?): 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.43/packages/play-router/src/create-route-map-from-machine.ts#L26)
9
+ Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map.ts#L45)
10
10
 
11
11
  Create a `RouteMap` from an XState state machine.
12
12
 
@@ -17,9 +17,10 @@ vice-versa.
17
17
 
18
18
  ## Parameters
19
19
 
20
- | Parameter | Type | Description |
21
- | --------- | ------------------------------------------------------------------------- | ---------------------------------------------------------------- |
22
- | `machine` | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | XState v5 state machine with `meta.route` annotations on states. |
20
+ | Parameter | Type | Description |
21
+ | ---------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
22
+ | `machine` | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | XState v5 state machine with `meta.route` annotations on states. |
23
+ | `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md) | Optional configuration. Pass `{ cacheSize }` to override the default LRU cache size for parameterized path lookups. |
23
24
 
24
25
  ## Returns
25
26
 
@@ -30,9 +31,9 @@ A `RouteMap` for passing to any `RouterBridgeBase`-based adapter.
30
31
  ## Example
31
32
 
32
33
  ```typescript
33
- import { createRouteMapFromMachine } from "@xmachines/play-router";
34
+ import { createRouteMap } from "@xmachines/play-router";
34
35
  import { connectRouter } from "@xmachines/play-dom-router";
35
36
 
36
- const routeMap = createRouteMapFromMachine(myMachine);
37
+ const routeMap = createRouteMap(myMachine);
37
38
  const disconnect = connectRouter({ actor, router, routeMap });
38
39
  ```
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / ConnectRouterOptions
1
+ [API](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / ConnectRouterOptions
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.43/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.45/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.43/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.43/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.43/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.45/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.45/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.45/packages/play-svelte-spa-router/src/connect-router.ts#L14) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / PlayRouteEvent
1
+ [API](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / PlayRouteEvent
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.43/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.45/packages/play-router/src/types.ts#L223)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -94,7 +94,7 @@ actor.send(event);
94
94
 
95
95
  ## See
96
96
 
97
- [Play RFC](../../docs/rfc/play.md)
97
+ [Play RFC](../../../../rfc/play.md)
98
98
 
99
99
  ## Remarks
100
100
 
@@ -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.43/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.43/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.43/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.43/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.43/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.45/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.45/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.45/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.45/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.45/packages/play-router/src/types.ts#L224) |
@@ -0,0 +1,13 @@
1
+ [API](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / RouteMapOptions
2
+
3
+ # Interface: RouteMapOptions
4
+
5
+ Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map.ts#L9)
6
+
7
+ Options for `createRouteMap` and `createRouteMapFromTree`.
8
+
9
+ ## Properties
10
+
11
+ | Property | Type | Description | Defined in |
12
+ | -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
+ | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map.ts#L20) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / RouteMapping
1
+ [API](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / RouteMapping
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.43/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.45/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: RouteMapping = { stateId: "settings", path: "/settings/:s
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.43/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.43/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.45/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.45/packages/play-router/src/base-route-map.ts#L59) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / RouterBridge
1
+ [API](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / RouterBridge
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.43/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.45/packages/play-router/src/types.ts#L271)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -44,7 +44,7 @@ class TanStackRouterBridge implements RouterBridge {
44
44
 
45
45
  ## See
46
46
 
47
- [Play RFC](../../docs/rfc/play.md) - Invariant INV-04
47
+ [Play RFC](../../../../rfc/play.md) - Invariant INV-04
48
48
 
49
49
  ## Methods
50
50
 
@@ -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.43/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.45/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.43/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.45/packages/play-router/src/types.ts#L303)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89