@xmachines/docs 1.0.0-beta.31 → 1.0.0-beta.32

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 (270) hide show
  1. package/api/@xmachines/play/README.md +5 -0
  2. package/api/@xmachines/play/classes/NonNullableError.md +189 -0
  3. package/api/@xmachines/play/classes/PlayError.md +9 -4
  4. package/api/@xmachines/play/functions/assertNonNullable.md +56 -0
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  6. package/api/@xmachines/play-actor/README.md +9 -9
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  9. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  10. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  11. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  13. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  14. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  15. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  16. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  17. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  18. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  19. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +3 -3
  20. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +3 -3
  21. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +7 -7
  22. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  23. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +3 -3
  24. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  25. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  26. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  27. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  28. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  29. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  31. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  32. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  33. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  34. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  35. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  36. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  37. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  38. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  39. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  40. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  41. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  42. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  43. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  44. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  45. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  46. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  47. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  48. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  49. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  50. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  51. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +6 -6
  52. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  53. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  54. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  55. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  56. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  57. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  58. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  59. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  60. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  61. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  62. package/api/@xmachines/play-router/README.md +1 -1
  63. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  64. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  65. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  66. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  67. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  68. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  69. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  70. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  71. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  72. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  73. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  74. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  75. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  76. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  77. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  78. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  79. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  80. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  81. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  82. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  83. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  84. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  85. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  86. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  87. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  88. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  89. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  90. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  91. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  92. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  93. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  94. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  95. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  96. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  97. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  98. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  99. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  100. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  101. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  102. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  103. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  104. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  105. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  106. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  107. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  108. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  109. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  110. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +6 -6
  111. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  112. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  113. package/api/@xmachines/play-solid-router/README.md +2 -2
  114. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  115. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  116. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +28 -1
  117. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  118. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  119. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  120. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  121. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  122. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  123. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  124. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  125. package/api/@xmachines/play-svelte/README.md +8 -3
  126. package/api/@xmachines/play-svelte/functions/defineRegistry.md +12 -35
  127. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +23 -0
  128. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +6 -6
  129. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +30 -0
  130. package/api/@xmachines/play-svelte/type-aliases/Actions.md +17 -0
  131. package/api/@xmachines/play-svelte/type-aliases/SetState.md +21 -0
  132. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  133. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  134. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  135. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  136. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  137. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  138. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  139. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  140. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  141. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  142. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  143. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  144. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  145. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  146. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  147. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  148. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  149. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  150. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  151. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  152. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +8 -1
  153. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  154. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  155. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  156. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  157. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  158. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  159. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  160. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  161. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  162. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  163. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  164. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  165. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +9 -1
  166. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  167. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  168. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  169. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  170. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  171. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  172. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  173. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  174. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  175. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  176. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +4 -4
  177. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  178. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  179. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  180. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  181. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  182. package/api/@xmachines/play-vue-router/README.md +3 -3
  183. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  184. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  185. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +39 -26
  186. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  187. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  188. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  189. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  190. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  191. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  192. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  193. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  194. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  195. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  196. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  197. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  198. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  199. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  200. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  201. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  202. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  203. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  204. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  205. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  206. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  207. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  208. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  209. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  210. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  211. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  212. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  213. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  214. package/api/@xmachines/shared/README.md +47 -47
  215. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  216. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  217. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  218. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  219. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  220. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  221. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  222. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  223. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  224. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  225. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  226. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  227. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  228. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  229. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  230. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  231. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  232. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  233. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  234. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  235. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  236. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  237. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  238. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  239. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  240. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  241. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  242. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  243. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  244. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  245. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  246. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  247. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  248. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  249. package/examples/@xmachines/play-react-router-demo/README.md +1 -3
  250. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  251. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  252. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  253. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  254. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  255. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  256. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  257. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  258. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  259. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  260. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  261. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  262. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  263. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  264. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  265. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  266. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  267. package/examples/@xmachines/play-solid-router-demo/README.md +1 -3
  268. package/examples/README.md +2 -2
  269. package/package.json +6 -6
  270. package/rfc/play.md +19 -19
package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: SolidRouterBridge
4
4
 
5
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/solid-router-bridge.ts#L55)
5
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/solid-router-bridge.ts#L55)
6
6
 
7
7
  SolidJS Router integration bridge extending RouterBridgeBase
8
8
 
@@ -31,7 +31,7 @@ new SolidRouterBridge(
31
31
  routeMap): SolidRouterBridge;
32
32
  ```
33
33
 
34
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/solid-router-bridge.ts#L76)
34
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/solid-router-bridge.ts#L76)
35
35
 
36
36
  Create a SolidJS Router bridge
37
37
 
@@ -59,15 +59,15 @@ Create a SolidJS Router bridge
59
59
 
60
60
  | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
61
61
  | --------------------------------------------------------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
62
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../interfaces/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [packages/play-router/src/router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L99) |
63
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [packages/play-router/src/router-bridge-base.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L87) |
64
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [packages/play-router/src/router-bridge-base.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L86) |
65
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [packages/play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L89) |
66
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [packages/play-router/src/router-bridge-base.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L88) |
67
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [packages/play-router/src/router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L100) |
68
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [packages/play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L102) |
69
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [packages/play-router/src/router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L101) |
70
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [packages/play-router/src/router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L90) |
62
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../interfaces/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [packages/play-router/src/router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L99) |
63
+ | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [packages/play-router/src/router-bridge-base.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L87) |
64
+ | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [packages/play-router/src/router-bridge-base.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L86) |
65
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [packages/play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L89) |
66
+ | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [packages/play-router/src/router-bridge-base.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L88) |
67
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [packages/play-router/src/router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L100) |
68
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [packages/play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L102) |
69
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [packages/play-router/src/router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L101) |
70
+ | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [packages/play-router/src/router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L90) |
71
71
 
72
72
  ## Methods
73
73
 
@@ -77,7 +77,7 @@ Create a SolidJS Router bridge
77
77
  connect(): void;
78
78
  ```
79
79
 
80
- Defined in: [packages/play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L126)
80
+ Defined in: [packages/play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L126)
81
81
 
82
82
  Connect the router bridge to the Actor.
83
83
 
@@ -109,7 +109,7 @@ Adapters that need custom initial-sync behavior should override
109
109
  disconnect(): void;
110
110
  ```
111
111
 
112
- Defined in: [packages/play-router/src/router-bridge-base.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L209)
112
+ Defined in: [packages/play-router/src/router-bridge-base.ts:214](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L214)
113
113
 
114
114
  Disconnect the router bridge from the Actor.
115
115
 
@@ -131,7 +131,7 @@ Stops signal watching and unregisters framework-specific router listener.
131
131
  dispose(): void;
132
132
  ```
133
133
 
134
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:188](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/solid-router-bridge.ts#L188)
134
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:188](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/solid-router-bridge.ts#L188)
135
135
 
136
136
  Dispose the bridge (alias for disconnect).
137
137
 
@@ -153,7 +153,7 @@ onCleanup(() => bridge.dispose());
153
153
  protected extractParams(pathname, stateId): Record<string, string>;
154
154
  ```
155
155
 
156
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/solid-router-bridge.ts#L105)
156
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/solid-router-bridge.ts#L105)
157
157
 
158
158
  Extract path parameters using Solid's pre-parsed `useParams()` values.
159
159
 
@@ -190,7 +190,7 @@ Normalized path parameters with undefined/empty values filtered out
190
190
  protected extractQuery(search): Record<string, string>;
191
191
  ```
192
192
 
193
- Defined in: [packages/play-router/src/router-bridge-base.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L355)
193
+ Defined in: [packages/play-router/src/router-bridge-base.ts:359](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L359)
194
194
 
195
195
  Extract query parameters from URL search string.
196
196
 
@@ -218,7 +218,7 @@ Extracted query parameters or empty object
218
218
  protected getInitialRouterPath(): string | null;
219
219
  ```
220
220
 
221
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/solid-router-bridge.ts#L127)
221
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/solid-router-bridge.ts#L127)
222
222
 
223
223
  Get the current router pathname for initial URL -> actor sync on connect.
224
224
 
@@ -238,7 +238,7 @@ Get the current router pathname for initial URL -> actor sync on connect.
238
238
  protected getInitialRouterSearch(): string | undefined;
239
239
  ```
240
240
 
241
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:138](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/solid-router-bridge.ts#L138)
241
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:138](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/solid-router-bridge.ts#L138)
242
242
 
243
243
  Return the initial URL search string for query-param forwarding on `connect()`.
244
244
 
@@ -262,7 +262,7 @@ params) returns `undefined` so `syncActorFromRouter` produces `query: {}`.
262
262
  protected navigateRouter(path): void;
263
263
  ```
264
264
 
265
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/solid-router-bridge.ts#L120)
265
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/solid-router-bridge.ts#L120)
266
266
 
267
267
  Navigate SolidJS Router to the given path.
268
268
 
@@ -288,7 +288,7 @@ Navigate SolidJS Router to the given path.
288
288
  protected resolveNavigationPath(route): string | null;
289
289
  ```
290
290
 
291
- Defined in: [packages/play-router/src/router-bridge-base.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L340)
291
+ Defined in: [packages/play-router/src/router-bridge-base.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L344)
292
292
 
293
293
  Resolve an actor route value to a concrete URL path for navigation.
294
294
 
@@ -327,7 +327,7 @@ Concrete URL path, or `null` if navigation should be skipped
327
327
  protected syncActorFromRouter(pathname, search?): void;
328
328
  ```
329
329
 
330
- Defined in: [packages/play-router/src/router-bridge-base.ts:260](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L260)
330
+ Defined in: [packages/play-router/src/router-bridge-base.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L264)
331
331
 
332
332
  Sync actor state when router location changes.
333
333
 
@@ -357,7 +357,7 @@ Prevents circular updates via isProcessingNavigation flag.
357
357
  protected syncRouterFromActor(route): void;
358
358
  ```
359
359
 
360
- Defined in: [packages/play-router/src/router-bridge-base.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L240)
360
+ Defined in: [packages/play-router/src/router-bridge-base.ts:244](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/router-bridge-base.ts#L244)
361
361
 
362
362
  Sync router location when actor route signal changes.
363
363
 
@@ -390,7 +390,7 @@ suppressed as circular echoes.
390
390
  protected unwatchRouterChanges(): void;
391
391
  ```
392
392
 
393
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:175](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/solid-router-bridge.ts#L175)
393
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:175](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/solid-router-bridge.ts#L175)
394
394
 
395
395
  Stop watching SolidJS Router changes.
396
396
 
@@ -414,7 +414,7 @@ cleanup path — component unmount does NOT trigger this automatically.
414
414
  protected watchRouterChanges(): void;
415
415
  ```
416
416
 
417
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/solid-router-bridge.ts#L153)
417
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/solid-router-bridge.ts#L153)
418
418
 
419
419
  Subscribe to SolidJS Router location changes using createEffect.
420
420
 
package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md CHANGED
@@ -6,7 +6,34 @@
6
6
  function PlayRouterProvider<TActor>(props): any;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/play-router-provider.tsx#L41)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/play-router-provider.tsx#L76)
10
+
11
+ Connects a `PlayerActor` to Solid Router, keeping actor state and browser URL
12
+ in sync bidirectionally.
13
+
14
+ The bridge is created synchronously at component evaluation time (Solid's
15
+ execution model) and torn down via `onCleanup` when the component is disposed.
16
+ Unlike React, prop stability is not a concern — Solid's `props` accessor is
17
+ already reactive and the bridge is created once per component instance.
18
+
19
+ The `router` prop must be obtained from Solid Router hooks in the parent component:
20
+
21
+ ```tsx
22
+ function AppShell() {
23
+ const navigate = useNavigate();
24
+ const location = useLocation();
25
+ const params = useParams();
26
+
27
+ return (
28
+ <PlayRouterProvider
29
+ actor={actor}
30
+ routeMap={routeMap}
31
+ router={{ navigate, location, params }}
32
+ renderer={(a) => <PlayRenderer actor={a} registry={registry} />}
33
+ />
34
+ );
35
+ }
36
+ ```
10
37
 
11
38
  ## Type Parameters
12
39
 
package/api/@xmachines/play-solid-router/functions/createRouteMap.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/create-route-map-from-machine.ts#L26)
9
+ Defined in: [packages/play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/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
 
package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Abstract Interface: AbstractActor\<TLogic, TEvent\>
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-actor/src/abstract-actor.ts#L141)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L141)
6
6
 
7
7
  Abstract base class for Play Architecture actors.
8
8
 
@@ -33,7 +33,7 @@ Infrastructure layer communication.
33
33
  | <a id="property-ref"></a> `ref` | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TLogic`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TLogic`\>\> | - | `Actor.ref` | - |
34
34
  | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
35
35
  | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` | - |
36
- | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Infrastructure observes this signal to react to state changes without directly coupling to the actor's internal state machine implementation. | - | [packages/play-actor/src/abstract-actor.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-actor/src/abstract-actor.ts#L151) |
36
+ | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Infrastructure observes this signal to react to state changes without directly coupling to the actor's internal state machine implementation. | - | [packages/play-actor/src/abstract-actor.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L151) |
37
37
  | <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | `Actor.system` | - |
38
38
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | - |
39
39
 
@@ -204,7 +204,7 @@ Actor.select;
204
204
  abstract send(event): void;
205
205
  ```
206
206
 
207
- Defined in: [packages/play-actor/src/abstract-actor.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-actor/src/abstract-actor.ts#L158)
207
+ Defined in: [packages/play-actor/src/abstract-actor.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-actor/src/abstract-actor.ts#L158)
208
208
 
209
209
  Send event to Actor.
210
210
 
package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [packages/play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L223)
5
+ Defined in: [packages/play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/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` | [packages/play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L228) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L226) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L227) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [packages/play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L225) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [packages/play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L224) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [packages/play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/types.ts#L228) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/types.ts#L226) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/types.ts#L227) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [packages/play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/types.ts#L225) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [packages/play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/types.ts#L224) |
package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouterProviderProps\<TActor\>
4
4
 
5
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/play-router-provider.tsx#L33)
5
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/play-router-provider.tsx#L33)
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -12,9 +12,9 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:33](https:/
12
12
 
13
13
  ## Properties
14
14
 
15
- | Property | Type | Description | Defined in |
16
- | ----------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
17
- | <a id="property-actor"></a> `actor` | `TActor` | - | [packages/play-solid-router/src/play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/play-router-provider.tsx#L34) |
18
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [packages/play-solid-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/play-router-provider.tsx#L38) |
19
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | - | [packages/play-solid-router/src/play-router-provider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/play-router-provider.tsx#L35) |
20
- | <a id="property-router"></a> `router` | [`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md) | - | [packages/play-solid-router/src/play-router-provider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/play-router-provider.tsx#L36) |
15
+ | Property | Type | Description | Defined in |
16
+ | ----------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
17
+ | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with Solid Router. | [packages/play-solid-router/src/play-router-provider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/play-router-provider.tsx#L35) |
18
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [packages/play-solid-router/src/play-router-provider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/play-router-provider.tsx#L45) |
19
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [packages/play-solid-router/src/play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/play-router-provider.tsx#L37) |
20
+ | <a id="property-router"></a> `router` | [`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md) | The three Solid Router hook results that drive bidirectional sync. Obtain these from `useNavigate()`, `useLocation()`, and `useParams()` in the parent component (they must be called inside a router context). | [packages/play-solid-router/src/play-router-provider.tsx:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/play-router-provider.tsx#L43) |
package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [packages/play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L57)
5
+ Defined in: [packages/play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/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?"`) | [packages/play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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"`) | [packages/play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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?"`) | [packages/play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/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"`) | [packages/play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/base-route-map.ts#L59) |
package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [packages/play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L271)
5
+ Defined in: [packages/play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/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: [packages/play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L287)
57
+ Defined in: [packages/play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/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: [packages/play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L303)
86
+ Defined in: [packages/play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/types.ts#L303)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md CHANGED
@@ -6,6 +6,6 @@
6
6
  type RoutableActor = AbstractActor<AnyActorLogic> & Routable & Viewable;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/play-router-provider.tsx#L9)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/play-router-provider.tsx#L9)
10
10
 
11
11
  Minimum actor shape accepted by PlayRouterProvider.
package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type SolidRouterHooks = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/play-router-provider.tsx#L27)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/play-router-provider.tsx#L27)
10
10
 
11
11
  The three Solid Router hook results that `PlayRouterProvider` and `SolidRouterBridge`
12
12
  require. Pass these directly from your component's hook calls:
@@ -31,7 +31,7 @@ const params = useParams(); // → SolidRouterHooks.params
31
31
  location: Location;
32
32
  ```
33
33
 
34
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/play-router-provider.tsx#L29)
34
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/play-router-provider.tsx#L29)
35
35
 
36
36
  ---
37
37
 
@@ -41,7 +41,7 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:29](https:/
41
41
  navigate: Navigator;
42
42
  ```
43
43
 
44
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/play-router-provider.tsx#L28)
44
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/play-router-provider.tsx#L28)
45
45
 
46
46
  ---
47
47
 
@@ -51,4 +51,4 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:28](https:/
51
51
  params: Params;
52
52
  ```
53
53
 
54
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid-router/src/play-router-provider.tsx#L30)
54
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid-router/src/play-router-provider.tsx#L30)
package/api/@xmachines/play-svelte/README.md CHANGED
@@ -99,20 +99,25 @@ Provides a thin Svelte rendering layer that passively observes actor signals
99
99
  and renders UI components via @json-render/svelte. Svelte reactivity is only
100
100
  used to trigger re-renders — signals are the source of truth.
101
101
 
102
- Re-exports `defineRegistry`, `getBoundProp`, `BaseComponentProps`, and
103
- `ComponentFn` from `@json-render/svelte` so consumers import everything
104
- from `@xmachines/play-svelte` rather than `@json-render/svelte` directly.
102
+ Re-exports `defineRegistry` (catalog-typed — action params are inferred from
103
+ the catalog schema), `getBoundProp`, `BaseComponentProps`, and `ComponentFn`
104
+ from `@json-render/svelte` so consumers import everything from
105
+ `@xmachines/play-svelte` rather than `@json-render/svelte` directly.
105
106
 
106
107
  ## Interfaces
107
108
 
108
109
  - [BaseComponentProps](interfaces/BaseComponentProps.md)
109
110
  - [ComponentContext](interfaces/ComponentContext.md)
111
+ - [DefineRegistryOptions](interfaces/DefineRegistryOptions.md)
110
112
  - [PlayRendererProps](interfaces/PlayRendererProps.md)
111
113
 
112
114
  ## Type Aliases
113
115
 
116
+ - [ActionFn](type-aliases/ActionFn.md)
117
+ - [Actions](type-aliases/Actions.md)
114
118
  - [ComponentFn](type-aliases/ComponentFn.md)
115
119
  - [PlayRenderer](type-aliases/PlayRenderer.md)
120
+ - [SetState](type-aliases/SetState.md)
116
121
 
117
122
  ## Variables
118
123
 
package/api/@xmachines/play-svelte/functions/defineRegistry.md CHANGED
@@ -3,52 +3,29 @@
3
3
  # Function: defineRegistry()
4
4
 
5
5
  ```ts
6
- function defineRegistry<C, TComponents>(_catalog, options): DefineRegistryResult;
6
+ function defineRegistry<C>(catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
- Defined in: `@json-render/svelte`
9
+ Defined in: [packages/play-svelte/src/define-registry.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-svelte/src/define-registry.ts#L125)
10
10
 
11
- Create a registry from a catalog with Svelte components and/or actions.
11
+ Create a component registry, restoring catalog-typed `params` on action handlers.
12
12
 
13
- Components must accept `BaseComponentProps` as their props interface.
13
+ Drop-in replacement for `defineRegistry` from `@json-render/svelte`. Import from
14
+ `@xmachines/play-svelte` to get per-action param type inference for free.
14
15
 
15
16
  ## Type Parameters
16
17
 
17
- | Type Parameter |
18
- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | `C` _extends_ `Catalog`\<`SchemaDefinition`\<`SchemaType`\<`string`, `unknown`\>, `SchemaType`\<`string`, `unknown`\>\>, `unknown`\> |
20
- | `TComponents` _extends_ `Record`\<`string`, `Component`\<[`BaseComponentProps`](../interfaces/BaseComponentProps.md)\<`any`\>, \{ \}, `string`\>\> |
18
+ | Type Parameter |
19
+ | ------------------------------------------------------------------------------------------------------------------------------------ |
20
+ | `C` _extends_ `Catalog`\<`SchemaDefinition`\<`SchemaType`\<`string`, `unknown`\>, `SchemaType`\<`string`, `unknown`\>\>, `unknown`\> |
21
21
 
22
22
  ## Parameters
23
23
 
24
- | Parameter | Type | Description |
25
- | --------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------ |
26
- | `_catalog` | `C` | - |
27
- | `options` | \{ `actions?`: `Record`\<`string`, `DefineRegistryActionFn`\>; `components?`: `TComponents`; \} | - |
28
- | `options.actions?` | `Record`\<`string`, `DefineRegistryActionFn`\> | Action handlers |
29
- | `options.components?` | `TComponents` | Svelte components that accept BaseComponentProps |
24
+ | Parameter | Type | Description |
25
+ | --------- | ------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
26
+ | `catalog` | `C` | The json-render catalog defining component prop shapes and action schemas. |
27
+ | `options` | [`DefineRegistryOptions`](../interfaces/DefineRegistryOptions.md)\<`C`\> | Registry options. `actions` entries receive params typed from the catalog. |
30
28
 
31
29
  ## Returns
32
30
 
33
31
  `DefineRegistryResult`
34
-
35
- ## Example
36
-
37
- ```ts
38
- import { defineRegistry } from "@json-render/svelte";
39
- import Card from "./components/Card.svelte";
40
- import Button from "./components/Button.svelte";
41
- import { myCatalog } from "./catalog";
42
-
43
- const { registry, handlers } = defineRegistry(myCatalog, {
44
- components: {
45
- Card,
46
- Button,
47
- },
48
- actions: {
49
- submit: async (params, setState) => {
50
- // handle action
51
- },
52
- },
53
- });
54
- ```
package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md ADDED
@@ -0,0 +1,23 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / DefineRegistryOptions
2
+
3
+ # Interface: DefineRegistryOptions\<C\>
4
+
5
+ Defined in: [packages/play-svelte/src/define-registry.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-svelte/src/define-registry.ts#L89)
6
+
7
+ Options for `defineRegistry`.
8
+
9
+ Mirrors the upstream shape but replaces the untyped
10
+ `Record<string, DefineRegistryActionFn>` with a catalog-typed `Actions<C>` map.
11
+
12
+ ## Type Parameters
13
+
14
+ | Type Parameter |
15
+ | ----------------------- |
16
+ | `C` _extends_ `Catalog` |
17
+
18
+ ## Properties
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:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-svelte/src/define-registry.ts#L113) |
23
+ | <a id="property-components"></a> `components?` | `Components`\<`C`\> | Svelte component implementations — keyed by catalog component name. | [packages/play-svelte/src/define-registry.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-svelte/src/define-registry.ts#L93) |
package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRendererProps\<TLogic\>
4
4
 
5
- Defined in: [packages/play-svelte/src/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte/src/types.ts#L13)
5
+ Defined in: [packages/play-svelte/src/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-svelte/src/types.ts#L13)
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -14,8 +14,8 @@ Defined in: [packages/play-svelte/src/types.ts:13](https://gitlab.com/xmachin-es
14
14
 
15
15
  | Property | Type | Description | Defined in |
16
16
  | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | - | [packages/play-svelte/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte/src/types.ts#L14) |
18
- | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | Svelte snippet rendered when currentView is null (no active view). Also shown when a catalog component throws during render. | [packages/play-svelte/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte/src/types.ts#L29) |
19
- | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | Called when a catalog component throws during render. Receives the thrown error and a `reset` function that clears the boundary and attempts to re-render. Matches Svelte 5's `<svelte:boundary onerror>` signature. | [packages/play-svelte/src/types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte/src/types.ts#L36) |
20
- | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains component registry and action handlers. Action handlers are async functions that dispatch to the actor (not string-mapped event type stubs). Replaces the old `registry` + `actions` prop pair. | [packages/play-svelte/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte/src/types.ts#L21) |
21
- | <a id="property-store"></a> `store?` | `StateStore` | - | [packages/play-svelte/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte/src/types.ts#L23) |
17
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | - | [packages/play-svelte/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-svelte/src/types.ts#L14) |
18
+ | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | Svelte snippet rendered when currentView is null (no active view). Also shown when a catalog component throws during render. | [packages/play-svelte/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-svelte/src/types.ts#L29) |
19
+ | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | Called when a catalog component throws during render. Receives the thrown error and a `reset` function that clears the boundary and attempts to re-render. Matches Svelte 5's `<svelte:boundary onerror>` signature. | [packages/play-svelte/src/types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-svelte/src/types.ts#L36) |
20
+ | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains component registry and action handlers. Action handlers are async functions that dispatch to the actor (not string-mapped event type stubs). Replaces the old `registry` + `actions` prop pair. | [packages/play-svelte/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-svelte/src/types.ts#L21) |
21
+ | <a id="property-store"></a> `store?` | `StateStore` | - | [packages/play-svelte/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-svelte/src/types.ts#L23) |