@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
@@ -0,0 +1,30 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / ActionFn
2
+
3
+ # Type Alias: ActionFn\<C, K\>
4
+
5
+ ```ts
6
+ type ActionFn<C, K> = (params, setState, state) => Promise<void>;
7
+ ```
8
+
9
+ Defined in: `@json-render/svelte`
10
+
11
+ Action handler function type
12
+
13
+ ## Type Parameters
14
+
15
+ | Type Parameter |
16
+ | ------------------------------------------------ |
17
+ | `C` _extends_ `Catalog` |
18
+ | `K` _extends_ keyof `InferCatalogActions`\<`C`\> |
19
+
20
+ ## Parameters
21
+
22
+ | Parameter | Type |
23
+ | ---------- | ---------------------------------------------- |
24
+ | `params` | `InferActionParams`\<`C`, `K`\> \| `undefined` |
25
+ | `setState` | [`SetState`](SetState.md) |
26
+ | `state` | `StateModel` |
27
+
28
+ ## Returns
29
+
30
+ `Promise`\<`void`\>
@@ -0,0 +1,17 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / Actions
2
+
3
+ # Type Alias: Actions\<C\>
4
+
5
+ ```ts
6
+ type Actions<C> = { [K in keyof InferCatalogActions<C>]: ActionFn<C, K> };
7
+ ```
8
+
9
+ Defined in: `@json-render/svelte`
10
+
11
+ Registry of all action handlers for a catalog
12
+
13
+ ## Type Parameters
14
+
15
+ | Type Parameter |
16
+ | ----------------------- |
17
+ | `C` _extends_ `Catalog` |
@@ -0,0 +1,21 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / SetState
2
+
3
+ # Type Alias: SetState
4
+
5
+ ```ts
6
+ type SetState = (updater) => void;
7
+ ```
8
+
9
+ Defined in: `@json-render/svelte`
10
+
11
+ State setter function for updating application state
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type |
16
+ | --------- | ------------------------------------------- |
17
+ | `updater` | (`prev`) => `Record`\<`string`, `unknown`\> |
18
+
19
+ ## Returns
20
+
21
+ `void`
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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.32/packages/play-router/src/base-route-map.ts#L100)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -50,7 +50,7 @@ map.getPathByStateId("missing"); // null
50
50
  new RouteMap(mappings, options?): BaseRouteMap;
51
51
  ```
52
52
 
53
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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.32/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.31/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.32/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.31/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.32/packages/play-router/src/base-route-map.ts#L174)
113
113
 
114
114
  Resolve a URL path to its mapped state ID.
115
115
 
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [play-svelte-spa-router/src/connect-router.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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.32/packages/play-svelte-spa-router/src/connect-router.ts#L30)
10
10
 
11
11
  Connect svelte-spa-router to actor.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/create-route-map-from-machine.ts#L26)
9
+ Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.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
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ConnectRouterOptions
4
4
 
5
- Defined in: [play-svelte-spa-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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.32/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.31/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.31/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.31/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.32/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.32/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.32/packages/play-svelte-spa-router/src/connect-router.ts#L14) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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.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` | [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`\> | [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`\> | [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` | [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"` | [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` | [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`\> | [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`\> | [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` | [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"` | [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) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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.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?"`) | [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"`) | [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?"`) | [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"`) | [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) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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.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: [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: [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: [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: [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
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: WindowLike
4
4
 
5
- Defined in: [play-router/src/types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L324)
5
+ Defined in: [play-router/src/types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/types.ts#L324)
6
6
 
7
7
  Minimal window interface required by adapters that subscribe to DOM events
8
8
  (e.g. `hashchange`). Injectable for SSR and testing — pass a mock instead of
@@ -30,7 +30,7 @@ connectRouter({ actor, routeMap, window: mockWin });
30
30
  addEventListener(type, listener): void;
31
31
  ```
32
32
 
33
- Defined in: [play-router/src/types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L325)
33
+ Defined in: [play-router/src/types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/types.ts#L325)
34
34
 
35
35
  #### Parameters
36
36
 
@@ -51,7 +51,7 @@ Defined in: [play-router/src/types.ts:325](https://gitlab.com/xmachin-es/xmachin
51
51
  removeEventListener(type, listener): void;
52
52
  ```
53
53
 
54
- Defined in: [play-router/src/types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L326)
54
+ Defined in: [play-router/src/types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/types.ts#L326)
55
55
 
56
56
  #### Parameters
57
57
 
@@ -6,4 +6,4 @@
6
6
  type RoutableActor = AbstractActor<AnyActorLogic> & Routable;
7
7
  ```
8
8
 
9
- Defined in: [play-svelte-spa-router/src/types.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-svelte-spa-router/src/types.ts#L6)
9
+ Defined in: [play-svelte-spa-router/src/types.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-svelte-spa-router/src/types.ts#L6)
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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.32/packages/play-router/src/base-route-map.ts#L100)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -50,7 +50,7 @@ map.getPathByStateId("missing"); // null
50
50
  new RouteMap(mappings, options?): BaseRouteMap;
51
51
  ```
52
52
 
53
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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.32/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.31/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.32/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.31/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.32/packages/play-router/src/base-route-map.ts#L174)
113
113
 
114
114
  Resolve a URL path to its mapped state ID.
115
115
 
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [play-sveltekit-router/src/connect-router.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-sveltekit-router/src/connect-router.ts#L29)
9
+ Defined in: [play-sveltekit-router/src/connect-router.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-sveltekit-router/src/connect-router.ts#L29)
10
10
 
11
11
  Connect SvelteKit router to actor.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/create-route-map-from-machine.ts#L26)
9
+ Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.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
 
@@ -2,12 +2,12 @@
2
2
 
3
3
  # Interface: ConnectRouterOptions
4
4
 
5
- Defined in: [play-sveltekit-router/src/connect-router.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-sveltekit-router/src/connect-router.ts#L6)
5
+ Defined in: [play-sveltekit-router/src/connect-router.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-sveltekit-router/src/connect-router.ts#L6)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Modifier | Type | Description | Defined in |
10
10
  | ------------------------------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <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-sveltekit-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-sveltekit-router/src/connect-router.ts#L7) |
12
- | <a id="property-location"></a> `location?` | `readonly` | [`LocationLike`](LocationLike.md) \| `null` | Location-like object for initial URL reads. Defaults to `globalThis.location`. Pass a mock in tests or a stub in SSR environments. | [play-sveltekit-router/src/connect-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-sveltekit-router/src/connect-router.ts#L13) |
13
- | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-sveltekit-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-sveltekit-router/src/connect-router.ts#L8) |
11
+ | <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-sveltekit-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-sveltekit-router/src/connect-router.ts#L7) |
12
+ | <a id="property-location"></a> `location?` | `readonly` | [`LocationLike`](LocationLike.md) \| `null` | Location-like object for initial URL reads. Defaults to `globalThis.location`. Pass a mock in tests or a stub in SSR environments. | [play-sveltekit-router/src/connect-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-sveltekit-router/src/connect-router.ts#L13) |
13
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-sveltekit-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-sveltekit-router/src/connect-router.ts#L8) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: LocationLike
4
4
 
5
- Defined in: [play-router/src/types.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L344)
5
+ Defined in: [play-router/src/types.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/types.ts#L344)
6
6
 
7
7
  Minimal location interface required by adapters that read the current URL at
8
8
  `connect()` time. Injectable for SSR and testing — pass a mock instead of the
@@ -23,5 +23,5 @@ connectRouter({ actor, routeMap, location: mockLoc });
23
23
 
24
24
  | Property | Modifier | Type | Defined in |
25
25
  | ----------------------------------------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:345](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L345) |
27
- | <a id="property-search"></a> `search` | `readonly` | `string` | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L346) |
26
+ | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:345](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/types.ts#L345) |
27
+ | <a id="property-search"></a> `search` | `readonly` | `string` | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/types.ts#L346) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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.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` | [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`\> | [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`\> | [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` | [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"` | [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` | [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`\> | [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`\> | [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` | [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"` | [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) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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.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?"`) | [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"`) | [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?"`) | [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"`) | [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) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/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.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: [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: [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: [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: [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
 
@@ -6,4 +6,4 @@
6
6
  type RoutableActor = AbstractActor<AnyActorLogic> & Routable;
7
7
  ```
8
8
 
9
- Defined in: [play-sveltekit-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-sveltekit-router/src/types.ts#L10)
9
+ Defined in: [play-sveltekit-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-sveltekit-router/src/types.ts#L10)
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-tanstack-react-router/src/route-map.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/route-map.ts#L12)
5
+ Defined in: [play-tanstack-react-router/src/route-map.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-tanstack-react-router/src/route-map.ts#L12)
6
6
 
7
7
  Bidirectional route mapper for TanStack React Router.
8
8
 
@@ -20,7 +20,7 @@ Alias for [BaseRouteMap](../../play-dom-router/interfaces/RouteMap.md) from `@xm
20
20
  new RouteMap(mappings, options?): RouteMap;
21
21
  ```
22
22
 
23
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L125)
23
+ Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/base-route-map.ts#L125)
24
24
 
25
25
  Build a route map from an array of state ID ↔ path mappings.
26
26
 
@@ -54,7 +54,7 @@ BaseRouteMap.constructor;
54
54
  getPathByStateId(stateId): string | null;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L209)
57
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/base-route-map.ts#L209)
58
58
 
59
59
  Look up the path pattern registered for a state ID.
60
60
 
@@ -89,7 +89,7 @@ map.getPathByStateId("missing"); // null
89
89
  getStateIdByPath(path): string | null;
90
90
  ```
91
91
 
92
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L174)
92
+ Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/base-route-map.ts#L174)
93
93
 
94
94
  Resolve a URL path to its mapped state ID.
95
95