@xmachines/docs 1.0.0-beta.26 → 1.0.0-beta.28

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 (309) hide show
  1. package/api/@xmachines/play/classes/PlayError.md +4 -10
  2. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  3. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -25
  4. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  5. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  6. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  7. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  8. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  9. package/api/@xmachines/play-actor-shared/README.md +155 -0
  10. package/api/@xmachines/play-actor-shared/interfaces/AuthContext.md +14 -0
  11. package/api/@xmachines/play-actor-shared/type-aliases/AuthActor.md +27 -0
  12. package/api/@xmachines/play-actor-shared/type-aliases/AuthCatalog.md +16 -0
  13. package/api/@xmachines/play-actor-shared/type-aliases/AuthEvents.md +17 -0
  14. package/api/@xmachines/play-actor-shared/type-aliases/AuthInput.md +9 -0
  15. package/api/@xmachines/play-actor-shared/type-aliases/AuthSnapshot.md +11 -0
  16. package/api/@xmachines/play-actor-shared/type-aliases/CatalogProps.md +187 -0
  17. package/api/@xmachines/play-actor-shared/type-aliases/InferProps.md +17 -0
  18. package/api/@xmachines/play-actor-shared/variables/authCatalog.md +173 -0
  19. package/api/@xmachines/play-actor-shared/variables/authMachine.md +189 -0
  20. package/api/@xmachines/play-actor-shared/variables/authSetup.md +22 -0
  21. package/api/@xmachines/play-dom/README.md +74 -8
  22. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  23. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  24. package/api/@xmachines/play-dom/functions/defineRegistry.md +61 -0
  25. package/api/@xmachines/play-dom/functions/renderSpec.md +29 -12
  26. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +62 -0
  27. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +9 -9
  28. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +25 -0
  29. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +18 -0
  30. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +13 -10
  31. package/api/@xmachines/play-dom/interfaces/EventHandle.md +29 -0
  32. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +5 -5
  33. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +53 -0
  34. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +21 -0
  35. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +16 -3
  36. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +5 -2
  37. package/api/@xmachines/play-dom-demo/README.md +145 -0
  38. package/api/@xmachines/play-dom-demo/functions/initShell.md +20 -0
  39. package/api/@xmachines/play-dom-demo/variables/About.md +9 -0
  40. package/api/@xmachines/play-dom-demo/variables/Contact.md +9 -0
  41. package/api/@xmachines/play-dom-demo/variables/Dashboard.md +9 -0
  42. package/api/@xmachines/play-dom-demo/variables/Home.md +9 -0
  43. package/api/@xmachines/play-dom-demo/variables/Login.md +9 -0
  44. package/api/@xmachines/play-dom-demo/variables/Navigation.md +9 -0
  45. package/api/@xmachines/play-dom-demo/variables/Overview.md +9 -0
  46. package/api/@xmachines/play-dom-demo/variables/Profile.md +9 -0
  47. package/api/@xmachines/play-dom-demo/variables/Settings.md +9 -0
  48. package/api/@xmachines/play-dom-demo/variables/Stats.md +9 -0
  49. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  50. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  51. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  52. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  53. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  54. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  55. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  56. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  57. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  58. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  59. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  60. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  61. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  62. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  63. package/api/@xmachines/play-dom-router-demo/README.md +56 -61
  64. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -31
  65. package/api/@xmachines/play-react/functions/defineRegistry.md +0 -2
  66. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  67. package/api/@xmachines/play-react/functions/useBoundProp.md +0 -2
  68. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  69. package/api/@xmachines/play-react/functions/useStateBinding.md +0 -2
  70. package/api/@xmachines/play-react/interfaces/ComponentContext.md +0 -2
  71. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  72. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  73. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +7 -7
  74. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +0 -2
  75. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  76. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  77. package/api/@xmachines/play-react-demo/README.md +173 -0
  78. package/api/@xmachines/play-react-demo/functions/App.md +13 -0
  79. package/api/@xmachines/play-react-demo/functions/DebugPanel.md +20 -0
  80. package/api/@xmachines/play-react-demo/functions/HeaderNav.md +20 -0
  81. package/api/@xmachines/play-react-demo/functions/Shell.md +22 -0
  82. package/api/@xmachines/play-react-demo/variables/About.md +9 -0
  83. package/api/@xmachines/play-react-demo/variables/Contact.md +9 -0
  84. package/api/@xmachines/play-react-demo/variables/Dashboard.md +9 -0
  85. package/api/@xmachines/play-react-demo/variables/Home.md +9 -0
  86. package/api/@xmachines/play-react-demo/variables/Login.md +9 -0
  87. package/api/@xmachines/play-react-demo/variables/Navigation.md +9 -0
  88. package/api/@xmachines/play-react-demo/variables/Overview.md +9 -0
  89. package/api/@xmachines/play-react-demo/variables/Profile.md +9 -0
  90. package/api/@xmachines/play-react-demo/variables/Settings.md +9 -0
  91. package/api/@xmachines/play-react-demo/variables/Stats.md +9 -0
  92. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  93. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  94. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  95. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  96. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  97. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  98. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  99. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  100. package/api/@xmachines/play-react-router-demo/README.md +10 -10
  101. package/api/@xmachines/play-router/README.md +1 -1
  102. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  103. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  104. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  105. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  106. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  107. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  108. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  109. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  110. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  111. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  112. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  113. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  114. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  115. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  116. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  117. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  118. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  119. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  120. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  121. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  122. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  123. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  124. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  125. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  126. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  127. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  128. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  129. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  130. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  131. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  132. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  133. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  134. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  135. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  136. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  137. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  138. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  139. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  140. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  141. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  142. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  143. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  144. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  145. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  146. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  147. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +0 -6
  148. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +0 -8
  149. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +0 -2
  150. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +0 -10
  151. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +0 -2
  152. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +0 -2
  153. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +0 -2
  154. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +0 -2
  155. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +0 -2
  156. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +0 -2
  157. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +0 -2
  158. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +0 -2
  159. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +0 -2
  160. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +0 -2
  161. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +0 -2
  162. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  163. package/api/@xmachines/play-solid/functions/defineRegistry.md +0 -2
  164. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  165. package/api/@xmachines/play-solid/functions/useStateBinding.md +0 -2
  166. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +0 -2
  167. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +7 -7
  168. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +0 -2
  169. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  170. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  171. package/api/@xmachines/play-solid-demo/README.md +159 -0
  172. package/api/@xmachines/play-solid-demo/functions/App.md +13 -0
  173. package/api/@xmachines/play-solid-demo/functions/DebugPanel.md +20 -0
  174. package/api/@xmachines/play-solid-demo/functions/HeaderNav.md +20 -0
  175. package/api/@xmachines/play-solid-demo/functions/Shell.md +22 -0
  176. package/api/@xmachines/play-solid-demo/variables/About.md +9 -0
  177. package/api/@xmachines/play-solid-demo/variables/Contact.md +9 -0
  178. package/api/@xmachines/play-solid-demo/variables/Dashboard.md +9 -0
  179. package/api/@xmachines/play-solid-demo/variables/Home.md +9 -0
  180. package/api/@xmachines/play-solid-demo/variables/Login.md +9 -0
  181. package/api/@xmachines/play-solid-demo/variables/Navigation.md +9 -0
  182. package/api/@xmachines/play-solid-demo/variables/Overview.md +9 -0
  183. package/api/@xmachines/play-solid-demo/variables/Profile.md +9 -0
  184. package/api/@xmachines/play-solid-demo/variables/Settings.md +9 -0
  185. package/api/@xmachines/play-solid-demo/variables/Stats.md +9 -0
  186. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  187. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  188. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  189. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  190. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -23
  191. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  192. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  193. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  194. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  195. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  196. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  197. package/api/@xmachines/play-solid-router-demo/README.md +25 -28
  198. package/api/@xmachines/play-svelte/functions/defineRegistry.md +0 -2
  199. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +0 -2
  200. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +0 -2
  201. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +7 -7
  202. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +0 -2
  203. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +0 -2
  204. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +0 -2
  205. package/api/@xmachines/play-svelte-demo/README.md +127 -0
  206. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  207. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  208. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  209. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  210. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  211. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  212. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  213. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  214. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  215. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  216. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  217. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  218. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  219. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  220. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  221. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  222. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  223. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  224. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  225. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  226. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  227. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  228. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  229. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  230. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  231. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  232. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  233. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  234. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  235. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  236. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +17 -3
  237. package/api/@xmachines/play-tanstack-react-router-demo/README.md +23 -29
  238. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  239. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  240. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  241. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  242. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  243. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  244. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  245. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  246. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  247. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  248. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  249. package/api/@xmachines/play-tanstack-solid-router-demo/README.md +25 -26
  250. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  251. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  252. package/api/@xmachines/play-vue/functions/useStateBinding.md +0 -2
  253. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +0 -2
  254. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  255. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  256. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +0 -2
  257. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  258. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +4 -3
  259. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  260. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  261. package/api/@xmachines/play-vue-demo/README.md +145 -0
  262. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  263. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  264. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  265. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  266. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  267. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  268. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  269. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  270. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  271. package/api/@xmachines/play-vue-router-demo/README.md +48 -41
  272. package/api/@xmachines/play-xstate/classes/PlayerActor.md +11 -25
  273. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  274. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  275. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  276. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  277. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  278. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  279. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  280. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  281. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  282. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  283. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  284. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  285. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  286. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  287. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  288. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  289. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  290. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  291. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  292. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  293. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  294. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +3 -7
  295. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  296. package/api/README.md +6 -2
  297. package/api/llms.txt +0 -3
  298. package/examples/README.md +48 -35
  299. package/examples/basic-state-machine.md +75 -31
  300. package/examples/form-validation.md +199 -127
  301. package/examples/multi-router-integration.md +312 -230
  302. package/examples/routing-patterns.md +243 -189
  303. package/examples/traffic-light.md +114 -65
  304. package/guides/README.md +29 -15
  305. package/guides/getting-started.md +224 -144
  306. package/guides/installation.md +153 -213
  307. package/package.json +2 -2
  308. package/api/@xmachines/play-svelte-spa-router-demo/README.md +0 -23
  309. package/api/@xmachines/play-sveltekit-router-demo/README.md +0 -23
@@ -2,12 +2,12 @@
2
2
 
3
3
  # Vue Router Demo
4
4
 
5
- Vue Router integration demonstrating Play Architecture with Vue Composition API.
5
+ Vue Router integration demo for the XMachines Play architecture using Vue Composition API.
6
6
 
7
7
  ## What This Demonstrates
8
8
 
9
9
  - Shared auth machine reused without framework-specific business logic
10
- - `PlayVueRouterProvider` renderer-based integration with Vue Router
10
+ - `PlayRouterProvider` renderer-based integration with Vue Router
11
11
  - Shell-driven rendering via `PlayRenderer` with actor-authoritative navigation
12
12
  - Vue Composition API mapping to TC39 Signals lifecycle
13
13
  - Non-browser invariant tests plus browser E2E coverage
@@ -18,25 +18,25 @@ From the repository root:
18
18
 
19
19
  ```bash
20
20
  npm install
21
- npm run dev -w packages/play-vue-router/examples/demo
21
+ npm run dev -w @xmachines/play-vue-router-demo
22
22
  ```
23
23
 
24
- Visit `http://localhost:5173`.
24
+ Then open `http://localhost:3001`.
25
25
 
26
26
  ## Step-by-Step Code Flow
27
27
 
28
28
  Use this order to understand how the demo is wired:
29
29
 
30
- 1. `src/main.ts` creates the actor via `definePlayer({ machine: authMachine, catalog })`.
31
- 2. `src/router.ts` installs one catch-all route; `PlayRenderer` selects the actual view from actor state.
32
- 3. `src/App.vue` uses `PlayVueRouterProvider` + `createRouteMap(authMachine)` with a renderer function to connect router navigation and actor routing events.
33
- 4. Provider waits for `router.isReady()` so direct URL loads are handled correctly.
34
- 5. `src/Shell.vue` renders actor-projected state (`PlayRenderer`) and sends events back to the actor.
30
+ 1. `src/main.ts` calls `definePlayer({ machine: authMachine })`, starts the actor, creates the Vue app, provides the actor, installs Vue Router, and mounts.
31
+ 2. `src/router.ts` installs a single catch-all route; `PlayRenderer` selects the actual view from actor state.
32
+ 3. `src/App.vue` calls `createRouteMap(authMachine)` and renders `<PlayRouterProvider>` with the actor, route map, router instance, and a `renderShell` renderer function.
33
+ 4. The renderer function creates the shared `Shell` component with actor, router, and registry as props.
34
+ 5. `PlayRouterProvider` waits for `router.isReady()` so direct URL loads are handled correctly.
35
35
  6. Browser tests in `test/browser/` validate startup and auth route transitions.
36
36
 
37
37
  ```ts
38
38
  // src/main.ts (shape)
39
- const createPlayer = definePlayer({ machine: authMachine, catalog });
39
+ const createPlayer = definePlayer({ machine: authMachine });
40
40
  const actor = createPlayer();
41
41
  actor.start();
42
42
 
@@ -51,13 +51,24 @@ app.mount("#app");
51
51
  export const routes = [{ path: "/:pathMatch(.*)*", name: "xmachines-play", component: RouteHost }];
52
52
  ```
53
53
 
54
- ```ts
55
- // src/App.vue (renderer shape)
54
+ ```vue
55
+ <!-- src/App.vue (shape) -->
56
+ <script setup lang="ts">
57
+ const actor = inject<AuthActor>("actor")!;
58
+ const routeMap = createRouteMap(authMachine);
59
+
56
60
  const renderShell = (currentActor, currentRouter) =>
57
- h(Shell, {
58
- actor: currentActor,
59
- router: currentRouter,
60
- });
61
+ h(SharedShell, { actor: currentActor, router: currentRouter, registry });
62
+ </script>
63
+
64
+ <template>
65
+ <PlayRouterProvider
66
+ :actor="actor"
67
+ :route-map="routeMap"
68
+ :router="router"
69
+ :renderer="renderShell"
70
+ />
71
+ </template>
61
72
  ```
62
73
 
63
74
  ```vue
@@ -70,26 +81,23 @@ const login = () => actor.send({ type: "auth.login", username: "demo" });
70
81
 
71
82
  ## Key Files
72
83
 
73
- - `src/main.ts` - actor creation/start and app mount
84
+ - `src/main.ts` - actor creation/start and Vue app mount with actor injection
74
85
  - `src/router.ts` - single catch-all route record
75
- - `src/App.vue` - provider wiring and renderer composition
76
- - `src/Shell.vue` - actor-driven demo shell with nav, renderer, and debug panel
77
- - `src/components/` - route and page view components
78
- - `test/browser/startup.browser.test.ts` - startup check for home + login link rendering
79
- - `test/browser/auth-flow.browser.test.ts` - login -> dashboard -> profile -> logout browser flow
86
+ - `src/App.vue` - `createRouteMap`, `PlayRouterProvider` wiring, and renderer composition
80
87
  - `test/reactivity.test.ts` - reactive integration assertions
88
+ - `test/browser/shared-demo.browser.test.ts` - browser startup and full auth flow coverage
81
89
 
82
90
  ## State Machine & Architecture Details
83
91
 
84
92
  The demo utilizes XMachines architectural invariants:
85
93
 
86
- 1. **Actor Authority:** When a user navigates to a protected route via a link, Vue Router updates the location. The `PlayVueRouterProvider` intercepts this, translates it to a `play.route` event, and sends it to the actor. The actor evaluates guards (e.g. `isAuthenticated`) and transitions.
94
+ 1. **Actor Authority:** When a user navigates to a protected route via a link, Vue Router updates the location. The `PlayRouterProvider` intercepts this, translates it to a `play.route` event, and sends it to the actor. The actor evaluates guards (e.g. `isAuthenticated`) and transitions.
87
95
  2. **Passive Infrastructure:** The router does not execute Vue route guards for business logic. The actor dictates whether navigation is permitted. The Vue application only renders the state.
88
96
  3. **Signal-Only Reactivity:** The bridge leverages Vue's `watch` and `triggerRef` internally to react precisely when signals update, without polluting the Vue component tree with reactive refs that hold business state.
89
97
 
90
98
  ## Watcher Lifecycle and Cleanup Contract
91
99
 
92
- This demo uses the canonical watcher lifecycle:
100
+ This demo follows the canonical watcher lifecycle:
93
101
 
94
102
  1. `notify`
95
103
  2. `queueMicrotask`
@@ -97,7 +105,7 @@ This demo uses the canonical watcher lifecycle:
97
105
  4. Read actor signals and sync Vue-local render state
98
106
  5. Re-arm with `watch()`/`watch(...signals)`
99
107
 
100
- Notifications are one-shot, so re-arm is required. Teardown is explicit: provider/bridge cleanup must flow through `disconnect` and watcher `unwatch`, not GC-only assumptions. The `PlayVueRouterProvider` wires this seamlessly into the component's `onUnmounted` hook.
108
+ Notifications are one-shot, so re-arm is required. Teardown is explicit: provider/bridge cleanup must flow through `disconnect` and watcher `unwatch`, not GC-only assumptions. The `PlayRouterProvider` wires this seamlessly into the component's `onUnmounted` hook.
101
109
 
102
110
  ## Adapter Boundaries
103
111
 
@@ -105,29 +113,28 @@ Vue Router integration remains passive infrastructure. `RouterBridgeBase` owns s
105
113
 
106
114
  ## Available Scripts
107
115
 
108
- ```bash
109
- npm run dev # Start Vite dev server (default: http://localhost:5173)
110
- npm run build # Build production assets
111
- npm run preview # Preview production build locally
112
- npm run test # Run unit/integration tests via Vitest
113
- npm run test:browser # Run browser-mode tests via vitest.browser.config.ts
114
- ```
116
+ These commands are defined in `package.json`:
117
+
118
+ | Command | Description |
119
+ | --------------------------------------------------------- | -------------------------------- |
120
+ | `npm run dev -w @xmachines/play-vue-router-demo` | Start Vite dev server |
121
+ | `npm run build -w @xmachines/play-vue-router-demo` | Build production bundle |
122
+ | `npm run preview -w @xmachines/play-vue-router-demo` | Preview built bundle |
123
+ | `npm run test -w @xmachines/play-vue-router-demo` | Run Vitest test suite |
124
+ | `npm run test:browser -w @xmachines/play-vue-router-demo` | Run browser-focused Vitest suite |
115
125
 
116
126
  ## Verification
117
127
 
118
- Use these checks from this directory:
128
+ Use these checks to validate README claims against the current demo implementation:
119
129
 
120
130
  ```bash
121
- npm run test
122
- npm run test:browser
131
+ npm run test -w @xmachines/play-vue-router-demo
132
+ npm run test:browser -w @xmachines/play-vue-router-demo
123
133
  ```
124
134
 
125
- Manual sanity check:
126
-
127
- 1. Start with `npm run dev`.
128
- 2. Open `http://localhost:5173`.
129
- 3. Confirm login/logout transitions update both view and URL, and that accessing protected routes while logged out redirects properly.
135
+ Expected result: reactivity integration tests and the browser shared-demo suite both pass, confirming login/logout transitions update both view and URL correctly.
130
136
 
131
137
  ## Learn More
132
138
 
133
- - **[Vue Router Adapter README](../play-vue-router/README.md)** - Package-level API and bridge docs
139
+ - [Vue Router package README](../play-vue-router/README.md)
140
+ - [Vue package README](../play-vue/README.md)
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayerActor\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/player-actor.ts:348](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/player-actor.ts#L348)
5
+ Defined in: [packages/play-xstate/src/player-actor.ts:348](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/player-actor.ts#L348)
6
6
 
7
7
  Concrete XState actor implementing Play Architecture signal protocol
8
8
 
@@ -109,7 +109,7 @@ new PlayerActor<TMachine>(
109
109
  _cachedInitialRoute?): PlayerActor<TMachine>;
110
110
  ```
111
111
 
112
- Defined in: [packages/play-xstate/src/player-actor.ts:426](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/player-actor.ts#L426)
112
+ Defined in: [packages/play-xstate/src/player-actor.ts:426](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/player-actor.ts#L426)
113
113
 
114
114
  #### Parameters
115
115
 
@@ -135,16 +135,16 @@ Defined in: [packages/play-xstate/src/player-actor.ts:426](https://gitlab.com/xm
135
135
  | ------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
136
136
  | <a id="property-_parent"></a> `_parent?` | `public` | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef) | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`_parent`](../../play-actor/classes/AbstractActor.md#property-_parent) | - |
137
137
  | <a id="property-clock"></a> `clock` | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock) | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions. | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`clock`](../../play-actor/classes/AbstractActor.md#property-clock) | - |
138
- | <a id="property-currentroute"></a> `currentRoute` | `public` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | A TC39 `Signal.Computed` that derives the current URL path from the active machine state's `meta.route` template and the actor's context. Returns `null` when the current state has no `meta.route`, or when the route template cannot be fully resolved (e.g. a required parameter is absent from context). **Throws** When a required `:param` placeholder in the route template has no matching value in the actor's context. Import the class from `@xmachines/play-xstate/errors`. **Example** `// Returns "/profile/alice" when context.userId === "alice" const route = actor.currentRoute.get();` | - | - | [packages/play-xstate/src/player-actor.ts:378](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/player-actor.ts#L378) |
139
- | <a id="property-currentview"></a> `currentView` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`ViewMetadata`](../../play-actor/interfaces/ViewMetadata.md) \| `null`\> | Reactive signal containing the current view spec derived from the active state's `meta.view` metadata. Always emits a **fresh object reference** on every state transition (including self-transitions with `reenter: true`) so TC39 Signal equality checks reliably detect changes. The emitted `ViewMetadata` has its spec element `props` enriched with `context.params` before emission — URL path parameters (e.g. `:section?`) flow into component props automatically. See `mergeRouteParamsIntoProps` for the merge priority rules. Returns `null` when the current state has no `meta.view` metadata. **Example** `const view = actor.currentView.get(); if (view) { console.log(view.component); // e.g. "Dashboard" console.log(view.spec); // @json-render/core Spec object }` | - | - | [packages/play-xstate/src/player-actor.ts:424](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/player-actor.ts#L424) |
138
+ | <a id="property-currentroute"></a> `currentRoute` | `public` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | A TC39 `Signal.Computed` that derives the current URL path from the active machine state's `meta.route` template and the actor's context. Returns `null` when the current state has no `meta.route`, or when the route template cannot be fully resolved (e.g. a required parameter is absent from context). **Throws** When a required `:param` placeholder in the route template has no matching value in the actor's context. Import the class from `@xmachines/play-xstate/errors`. **Example** `// Returns "/profile/alice" when context.userId === "alice" const route = actor.currentRoute.get();` | - | - | [packages/play-xstate/src/player-actor.ts:378](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/player-actor.ts#L378) |
139
+ | <a id="property-currentview"></a> `currentView` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`ViewMetadata`](../../play-actor/interfaces/ViewMetadata.md) \| `null`\> | Reactive signal containing the current view spec derived from the active state's `meta.view` metadata. Always emits a **fresh object reference** on every state transition (including self-transitions with `reenter: true`) so TC39 Signal equality checks reliably detect changes. The emitted `ViewMetadata` has its spec element `props` enriched with `context.params` before emission — URL path parameters (e.g. `:section?`) flow into component props automatically. See `mergeRouteParamsIntoProps` for the merge priority rules. Returns `null` when the current state has no `meta.view` metadata. **Example** `const view = actor.currentView.get(); if (view) { console.log(view.component); // e.g. "Dashboard" console.log(view.spec); // @json-render/core Spec object }` | - | - | [packages/play-xstate/src/player-actor.ts:424](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/player-actor.ts#L424) |
140
140
  | <a id="property-id"></a> `id` | `public` | `string` | The unique identifier for this actor relative to its parent. | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`id`](../../play-actor/classes/AbstractActor.md#property-id) | - |
141
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction, never changes even when the actor is restored from a snapshot. Router bridges compare this against the browser URL to distinguish a deep-link (non-initial URL → router wins) from a restore (initial URL + actor at a different restored route → actor wins). Determined by the machine's initial state node and its `meta.route` template — both are fixed at machine definition time. `definePlayer` pre-computes this value once from the machine definition and passes it to every actor it constructs, so no extra `createActor()` call is needed per construction. When `PlayerActor` is constructed directly (without `definePlayer`), the value is derived from `xstateActor.getSnapshot()` (normal path) or a transient `createActor(machine, { input })` call (restore path, to avoid using the snapshot's state instead of the machine's default). | - | - | [packages/play-xstate/src/player-actor.ts:398](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/player-actor.ts#L398) |
141
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction, never changes even when the actor is restored from a snapshot. Router bridges compare this against the browser URL to distinguish a deep-link (non-initial URL → router wins) from a restore (initial URL + actor at a different restored route → actor wins). Determined by the machine's initial state node and its `meta.route` template — both are fixed at machine definition time. `definePlayer` pre-computes this value once from the machine definition and passes it to every actor it constructs, so no extra `createActor()` call is needed per construction. When `PlayerActor` is constructed directly (without `definePlayer`), the value is derived from `xstateActor.getSnapshot()` (normal path) or a transient `createActor(machine, { input })` call (restore path, to avoid using the snapshot's state instead of the machine's default). | - | - | [packages/play-xstate/src/player-actor.ts:398](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/player-actor.ts#L398) |
142
142
  | <a id="property-logic"></a> `logic` | `public` | [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`logic`](../../play-actor/classes/AbstractActor.md#property-logic) | - |
143
143
  | <a id="property-options"></a> `options` | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\> | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`options`](../../play-actor/classes/AbstractActor.md#property-options) | - |
144
144
  | <a id="property-ref"></a> `ref` | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<`any`, `any`, `any`\> | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`ref`](../../play-actor/classes/AbstractActor.md#property-ref) | - |
145
145
  | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`sessionId`](../../play-actor/classes/AbstractActor.md#property-sessionid) | - |
146
146
  | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`src`](../../play-actor/classes/AbstractActor.md#property-src) | - |
147
- | <a id="property-state"></a> `state` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`AnyMachineSnapshot`](https://www.jsdocs.io/package/xstate#AnyMachineSnapshot)\> | 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. | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`state`](../../play-actor/classes/AbstractActor.md#property-state) | - | [packages/play-xstate/src/player-actor.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/player-actor.ts#L358) |
147
+ | <a id="property-state"></a> `state` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`AnyMachineSnapshot`](https://www.jsdocs.io/package/xstate#AnyMachineSnapshot)\> | 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. | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`state`](../../play-actor/classes/AbstractActor.md#property-state) | - | [packages/play-xstate/src/player-actor.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/player-actor.ts#L358) |
148
148
  | <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`system`](../../play-actor/classes/AbstractActor.md#property-system) | - |
149
149
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`systemId`](../../play-actor/classes/AbstractActor.md#property-systemid) | - |
150
150
 
@@ -156,8 +156,6 @@ Defined in: [packages/play-xstate/src/player-actor.ts:426](https://gitlab.com/xm
156
156
  observable: InteropSubscribable<any>;
157
157
  ```
158
158
 
159
- Defined in: `xstate`
160
-
161
159
  #### Returns
162
160
 
163
161
  [`InteropSubscribable`](https://www.jsdocs.io/package/xstate#InteropSubscribable)\<`any`\>
@@ -174,7 +172,7 @@ Defined in: `xstate`
174
172
  dispose(): void;
175
173
  ```
176
174
 
177
- Defined in: [packages/play-xstate/src/player-actor.ts:638](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/player-actor.ts#L638)
175
+ Defined in: [packages/play-xstate/src/player-actor.ts:638](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/player-actor.ts#L638)
178
176
 
179
177
  Convenience dispose method for cleanup
180
178
 
@@ -192,8 +190,6 @@ Per CONTEXT.md: "Both .dispose() convenience method and manual machine.stop()"
192
190
  getPersistedSnapshot(): Snapshot<unknown>;
193
191
  ```
194
192
 
195
- Defined in: `xstate`
196
-
197
193
  Obtain the internal state of the actor, which can be persisted.
198
194
 
199
195
  #### Returns
@@ -226,7 +222,7 @@ https://stately.ai/docs/persistence
226
222
  getSnapshot(): SnapshotFrom<TMachine>;
227
223
  ```
228
224
 
229
- Defined in: [packages/play-xstate/src/player-actor.ts:607](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/player-actor.ts#L607)
225
+ Defined in: [packages/play-xstate/src/player-actor.ts:607](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/player-actor.ts#L607)
230
226
 
231
227
  Get current snapshot
232
228
 
@@ -246,8 +242,6 @@ Get current snapshot
246
242
  on<TType>(type, handler): Subscription;
247
243
  ```
248
244
 
249
- Defined in: `xstate`
250
-
251
245
  #### Type Parameters
252
246
 
253
247
  | Type Parameter |
@@ -277,8 +271,6 @@ Defined in: `xstate`
277
271
  select<TSelected>(selector, equalityFn?): Readable<TSelected>;
278
272
  ```
279
273
 
280
- Defined in: `xstate`
281
-
282
274
  #### Type Parameters
283
275
 
284
276
  | Type Parameter |
@@ -308,7 +300,7 @@ Defined in: `xstate`
308
300
  send(event): void;
309
301
  ```
310
302
 
311
- Defined in: [packages/play-xstate/src/player-actor.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/player-actor.ts#L584)
303
+ Defined in: [packages/play-xstate/src/player-actor.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/player-actor.ts#L584)
312
304
 
313
305
  Send an event to the underlying XState actor.
314
306
 
@@ -352,7 +344,7 @@ actor.send({ type: "play.route", to: "#home" });
352
344
  start(): this;
353
345
  ```
354
346
 
355
- Defined in: [packages/play-xstate/src/player-actor.ts:538](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/player-actor.ts#L538)
347
+ Defined in: [packages/play-xstate/src/player-actor.ts:538](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/player-actor.ts#L538)
356
348
 
357
349
  Start the actor
358
350
 
@@ -374,7 +366,7 @@ Per RESEARCH.md Pitfall 1: Always call start() after creation
374
366
  stop(): this;
375
367
  ```
376
368
 
377
- Defined in: [packages/play-xstate/src/player-actor.ts:552](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/player-actor.ts#L552)
369
+ Defined in: [packages/play-xstate/src/player-actor.ts:552](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/player-actor.ts#L552)
378
370
 
379
371
  Stop the actor and cleanup
380
372
 
@@ -396,8 +388,6 @@ Stop the actor and cleanup
396
388
  subscribe(observer): Subscription;
397
389
  ```
398
390
 
399
- Defined in: `xstate`
400
-
401
391
  Subscribe an observer to an actor’s snapshot values.
402
392
 
403
393
  ##### Parameters
@@ -472,8 +462,6 @@ subscribe(
472
462
  completeListener?): Subscription;
473
463
  ```
474
464
 
475
- Defined in: `xstate`
476
-
477
465
  Subscribe an observer to an actor’s snapshot values.
478
466
 
479
467
  ##### Parameters
@@ -549,8 +537,6 @@ unsubscribed.
549
537
  toJSON(): object;
550
538
  ```
551
539
 
552
- Defined in: `xstate`
553
-
554
540
  #### Returns
555
541
 
556
542
  `object`
@@ -6,7 +6,7 @@
6
6
  function buildRouteUrl(routeTemplate, context?): string;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/build-url.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/build-url.ts#L40)
9
+ Defined in: [packages/play-xstate/src/routing/build-url.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/routing/build-url.ts#L40)
10
10
 
11
11
  Build a full URL from a route template and the actor's context.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function composeGuards<TContext, TEvent>(guards): ComposedGuard;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/compose.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/guards/compose.ts#L77)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/guards/compose.ts#L77)
10
10
 
11
11
  Compose guards with AND logic using XState's and() helper
12
12
 
@@ -6,7 +6,7 @@
6
6
  function composeGuardsOr<TContext, TEvent>(guards): ComposedGuard;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/compose.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/guards/compose.ts#L143)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/guards/compose.ts#L143)
10
10
 
11
11
  Compose guards with OR logic using XState's or() helper
12
12
 
@@ -6,7 +6,7 @@
6
6
  function contextFieldMatches<TContext>(fieldPath, expectedValue): Guard<TContext, PlayEvent>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/helpers.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/guards/helpers.ts#L68)
9
+ Defined in: [packages/play-xstate/src/guards/helpers.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/guards/helpers.ts#L68)
10
10
 
11
11
  Check if a context field matches an expected value.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function definePlayer<TMachine>(config): PlayerFactory<TMachine>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/define-player.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/define-player.ts#L61)
9
+ Defined in: [packages/play-xstate/src/define-player.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/define-player.ts#L61)
10
10
 
11
11
  Create a player factory from an XState machine
12
12
 
@@ -6,7 +6,7 @@
6
6
  function deriveRoute(stateMeta): string | null;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/derive-route.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/derive-route.ts#L90)
9
+ Defined in: [packages/play-xstate/src/routing/derive-route.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/routing/derive-route.ts#L90)
10
10
 
11
11
  Derive route from XState state metadata
12
12
 
@@ -6,7 +6,7 @@
6
6
  function eventMatches<TEvent>(eventType): Guard<unknown, TEvent>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/helpers.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/guards/helpers.ts#L49)
9
+ Defined in: [packages/play-xstate/src/guards/helpers.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/guards/helpers.ts#L49)
10
10
 
11
11
  Check if event type matches expected type
12
12
 
@@ -6,7 +6,7 @@
6
6
  function formatPlayRouteTransitions<T>(machineConfig): T;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/format-play-route-transitions.ts#L84)
9
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/routing/format-play-route-transitions.ts#L84)
10
10
 
11
11
  Formats play.route transitions from declarative route configs
12
12
 
@@ -6,7 +6,7 @@
6
6
  function hasContext<TContext>(path): Guard<TContext, PlayEvent>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/helpers.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/guards/helpers.ts#L23)
9
+ Defined in: [packages/play-xstate/src/guards/helpers.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/guards/helpers.ts#L23)
10
10
 
11
11
  Check if context has a truthy value at path
12
12
 
@@ -6,7 +6,7 @@
6
6
  function isAbsoluteRoute(path): boolean;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/derive-route.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/derive-route.ts#L150)
9
+ Defined in: [packages/play-xstate/src/routing/derive-route.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/routing/derive-route.ts#L150)
10
10
 
11
11
  Check if route path is absolute
12
12
 
@@ -6,7 +6,7 @@
6
6
  function negateGuard<TContext, TEvent>(guard): ComposedGuard;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/compose.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/guards/compose.ts#L203)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/guards/compose.ts#L203)
10
10
 
11
11
  Negate a guard using XState's not() helper
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayerConfig\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/types.ts#L7)
5
+ Defined in: [packages/play-xstate/src/types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/types.ts#L7)
6
6
 
7
7
  Configuration for definePlayer()
8
8
 
@@ -16,5 +16,5 @@ Configuration for definePlayer()
16
16
 
17
17
  | Property | Type | Description | Defined in |
18
18
  | ---------------------------------------- | ------------------------------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | <a id="property-machine"></a> `machine` | `TMachine` | XState v5 state machine | [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/types.ts#L9) |
20
- | <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\> | Lifecycle hooks and configuration | [packages/play-xstate/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/types.ts#L12) |
19
+ | <a id="property-machine"></a> `machine` | `TMachine` | XState v5 state machine | [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/types.ts#L9) |
20
+ | <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\> | Lifecycle hooks and configuration | [packages/play-xstate/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/types.ts#L12) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayerFactoryResumeOptions\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/types.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/types.ts#L47)
5
+ Defined in: [packages/play-xstate/src/types.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/types.ts#L47)
6
6
 
7
7
  Optional restore arguments for the player factory.
8
8
 
@@ -19,4 +19,4 @@ Mirrors XState's createActor options bag while preserving the existing
19
19
 
20
20
  | Property | Type | Description | Defined in |
21
21
  | ------------------------------------------ | --------------------------------------------------------------------------------- | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
22
- | <a id="property-snapshot"></a> `snapshot?` | [`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\> | Persisted XState snapshot used to restore actor state. | [packages/play-xstate/src/types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/types.ts#L49) |
22
+ | <a id="property-snapshot"></a> `snapshot?` | [`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\> | Persisted XState snapshot used to restore actor state. | [packages/play-xstate/src/types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/types.ts#L49) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayerOptions\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/types.ts#L20)
5
+ Defined in: [packages/play-xstate/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/types.ts#L20)
6
6
 
7
7
  Player lifecycle hooks
8
8
 
@@ -18,8 +18,8 @@ Per CONTEXT.md: Rich set of hooks for observability
18
18
 
19
19
  | Property | Type | Description | Defined in |
20
20
  | ---------------------------------------------------- | --------------------------------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
21
- | <a id="property-onerror"></a> `onError?` | (`actor`, `error`) => `void` | Called on actor errors | [packages/play-xstate/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/types.ts#L38) |
22
- | <a id="property-onstart"></a> `onStart?` | (`actor`) => `void` | Called when actor starts | [packages/play-xstate/src/types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/types.ts#L22) |
23
- | <a id="property-onstatechange"></a> `onStateChange?` | (`actor`, `state`) => `void` | Called when state signal changes | [packages/play-xstate/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/types.ts#L35) |
24
- | <a id="property-onstop"></a> `onStop?` | (`actor`) => `void` | Called when actor stops | [packages/play-xstate/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/types.ts#L25) |
25
- | <a id="property-ontransition"></a> `onTransition?` | (`actor`, `prevState`, `nextState`) => `void` | Called on every state transition | [packages/play-xstate/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/types.ts#L28) |
21
+ | <a id="property-onerror"></a> `onError?` | (`actor`, `error`) => `void` | Called on actor errors | [packages/play-xstate/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/types.ts#L38) |
22
+ | <a id="property-onstart"></a> `onStart?` | (`actor`) => `void` | Called when actor starts | [packages/play-xstate/src/types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/types.ts#L22) |
23
+ | <a id="property-onstatechange"></a> `onStateChange?` | (`actor`, `state`) => `void` | Called when state signal changes | [packages/play-xstate/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/types.ts#L35) |
24
+ | <a id="property-onstop"></a> `onStop?` | (`actor`) => `void` | Called when actor stops | [packages/play-xstate/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/types.ts#L25) |
25
+ | <a id="property-ontransition"></a> `onTransition?` | (`actor`, `prevState`, `nextState`) => `void` | Called on every state transition | [packages/play-xstate/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/types.ts#L28) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteContext
4
4
 
5
- Defined in: [packages/play-xstate/src/routing/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/types.ts#L19)
5
+ Defined in: [packages/play-xstate/src/routing/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/routing/types.ts#L19)
6
6
 
7
7
  Route build context from machine context.
8
8
 
@@ -18,7 +18,7 @@ must populate `params` explicitly.
18
18
 
19
19
  | Property | Type | Description | Defined in |
20
20
  | ------------------------------------------ | ------------------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
- | <a id="property-basepath"></a> `basePath?` | `string` | Base path for relative routes | [packages/play-xstate/src/routing/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/types.ts#L21) |
22
- | <a id="property-hash"></a> `hash?` | `string` | Hash fragment | [packages/play-xstate/src/routing/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/types.ts#L27) |
23
- | <a id="property-params"></a> `params?` | `Record`\<`string`, `unknown`\> | Path-only route parameters to substitute (e.g., `:userId` from `/profile/:userId`) | [packages/play-xstate/src/routing/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/types.ts#L23) |
24
- | <a id="property-query"></a> `query?` | `Record`\<`string`, `unknown`\> | Query parameters | [packages/play-xstate/src/routing/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/types.ts#L25) |
21
+ | <a id="property-basepath"></a> `basePath?` | `string` | Base path for relative routes | [packages/play-xstate/src/routing/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/routing/types.ts#L21) |
22
+ | <a id="property-hash"></a> `hash?` | `string` | Hash fragment | [packages/play-xstate/src/routing/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/routing/types.ts#L27) |
23
+ | <a id="property-params"></a> `params?` | `Record`\<`string`, `unknown`\> | Path-only route parameters to substitute (e.g., `:userId` from `/profile/:userId`) | [packages/play-xstate/src/routing/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/routing/types.ts#L23) |
24
+ | <a id="property-query"></a> `query?` | `Record`\<`string`, `unknown`\> | Query parameters | [packages/play-xstate/src/routing/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/routing/types.ts#L25) |
@@ -6,7 +6,7 @@
6
6
  type ComposedGuard = GuardPredicate<MachineContext, EventObject, unknown, ParameterizedObject>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/compose.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/guards/compose.ts#L14)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/guards/compose.ts#L14)
10
10
 
11
11
  Narrowest public return type for guard composition helpers.
12
12
 
@@ -6,7 +6,7 @@
6
6
  type Guard<TContext, TEvent> = (args) => boolean;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/guards/types.ts#L13)
9
+ Defined in: [packages/play-xstate/src/guards/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/guards/types.ts#L13)
10
10
 
11
11
  Standard XState guard function signature
12
12
 
@@ -6,7 +6,7 @@
6
6
  type GuardArray<TContext, TEvent> = Guard<TContext, TEvent>[] | string[];
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/guards/types.ts#L23)
9
+ Defined in: [packages/play-xstate/src/guards/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-xstate/src/guards/types.ts#L23)
10
10
 
11
11
  Array of guard predicates or guard names
12
12