@xmachines/docs 1.0.0-beta.27 → 1.0.0-beta.29

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 (288) hide show
  1. package/api/@xmachines/play/README.md +4 -4
  2. package/api/@xmachines/play/classes/PlayError.md +4 -4
  3. package/api/@xmachines/play/type-aliases/PlayEvent.md +3 -3
  4. package/api/@xmachines/play-actor/README.md +6 -6
  5. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  6. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  7. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  8. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  9. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  10. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  11. package/api/@xmachines/play-dom/README.md +50 -0
  12. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  13. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  14. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  15. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  16. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  17. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  18. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +3 -3
  19. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +3 -3
  20. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +7 -7
  21. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  22. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +3 -3
  23. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  24. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  25. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  26. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  27. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  28. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  29. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  30. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  31. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  32. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  33. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  34. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  35. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  36. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  37. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  38. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +4 -4
  39. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  40. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  41. package/api/@xmachines/play-react/README.md +1 -1
  42. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  43. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  44. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  45. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  46. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  47. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +7 -7
  48. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  49. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  50. package/api/@xmachines/play-react-router/README.md +3 -3
  51. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  52. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  53. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  54. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  55. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  56. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  57. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  58. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +4 -4
  59. package/api/@xmachines/play-router/README.md +6 -6
  60. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  61. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  62. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  63. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  64. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  65. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  66. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  67. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  68. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  69. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  70. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  71. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  72. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  73. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  74. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  75. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  76. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  77. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  78. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  79. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  80. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  81. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  82. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  83. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  84. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  85. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  86. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +7 -7
  87. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  88. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  89. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  90. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  91. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  92. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  93. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  94. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  95. package/api/@xmachines/play-router/interfaces/RouterBridge.md +4 -4
  96. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  97. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  98. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  99. package/api/@xmachines/play-signals/README.md +2 -2
  100. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  101. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  102. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  103. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  104. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  105. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  106. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  107. package/api/@xmachines/play-solid/README.md +3 -3
  108. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  109. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +7 -7
  110. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  111. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  112. package/api/@xmachines/play-solid-router/README.md +1 -1
  113. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  114. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  115. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  116. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  117. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  118. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  119. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  120. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  121. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +4 -4
  122. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  123. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  124. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +7 -7
  125. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  126. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  127. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  128. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  129. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  130. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  131. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +4 -4
  132. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  133. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  134. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  135. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  136. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  137. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  138. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  139. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  140. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  141. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +4 -4
  142. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  143. package/api/@xmachines/play-tanstack-react-router/README.md +4 -4
  144. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  145. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  146. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  147. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  148. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  149. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  150. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  151. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  152. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  153. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  154. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +4 -4
  155. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  156. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  157. package/api/@xmachines/play-tanstack-solid-router/README.md +5 -5
  158. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  159. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  160. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  161. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  162. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  163. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  164. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  165. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +4 -4
  166. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  167. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  168. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  169. package/api/@xmachines/play-vue/README.md +1 -1
  170. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  171. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  172. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  173. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  174. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  175. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  176. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  177. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  178. package/api/@xmachines/play-vue-router/README.md +1 -1
  179. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  180. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  181. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  182. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  183. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +7 -7
  184. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  185. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +4 -4
  186. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  187. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  188. package/api/@xmachines/play-xstate/README.md +10 -10
  189. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  190. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  191. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  192. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  193. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  194. package/api/@xmachines/play-xstate/functions/definePlayer.md +2 -2
  195. package/api/@xmachines/play-xstate/functions/deriveRoute.md +2 -2
  196. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  197. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  198. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  199. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  200. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  201. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  202. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  203. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  204. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  205. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  206. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  207. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  208. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  209. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  210. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  211. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  212. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  213. package/api/README.md +1 -37
  214. package/api/llms.txt +4 -11
  215. package/examples/@xmachines/play-actor-shared/README.md +155 -0
  216. package/examples/@xmachines/play-actor-shared/interfaces/AuthContext.md +14 -0
  217. package/examples/@xmachines/play-actor-shared/type-aliases/AuthActor.md +27 -0
  218. package/examples/@xmachines/play-actor-shared/type-aliases/AuthCatalog.md +16 -0
  219. package/examples/@xmachines/play-actor-shared/type-aliases/AuthEvents.md +17 -0
  220. package/examples/@xmachines/play-actor-shared/type-aliases/AuthInput.md +9 -0
  221. package/examples/@xmachines/play-actor-shared/type-aliases/AuthSnapshot.md +11 -0
  222. package/examples/@xmachines/play-actor-shared/type-aliases/CatalogProps.md +187 -0
  223. package/examples/@xmachines/play-actor-shared/type-aliases/InferProps.md +17 -0
  224. package/examples/@xmachines/play-actor-shared/variables/authCatalog.md +173 -0
  225. package/examples/@xmachines/play-actor-shared/variables/authMachine.md +189 -0
  226. package/examples/@xmachines/play-actor-shared/variables/authSetup.md +22 -0
  227. package/examples/@xmachines/play-dom-demo/README.md +145 -0
  228. package/examples/@xmachines/play-dom-demo/functions/initShell.md +20 -0
  229. package/examples/@xmachines/play-dom-demo/variables/About.md +9 -0
  230. package/examples/@xmachines/play-dom-demo/variables/Contact.md +9 -0
  231. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +9 -0
  232. package/examples/@xmachines/play-dom-demo/variables/Home.md +9 -0
  233. package/examples/@xmachines/play-dom-demo/variables/Login.md +9 -0
  234. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +9 -0
  235. package/examples/@xmachines/play-dom-demo/variables/Overview.md +9 -0
  236. package/examples/@xmachines/play-dom-demo/variables/Profile.md +9 -0
  237. package/examples/@xmachines/play-dom-demo/variables/Settings.md +9 -0
  238. package/examples/@xmachines/play-dom-demo/variables/Stats.md +9 -0
  239. package/{api → examples}/@xmachines/play-dom-router-demo/README.md +13 -13
  240. package/examples/@xmachines/play-react-demo/README.md +173 -0
  241. package/examples/@xmachines/play-react-demo/functions/App.md +13 -0
  242. package/examples/@xmachines/play-react-demo/functions/DebugPanel.md +20 -0
  243. package/examples/@xmachines/play-react-demo/functions/HeaderNav.md +20 -0
  244. package/examples/@xmachines/play-react-demo/functions/Shell.md +22 -0
  245. package/examples/@xmachines/play-react-demo/variables/About.md +9 -0
  246. package/examples/@xmachines/play-react-demo/variables/Contact.md +9 -0
  247. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +9 -0
  248. package/examples/@xmachines/play-react-demo/variables/Home.md +9 -0
  249. package/examples/@xmachines/play-react-demo/variables/Login.md +9 -0
  250. package/examples/@xmachines/play-react-demo/variables/Navigation.md +9 -0
  251. package/examples/@xmachines/play-react-demo/variables/Overview.md +9 -0
  252. package/examples/@xmachines/play-react-demo/variables/Profile.md +9 -0
  253. package/examples/@xmachines/play-react-demo/variables/Settings.md +9 -0
  254. package/examples/@xmachines/play-react-demo/variables/Stats.md +9 -0
  255. package/{api → examples}/@xmachines/play-react-router-demo/README.md +12 -12
  256. package/examples/@xmachines/play-router-shared/README.md +111 -0
  257. package/examples/@xmachines/play-router-shared/test/auth-machine-routing.test.ts/README.md +3 -0
  258. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/README.md +11 -0
  259. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/functions/defineSharedDemoBrowserSuite.md +19 -0
  260. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/variables/defineRouterDemoBrowserSuite.md +19 -0
  261. package/examples/@xmachines/play-router-shared/test/env.d.ts/README.md +8 -0
  262. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMeta.md +63 -0
  263. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMetaEnv.md +32 -0
  264. package/examples/@xmachines/play-solid-demo/README.md +159 -0
  265. package/examples/@xmachines/play-solid-demo/functions/App.md +13 -0
  266. package/examples/@xmachines/play-solid-demo/functions/DebugPanel.md +20 -0
  267. package/examples/@xmachines/play-solid-demo/functions/HeaderNav.md +20 -0
  268. package/examples/@xmachines/play-solid-demo/functions/Shell.md +22 -0
  269. package/examples/@xmachines/play-solid-demo/variables/About.md +9 -0
  270. package/examples/@xmachines/play-solid-demo/variables/Contact.md +9 -0
  271. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +9 -0
  272. package/examples/@xmachines/play-solid-demo/variables/Home.md +9 -0
  273. package/examples/@xmachines/play-solid-demo/variables/Login.md +9 -0
  274. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +9 -0
  275. package/examples/@xmachines/play-solid-demo/variables/Overview.md +9 -0
  276. package/examples/@xmachines/play-solid-demo/variables/Profile.md +9 -0
  277. package/examples/@xmachines/play-solid-demo/variables/Settings.md +9 -0
  278. package/examples/@xmachines/play-solid-demo/variables/Stats.md +9 -0
  279. package/{api → examples}/@xmachines/play-solid-router-demo/README.md +13 -13
  280. package/examples/@xmachines/play-svelte-demo/README.md +127 -0
  281. package/{api → examples}/@xmachines/play-svelte-spa-router-demo/README.md +12 -13
  282. package/{api → examples}/@xmachines/play-sveltekit-router-demo/README.md +12 -13
  283. package/{api → examples}/@xmachines/play-tanstack-react-router-demo/README.md +13 -13
  284. package/{api → examples}/@xmachines/play-tanstack-solid-router-demo/README.md +14 -14
  285. package/examples/@xmachines/play-vue-demo/README.md +145 -0
  286. package/{api → examples}/@xmachines/play-vue-router-demo/README.md +12 -12
  287. package/examples/README.md +51 -27
  288. package/package.json +6 -4
@@ -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.27/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.29/packages/play-xstate/src/player-actor.ts#L348)
6
6
 
7
7
  Concrete XState actor implementing Play Architecture signal protocol
8
8
 
@@ -65,7 +65,7 @@ actor.send({ type: "play.route", to: "#about" });
65
65
 
66
66
  ## See
67
67
 
68
- - [Play RFC](../../../../rfc/play.md)
68
+ - [Play RFC](../../docs/rfc/play.md)
69
69
  - [definePlayer](../functions/definePlayer.md) for factory creation
70
70
  - [@xmachines/play-actor!AbstractActor](../../play-actor/classes/AbstractActor.md) for signal protocol
71
71
  - [@xmachines/play-actor!Routable](../../play-actor/interfaces/Routable.md) for routing capability
@@ -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.27/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.29/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.27/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.27/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.29/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.29/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.27/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.29/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.27/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.29/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
 
@@ -174,7 +174,7 @@ Defined in: `xstate`
174
174
  dispose(): void;
175
175
  ```
176
176
 
177
- Defined in: [packages/play-xstate/src/player-actor.ts:638](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-xstate/src/player-actor.ts#L638)
177
+ Defined in: [packages/play-xstate/src/player-actor.ts:638](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L638)
178
178
 
179
179
  Convenience dispose method for cleanup
180
180
 
@@ -226,7 +226,7 @@ https://stately.ai/docs/persistence
226
226
  getSnapshot(): SnapshotFrom<TMachine>;
227
227
  ```
228
228
 
229
- Defined in: [packages/play-xstate/src/player-actor.ts:607](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-xstate/src/player-actor.ts#L607)
229
+ Defined in: [packages/play-xstate/src/player-actor.ts:607](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L607)
230
230
 
231
231
  Get current snapshot
232
232
 
@@ -308,7 +308,7 @@ Defined in: `xstate`
308
308
  send(event): void;
309
309
  ```
310
310
 
311
- Defined in: [packages/play-xstate/src/player-actor.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-xstate/src/player-actor.ts#L584)
311
+ Defined in: [packages/play-xstate/src/player-actor.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L584)
312
312
 
313
313
  Send an event to the underlying XState actor.
314
314
 
@@ -352,7 +352,7 @@ actor.send({ type: "play.route", to: "#home" });
352
352
  start(): this;
353
353
  ```
354
354
 
355
- Defined in: [packages/play-xstate/src/player-actor.ts:538](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-xstate/src/player-actor.ts#L538)
355
+ Defined in: [packages/play-xstate/src/player-actor.ts:538](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L538)
356
356
 
357
357
  Start the actor
358
358
 
@@ -374,7 +374,7 @@ Per RESEARCH.md Pitfall 1: Always call start() after creation
374
374
  stop(): this;
375
375
  ```
376
376
 
377
- Defined in: [packages/play-xstate/src/player-actor.ts:552](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-xstate/src/player-actor.ts#L552)
377
+ Defined in: [packages/play-xstate/src/player-actor.ts:552](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L552)
378
378
 
379
379
  Stop the actor and cleanup
380
380
 
@@ -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.27/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.29/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.27/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.29/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.27/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.29/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.27/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.29/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.27/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.29/packages/play-xstate/src/define-player.ts#L61)
10
10
 
11
11
  Create a player factory from an XState machine
12
12
 
@@ -72,7 +72,7 @@ console.log(alice.state.get() !== bob.state.get());
72
72
 
73
73
  ## See
74
74
 
75
- - [Play RFC](../../../../rfc/play.md)
75
+ - [Play RFC](../../docs/rfc/play.md)
76
76
  - [PlayerActor](../classes/PlayerActor.md) for the concrete actor implementation
77
77
  - [PlayerConfig](../interfaces/PlayerConfig.md) for configuration options
78
78
  - [PlayerFactory](../type-aliases/PlayerFactory.md) for factory function signature
@@ -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.27/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.29/packages/play-xstate/src/routing/derive-route.ts#L90)
10
10
 
11
11
  Derive route from XState state metadata
12
12
 
@@ -94,7 +94,7 @@ console.log(route); // "/dashboard"
94
94
 
95
95
  ## See
96
96
 
97
- - [Play RFC](../../../../rfc/play.md)
97
+ - [Play RFC](../../../docs/rfc/play.md)
98
98
  - [buildRouteUrl](buildRouteUrl.md) for URL construction with parameter substitution
99
99
  - [isAbsoluteRoute](isAbsoluteRoute.md) for checking path absoluteness
100
100
 
@@ -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.27/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.29/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.27/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.29/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.27/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.29/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.27/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.29/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.27/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.29/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.27/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.29/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.27/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.27/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.29/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.29/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.27/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.29/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.27/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.29/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.27/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.29/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.27/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.27/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.27/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.27/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.27/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.29/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.29/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.29/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.29/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.29/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.27/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.29/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.27/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.27/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.27/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.27/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.29/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.29/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.29/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.29/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.27/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.29/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.27/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.29/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.27/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.29/packages/play-xstate/src/guards/types.ts#L23)
10
10
 
11
11
  Array of guard predicates or guard names
12
12
 
@@ -6,7 +6,7 @@
6
6
  type PlayerFactory<TMachine> = (input?, options?) => PlayerActor<TMachine>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-xstate/src/types.ts#L57)
9
+ Defined in: [packages/play-xstate/src/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/types.ts#L57)
10
10
 
11
11
  Factory function returned by definePlayer()
12
12
 
@@ -6,7 +6,7 @@
6
6
  type RouteMachineConfig = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-xstate/src/routing/format-play-route-transitions.ts#L48)
9
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/routing/format-play-route-transitions.ts#L48)
10
10
 
11
11
  Minimal structural constraint for machine configs accepted by
12
12
  `formatPlayRouteTransitions`.
@@ -32,7 +32,7 @@ through the transform, so the return value remains directly usable by
32
32
  optional context?: unknown;
33
33
  ```
34
34
 
35
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-xstate/src/routing/format-play-route-transitions.ts#L49)
35
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/routing/format-play-route-transitions.ts#L49)
36
36
 
37
37
  ---
38
38
 
@@ -42,7 +42,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:4
42
42
  optional on?: Record<string, unknown>;
43
43
  ```
44
44
 
45
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-xstate/src/routing/format-play-route-transitions.ts#L51)
45
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/routing/format-play-route-transitions.ts#L51)
46
46
 
47
47
  ---
48
48
 
@@ -52,4 +52,4 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:5
52
52
  optional states?: Record<string, unknown>;
53
53
  ```
54
54
 
55
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-xstate/src/routing/format-play-route-transitions.ts#L50)
55
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/routing/format-play-route-transitions.ts#L50)
@@ -6,7 +6,7 @@
6
6
  type RouteStateNode = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-xstate/src/routing/format-play-route-transitions.ts#L13)
9
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/routing/format-play-route-transitions.ts#L13)
10
10
 
11
11
  Minimal structural shape of a single XState state node as read by
12
12
  `formatPlayRouteTransitions` when crawling the machine config.
@@ -29,7 +29,7 @@ the index signature.
29
29
  optional id?: string;
30
30
  ```
31
31
 
32
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-xstate/src/routing/format-play-route-transitions.ts#L15)
32
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/routing/format-play-route-transitions.ts#L15)
33
33
 
34
34
  Optional explicit state ID (e.g. `"home"`, `"settings"`). Used as the `#id` target in `play.route` events.
35
35
 
@@ -41,7 +41,7 @@ Optional explicit state ID (e.g. `"home"`, `"settings"`). Used as the `#id` targ
41
41
  optional meta?: object;
42
42
  ```
43
43
 
44
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-xstate/src/routing/format-play-route-transitions.ts#L17)
44
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/routing/format-play-route-transitions.ts#L17)
45
45
 
46
46
  State metadata — `meta.route` marks the state as routable.
47
47
 
@@ -61,6 +61,6 @@ URL path template (e.g. `"/profile/:username"`, `"/settings/:section?"`).
61
61
  optional states?: Record<string, RouteStateNode>;
62
62
  ```
63
63
 
64
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-xstate/src/routing/format-play-route-transitions.ts#L22)
64
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/routing/format-play-route-transitions.ts#L22)
65
65
 
66
66
  Nested child states, recursively crawled for additional route declarations.
@@ -6,7 +6,7 @@
6
6
  function defineXmVitestConfig(importMetaUrl, overrides): UserConfig;
7
7
  ```
8
8
 
9
- Defined in: [index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/shared/src/index.ts#L10)
9
+ Defined in: [index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/shared/src/index.ts#L10)
10
10
 
11
11
  Create a Vitest config with XMachines workspace defaults.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function xmAliases(importMetaUrl): Record<string, string>;
7
7
  ```
8
8
 
9
- Defined in: [index.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/shared/src/index.ts#L20)
9
+ Defined in: [index.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/shared/src/index.ts#L20)
10
10
 
11
11
  Build Vite/Vitest alias entries for all `@xmachines/*` workspace packages.
12
12
 
package/api/README.md CHANGED
@@ -1,32 +1,4 @@
1
- # XMachines API Reference
2
-
3
- Generated API documentation for the XMachines JavaScript/TypeScript packages.
4
-
5
- ## Start Here
6
-
7
- - For actor contracts, start with [@xmachines/play-actor](@xmachines/play-actor/README.md).
8
- - For player creation from XState machines, start with [@xmachines/play-xstate](@xmachines/play-xstate/README.md).
9
- - For route extraction and shared URL synchronization logic, start with [@xmachines/play-router](@xmachines/play-router/README.md).
10
- - For rendering, choose one of [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), [@xmachines/play-svelte](@xmachines/play-svelte/README.md), or [@xmachines/play-vue](@xmachines/play-vue/README.md).
11
- - For framework router integration, choose the matching adapter package such as [@xmachines/play-react-router](@xmachines/play-react-router/README.md), [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md), [@xmachines/play-sveltekit-router](@xmachines/play-sveltekit-router/README.md), or [@xmachines/play-svelte-spa-router](@xmachines/play-svelte-spa-router/README.md).
12
-
13
- ## Key Concepts
14
-
15
- - [Viewable](@xmachines/play-actor/interfaces/Viewable.md) actors expose `currentView` and a component catalog for renderer packages.
16
- - [Routable](@xmachines/play-actor/interfaces/Routable.md) actors expose `currentRoute` and route-oriented events for router adapters.
17
- - Router adapters are passive infrastructure: they synchronize URLs with actor state but do not own business rules.
18
-
19
- ## Package Roles
20
-
21
- - `Core runtime`: [@xmachines/play](@xmachines/play/README.md), [@xmachines/play-actor](@xmachines/play-actor/README.md), [@xmachines/play-signals](@xmachines/play-signals/README.md), [@xmachines/play-router](@xmachines/play-router/README.md), and [@xmachines/play-xstate](@xmachines/play-xstate/README.md)
22
- - `Rendering`: [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), [@xmachines/play-svelte](@xmachines/play-svelte/README.md), and [@xmachines/play-vue](@xmachines/play-vue/README.md)
23
- - `Router adapters`: [@xmachines/play-react-router](@xmachines/play-react-router/README.md), [@xmachines/play-tanstack-react-router](@xmachines/play-tanstack-react-router/README.md), [@xmachines/play-solid-router](@xmachines/play-solid-router/README.md), [@xmachines/play-tanstack-solid-router](@xmachines/play-tanstack-solid-router/README.md), [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md), [@xmachines/play-sveltekit-router](@xmachines/play-sveltekit-router/README.md), and [@xmachines/play-svelte-spa-router](@xmachines/play-svelte-spa-router/README.md)
24
- - `Shared tooling`: [@xmachines/shared](@xmachines/shared/README.md)
25
-
26
- ## Notes
27
-
28
- - Demo packages are included in the generated package index below, but most implementation questions should start with the core runtime and adapter packages above.
29
- - A useful reading order is usually: [@xmachines/play-actor](@xmachines/play-actor/README.md) -> [@xmachines/play-xstate](@xmachines/play-xstate/README.md) -> [@xmachines/play-router](@xmachines/play-router/README.md) -> framework renderer/adapter.
1
+ # Documentation
30
2
 
31
3
  ## Packages
32
4
 
@@ -34,26 +6,18 @@ Generated API documentation for the XMachines JavaScript/TypeScript packages.
34
6
  - [@xmachines/play-actor](@xmachines/play-actor/README.md)
35
7
  - [@xmachines/play-dom](@xmachines/play-dom/README.md)
36
8
  - [@xmachines/play-dom-router](@xmachines/play-dom-router/README.md)
37
- - [@xmachines/play-dom-router-demo](@xmachines/play-dom-router-demo/README.md)
38
9
  - [@xmachines/play-react](@xmachines/play-react/README.md)
39
10
  - [@xmachines/play-react-router](@xmachines/play-react-router/README.md)
40
- - [@xmachines/play-react-router-demo](@xmachines/play-react-router-demo/README.md)
41
11
  - [@xmachines/play-router](@xmachines/play-router/README.md)
42
12
  - [@xmachines/play-signals](@xmachines/play-signals/README.md)
43
13
  - [@xmachines/play-solid](@xmachines/play-solid/README.md)
44
14
  - [@xmachines/play-solid-router](@xmachines/play-solid-router/README.md)
45
- - [@xmachines/play-solid-router-demo](@xmachines/play-solid-router-demo/README.md)
46
15
  - [@xmachines/play-svelte](@xmachines/play-svelte/README.md)
47
16
  - [@xmachines/play-svelte-spa-router](@xmachines/play-svelte-spa-router/README.md)
48
- - [@xmachines/play-svelte-spa-router-demo](@xmachines/play-svelte-spa-router-demo/README.md)
49
17
  - [@xmachines/play-sveltekit-router](@xmachines/play-sveltekit-router/README.md)
50
- - [@xmachines/play-sveltekit-router-demo](@xmachines/play-sveltekit-router-demo/README.md)
51
18
  - [@xmachines/play-tanstack-react-router](@xmachines/play-tanstack-react-router/README.md)
52
- - [@xmachines/play-tanstack-react-router-demo](@xmachines/play-tanstack-react-router-demo/README.md)
53
19
  - [@xmachines/play-tanstack-solid-router](@xmachines/play-tanstack-solid-router/README.md)
54
- - [@xmachines/play-tanstack-solid-router-demo](@xmachines/play-tanstack-solid-router-demo/README.md)
55
20
  - [@xmachines/play-vue](@xmachines/play-vue/README.md)
56
21
  - [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md)
57
- - [@xmachines/play-vue-router-demo](@xmachines/play-vue-router-demo/README.md)
58
22
  - [@xmachines/play-xstate](@xmachines/play-xstate/README.md)
59
23
  - [@xmachines/shared](@xmachines/shared/README.md)