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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (270) hide show
  1. package/api/@xmachines/play/README.md +5 -0
  2. package/api/@xmachines/play/classes/NonNullableError.md +189 -0
  3. package/api/@xmachines/play/classes/PlayError.md +9 -4
  4. package/api/@xmachines/play/functions/assertNonNullable.md +56 -0
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  6. package/api/@xmachines/play-actor/README.md +9 -9
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  9. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  10. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  11. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  13. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  14. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  15. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  16. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  17. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  18. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  19. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +3 -3
  20. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +3 -3
  21. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +7 -7
  22. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  23. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +3 -3
  24. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  25. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  26. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  27. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  28. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  29. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  31. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  32. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  33. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  34. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  35. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  36. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  37. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  38. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  39. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  40. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  41. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  42. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  43. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  44. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  45. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  46. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  47. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  48. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  49. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  50. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  51. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +6 -6
  52. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  53. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  54. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  55. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  56. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  57. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  58. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  59. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  60. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  61. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  62. package/api/@xmachines/play-router/README.md +1 -1
  63. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  64. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  65. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  66. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  67. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  68. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  69. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  70. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  71. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  72. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  73. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  74. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  75. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  76. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  77. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  78. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  79. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  80. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  81. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  82. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  83. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  84. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  85. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  86. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  87. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  88. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  89. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  90. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  91. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  92. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  93. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  94. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  95. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  96. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  97. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  98. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  99. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  100. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  101. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  102. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  103. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  104. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  105. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  106. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  107. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  108. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  109. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  110. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +6 -6
  111. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  112. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  113. package/api/@xmachines/play-solid-router/README.md +2 -2
  114. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  115. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  116. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +28 -1
  117. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  118. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  119. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  120. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  121. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  122. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  123. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  124. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  125. package/api/@xmachines/play-svelte/README.md +8 -3
  126. package/api/@xmachines/play-svelte/functions/defineRegistry.md +12 -35
  127. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +23 -0
  128. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +6 -6
  129. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +30 -0
  130. package/api/@xmachines/play-svelte/type-aliases/Actions.md +17 -0
  131. package/api/@xmachines/play-svelte/type-aliases/SetState.md +21 -0
  132. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  133. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  134. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  135. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  136. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  137. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  138. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  139. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  140. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  141. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  142. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  143. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  144. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  145. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  146. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  147. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  148. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  149. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  150. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  151. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  152. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +8 -1
  153. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  154. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  155. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  156. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  157. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  158. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  159. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  160. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  161. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  162. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  163. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  164. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  165. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +9 -1
  166. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  167. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  168. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  169. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  170. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  171. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  172. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  173. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  174. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  175. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  176. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +4 -4
  177. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  178. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  179. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  180. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  181. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  182. package/api/@xmachines/play-vue-router/README.md +3 -3
  183. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  184. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  185. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +39 -26
  186. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  187. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  188. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  189. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  190. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  191. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  192. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  193. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  194. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  195. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  196. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  197. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  198. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  199. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  200. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  201. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  202. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  203. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  204. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  205. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  206. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  207. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  208. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  209. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  210. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  211. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  212. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  213. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  214. package/api/@xmachines/shared/README.md +47 -47
  215. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  216. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  217. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  218. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  219. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  220. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  221. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  222. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  223. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  224. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  225. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  226. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  227. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  228. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  229. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  230. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  231. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  232. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  233. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  234. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  235. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  236. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  237. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  238. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  239. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  240. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  241. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  242. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  243. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  244. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  245. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  246. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  247. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  248. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  249. package/examples/@xmachines/play-react-router-demo/README.md +1 -3
  250. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  251. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  252. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  253. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  254. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  255. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  256. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  257. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  258. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  259. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  260. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  261. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  262. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  263. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  264. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  265. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  266. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  267. package/examples/@xmachines/play-solid-router-demo/README.md +1 -3
  268. package/examples/README.md +2 -2
  269. package/package.json +6 -6
  270. package/rfc/play.md +19 -19
@@ -6,4 +6,4 @@
6
6
  const Profile: ComponentFn<AuthCatalog, "Profile">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/examples/demo/src/components/Profile.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-react/examples/demo/src/components/Profile.tsx#L14)
9
+ Defined in: [packages/play-react/examples/demo/src/components/Profile.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-react/examples/demo/src/components/Profile.tsx#L14)
@@ -6,4 +6,4 @@
6
6
  const Settings: ComponentFn<AuthCatalog, "Settings">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/examples/demo/src/components/Settings.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-react/examples/demo/src/components/Settings.tsx#L14)
9
+ Defined in: [packages/play-react/examples/demo/src/components/Settings.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-react/examples/demo/src/components/Settings.tsx#L14)
@@ -10,4 +10,4 @@ const Shell: FC<{
10
10
  }>;
11
11
  ```
12
12
 
13
- Defined in: [packages/play-react/examples/demo/src/components/Shell.tsx:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-react/examples/demo/src/components/Shell.tsx#L15)
13
+ Defined in: [packages/play-react/examples/demo/src/components/Shell.tsx:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-react/examples/demo/src/components/Shell.tsx#L15)
@@ -6,4 +6,4 @@
6
6
  const Stats: ComponentFn<AuthCatalog, "Stats">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/examples/demo/src/components/Stats.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-react/examples/demo/src/components/Stats.tsx#L11)
9
+ Defined in: [packages/play-react/examples/demo/src/components/Stats.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-react/examples/demo/src/components/Stats.tsx#L11)
@@ -169,4 +169,4 @@ const authCatalog: Catalog<
169
169
  >;
170
170
  ```
171
171
 
172
- Defined in: [packages/play-react/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-react/examples/demo/src/catalog.ts#L5)
172
+ Defined in: [packages/play-react/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-react/examples/demo/src/catalog.ts#L5)
@@ -79,9 +79,7 @@ return (
79
79
  // src/components/Login.tsx (shape)
80
80
  export function Login() {
81
81
  return (
82
- <button onClick={() => actor.send({ type: "auth.login", username, password })}>
83
- Login
84
- </button>
82
+ <button onClick={() => actor.send({ type: "auth.login", username, password })}>Login</button>
85
83
  );
86
84
  }
87
85
  ```
@@ -6,7 +6,7 @@
6
6
  function App(): Element;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/App.tsx:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/App.tsx#L33)
9
+ Defined in: [packages/play-solid/examples/demo/src/App.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/App.tsx#L34)
10
10
 
11
11
  ## Returns
12
12
 
@@ -6,4 +6,4 @@
6
6
  type AuthCatalog = typeof authCatalog;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/catalog.ts#L6)
9
+ Defined in: [packages/play-solid/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/catalog.ts#L6)
@@ -6,4 +6,4 @@
6
6
  const About: ComponentFn<AuthCatalog, "About">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/About.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/About.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/About.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/About.tsx#L4)
@@ -6,4 +6,4 @@
6
6
  const Contact: ComponentFn<AuthCatalog, "Contact">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Contact.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Contact.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Contact.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Contact.tsx#L4)
@@ -6,4 +6,4 @@
6
6
  const Dashboard: ComponentFn<AuthCatalog, "Dashboard">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Dashboard.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Dashboard.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Dashboard.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Dashboard.tsx#L4)
@@ -8,4 +8,4 @@ const DebugPanel: Component<{
8
8
  }>;
9
9
  ```
10
10
 
11
- Defined in: [packages/play-solid/examples/demo/src/components/DebugPanel.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/DebugPanel.tsx#L5)
11
+ Defined in: [packages/play-solid/examples/demo/src/components/DebugPanel.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/DebugPanel.tsx#L5)
@@ -6,4 +6,4 @@
6
6
  const Home: ComponentFn<AuthCatalog, "Home">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Home.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Home.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Home.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Home.tsx#L4)
@@ -6,4 +6,4 @@
6
6
  const Login: ComponentFn<AuthCatalog, "Login">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Login.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Login.tsx#L7)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Login.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Login.tsx#L7)
@@ -8,4 +8,4 @@ const NavBar: Component<{
8
8
  }>;
9
9
  ```
10
10
 
11
- Defined in: [packages/play-solid/examples/demo/src/components/NavBar.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/NavBar.tsx#L28)
11
+ Defined in: [packages/play-solid/examples/demo/src/components/NavBar.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/NavBar.tsx#L28)
@@ -6,7 +6,7 @@
6
6
  const NavBarView: ComponentFn<AuthCatalog, "NavBar">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/NavBar.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/NavBar.tsx#L20)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/NavBar.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/NavBar.tsx#L20)
10
10
 
11
11
  Catalog-typed NavBar component for use in defineRegistry components map.
12
12
  Receives props from spec (isAuthenticated, username) and renders a static nav.
@@ -6,4 +6,4 @@
6
6
  const Navigation: ComponentFn<AuthCatalog, "Navigation">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Navigation.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Navigation.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Navigation.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Navigation.tsx#L4)
@@ -6,4 +6,4 @@
6
6
  const Overview: ComponentFn<AuthCatalog, "Overview">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Overview.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Overview.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Overview.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Overview.tsx#L4)
@@ -6,4 +6,4 @@
6
6
  const Profile: ComponentFn<AuthCatalog, "Profile">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Profile.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Profile.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Profile.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Profile.tsx#L4)
@@ -6,4 +6,4 @@
6
6
  const Settings: ComponentFn<AuthCatalog, "Settings">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Settings.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Settings.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Settings.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Settings.tsx#L4)
@@ -10,4 +10,4 @@ const Shell: Component<{
10
10
  }>;
11
11
  ```
12
12
 
13
- Defined in: [packages/play-solid/examples/demo/src/components/Shell.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Shell.tsx#L8)
13
+ Defined in: [packages/play-solid/examples/demo/src/components/Shell.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Shell.tsx#L8)
@@ -6,4 +6,4 @@
6
6
  const Stats: ComponentFn<AuthCatalog, "Stats">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Stats.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Stats.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Stats.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/components/Stats.tsx#L4)
@@ -169,4 +169,4 @@ const authCatalog: Catalog<
169
169
  >;
170
170
  ```
171
171
 
172
- Defined in: [packages/play-solid/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/catalog.ts#L5)
172
+ Defined in: [packages/play-solid/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-solid/examples/demo/src/catalog.ts#L5)
@@ -51,9 +51,7 @@ const routeMap = createRouteMap(authMachine);
51
51
  actor={actor}
52
52
  routeMap={routeMap}
53
53
  router={{ navigate, location, params }}
54
- renderer={(currentActor, currentRouter) => (
55
- <Shell actor={currentActor} router={currentRouter} />
56
- )}
54
+ renderer={(currentActor, currentRouter) => <Shell actor={currentActor} router={currentRouter} />}
57
55
  />;
58
56
  ```
59
57
 
@@ -34,7 +34,7 @@ Complete working implementations of actor-authoritative routing with all archite
34
34
  - [@xmachines/play-solid-demo](@xmachines/play-solid-demo/README.md)
35
35
  - [@xmachines/play-svelte-demo](@xmachines/play-svelte-demo/README.md)
36
36
  - [@xmachines/play-vue-demo](@xmachines/play-vue-demo/README.md)
37
- <!-- typedoc:renderer-demos:end -->
37
+ <!-- typedoc:renderer-demos:end -->
38
38
 
39
39
  ### Router Demos
40
40
 
@@ -48,7 +48,7 @@ Complete working implementations of actor-authoritative routing with all archite
48
48
  - [@xmachines/play-tanstack-react-router-demo](@xmachines/play-tanstack-react-router-demo/README.md)
49
49
  - [@xmachines/play-tanstack-solid-router-demo](@xmachines/play-tanstack-solid-router-demo/README.md)
50
50
  - [@xmachines/play-vue-router-demo](@xmachines/play-vue-router-demo/README.md)
51
- <!-- typedoc:router-demos:end -->
51
+ <!-- typedoc:router-demos:end -->
52
52
 
53
53
  ## Running the Code Examples
54
54
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xmachines/docs",
3
- "version": "1.0.0-beta.31",
3
+ "version": "1.0.0-beta.32",
4
4
  "description": "Documentation for XMachines",
5
5
  "keywords": [
6
6
  "documentation",
@@ -49,12 +49,12 @@
49
49
  "test": "vitest run"
50
50
  },
51
51
  "devDependencies": {
52
- "@xmachines/shared": "1.0.0-beta.31",
53
- "oxfmt": "^0.43.0",
54
- "oxlint": "^1.57.0",
55
- "typedoc": "^0.28.18",
52
+ "@xmachines/shared": "1.0.0-beta.32",
53
+ "oxfmt": "^0.45.0",
54
+ "oxlint": "^1.60.0",
55
+ "typedoc": "^0.28.19",
56
56
  "typedoc-plugin-llms-txt": "^0.1.2",
57
57
  "typedoc-plugin-markdown": "^4.11.0",
58
- "vitest": "^4.1.2"
58
+ "vitest": "^4.1.4"
59
59
  }
60
60
  }
package/rfc/play.md CHANGED
@@ -20,24 +20,24 @@ The reference implementation provides a modular monorepo that satisfies the arch
20
20
  ### 2.1 Roles
21
21
 
22
22
  - **The Actor (Logic Engine)**
23
- - Pure, environment-agnostic logic runtime
24
- - Owns state, guards, errors, and route validity
25
- - Emits _Virtual Routes_ as derived intent
23
+ - Pure, environment-agnostic logic runtime
24
+ - Owns state, guards, errors, and route validity
25
+ - Emits _Virtual Routes_ as derived intent
26
26
 
27
27
  - **The Runtime Adapter (Infrastructure Layer)**
28
- - Environment-specific adapter (Browser, Native, Server, Test Runner)
29
- - Reflects Actor output into the environment
30
- - Forwards environment events to the Actor without interpretation
28
+ - Environment-specific adapter (Browser, Native, Server, Test Runner)
29
+ - Reflects Actor output into the environment
30
+ - Forwards environment events to the Actor without interpretation
31
31
 
32
32
  - **The View**
33
- - Passive consumer of Actor state
34
- - No business rules or routing authority
33
+ - Passive consumer of Actor state
34
+ - No business rules or routing authority
35
35
 
36
36
  ### 2.2 Communication Medium
37
37
 
38
38
  - **Signals (TC39 Proposal)**
39
- - Used exclusively for Actor ↔ Adapter communication
40
- - Enables synchronous, glitch-free propagation
39
+ - Used exclusively for Actor ↔ Adapter communication
40
+ - Enables synchronous, glitch-free propagation
41
41
 
42
42
  ---
43
43
 
@@ -75,9 +75,9 @@ The reference implementation provides a modular monorepo that satisfies the arch
75
75
  - Defines **Virtual Routes** as metadata on state nodes
76
76
  - Validates all incoming navigation intents
77
77
  - On invalid intent:
78
- 1. Transitions to an error or fallback state
79
- 2. Emits a corresponding Virtual Route (e.g. `/error`, `/login`)
80
- 3. Forces the environment to realign with Actor state
78
+ 1. Transitions to an error or fallback state
79
+ 2. Emits a corresponding Virtual Route (e.g. `/error`, `/login`)
80
+ 3. Forces the environment to realign with Actor state
81
81
 
82
82
  The Actor has zero knowledge of:
83
83
 
@@ -114,9 +114,9 @@ Wraps the TC39 Signals (Stage 1) polyfill. By isolating the reactive primitive w
114
114
  **Exports:**
115
115
 
116
116
  - `Signal` — Re-exported namespace from `signal-polyfill`:
117
- - `Signal.State` — Actor output snapshot
118
- - `Signal.Computed` — Lazy, pull-based derivation of routes and views
119
- - `Signal.subtle.Watcher` — Synchronous observation for Runtime Adapters
117
+ - `Signal.State` — Actor output snapshot
118
+ - `Signal.Computed` — Lazy, pull-based derivation of routes and views
119
+ - `Signal.subtle.Watcher` — Synchronous observation for Runtime Adapters
120
120
  - `watchSignal` — Convenience function: subscribes to a single signal with a one-shot watcher lifecycle and microtask batching; returns a cleanup function
121
121
 
122
122
  #### 5.1.2 `@xmachines/play`
@@ -251,9 +251,9 @@ Provides the complete routing infrastructure: route extraction from state machin
251
251
  - `RouterBridge` — Interface: `{ connect(): void; disconnect(): void }`
252
252
  - `PlayRouteEvent` — Routing event: `{ type: 'play.route'; to: string; params?; query?; match? }`
253
253
  - `RouterBridgeBase` — Abstract base class that encapsulates common bridge logic (signal watching, route synchronization, param/query extraction). Subclasses implement only three methods:
254
- - `navigateRouter(path)` — Push a path into the framework router
255
- - `watchRouterChanges()` — Subscribe to framework router navigation events
256
- - `unwatchRouterChanges()` — Unsubscribe from framework router events
254
+ - `navigateRouter(path)` — Push a path into the framework router
255
+ - `watchRouterChanges()` — Subscribe to framework router navigation events
256
+ - `unwatchRouterChanges()` — Unsubscribe from framework router events
257
257
 
258
258
  **Route Extraction Exports:**
259
259