@xmachines/docs 1.0.0-beta.52 → 1.0.0-beta.53

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 (315) hide show
  1. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  2. package/api/@xmachines/play/classes/PlayError.md +4 -4
  3. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  4. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  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/BaseActorProviderProps.md +5 -5
  8. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  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/Viewable.md +2 -2
  12. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  13. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  14. package/api/@xmachines/play-dom/functions/createRenderer.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/CreatePlayUIOptions.md +6 -6
  19. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  20. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +15 -15
  21. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  22. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  23. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +8 -8
  24. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +5 -5
  25. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  26. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  27. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  28. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  29. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  31. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  32. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  37. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  38. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  39. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  40. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  41. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  42. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  43. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  44. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  45. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  46. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  47. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  48. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  49. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  50. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  51. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  52. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  53. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  54. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  55. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  56. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  57. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  58. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  59. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  60. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  61. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  62. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  63. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  64. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  65. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  66. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +24 -24
  67. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  68. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  69. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  70. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  71. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  72. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  73. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  74. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  75. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  76. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  77. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  78. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +24 -24
  79. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  80. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  81. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  82. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  83. package/api/@xmachines/play-router/functions/createRouteMatcher.md +1 -1
  84. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  85. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  86. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  87. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  88. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  89. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  90. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  91. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  92. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  93. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  94. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  95. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  96. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  97. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  98. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  99. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  100. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  101. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  102. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  103. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  104. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  105. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  106. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  107. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  108. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  109. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  110. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +4 -4
  111. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  112. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  113. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  114. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  115. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  116. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  117. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  118. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  119. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  120. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  121. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  122. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  123. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  124. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  125. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  126. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  127. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  128. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  129. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  130. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  131. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  132. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  133. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  134. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  135. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  136. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  137. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +25 -25
  138. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  139. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  140. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  141. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  142. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  143. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  144. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  145. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  146. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  147. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  148. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  149. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  150. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  151. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  152. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  153. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  154. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  155. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  156. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  157. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  158. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  159. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  160. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  161. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  162. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  163. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  164. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  165. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  166. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  167. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  168. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  169. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  170. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  171. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  172. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  173. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  174. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  175. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  176. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  177. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  178. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  179. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +24 -24
  180. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  181. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  182. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  183. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  184. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  185. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  186. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  187. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  188. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  189. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  190. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  191. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  192. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  193. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  194. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +25 -25
  195. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  196. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  197. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  198. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  199. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  200. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  201. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  202. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  203. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  204. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  205. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  206. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  207. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  208. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  209. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  210. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  211. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  212. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  213. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  214. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  215. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  216. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  217. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  218. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  219. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +25 -25
  220. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  221. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  222. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  223. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  224. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  225. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  226. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  227. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  228. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  229. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  230. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  231. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  232. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  233. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  234. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  235. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  236. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  237. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  238. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  239. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  240. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  241. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  242. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  243. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  244. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  245. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  246. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  247. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  248. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  249. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  250. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  251. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  252. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  253. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  254. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  255. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  256. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  257. package/contributing/architecture.md +68 -68
  258. package/contributing/configuration.md +1 -1
  259. package/contributing/development.md +2 -2
  260. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  261. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  262. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  263. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  264. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  265. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  266. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  267. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  268. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  269. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  270. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  271. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  272. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  273. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  274. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  275. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  276. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  277. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  278. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  279. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  280. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  281. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  282. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  283. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  284. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  285. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  286. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  287. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  288. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  289. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  290. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  291. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  292. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  293. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  294. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  295. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  296. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  297. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  298. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  299. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  300. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  301. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  302. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  303. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  304. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  305. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  306. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  307. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  308. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  309. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  310. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  311. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  312. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  313. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  314. package/guides/getting-started.md +37 -37
  315. package/package.json +2 -2
package/examples/@xmachines/play-react-demo/variables/Home.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const Home: ComponentFn<AuthCatalog, "Home">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/examples/demo/src/components/Home.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-react/examples/demo/src/components/Home.tsx#L10)
9
+ Defined in: [packages/play-react/examples/demo/src/components/Home.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-react/examples/demo/src/components/Home.tsx#L10)
10
10
 
11
11
  Home - Public landing page component
12
12
 
package/examples/@xmachines/play-react-demo/variables/Login.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const Login: ComponentFn<AuthCatalog, "Login">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/examples/demo/src/components/Login.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-react/examples/demo/src/components/Login.tsx#L14)
9
+ Defined in: [packages/play-react/examples/demo/src/components/Login.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-react/examples/demo/src/components/Login.tsx#L14)
10
10
 
11
11
  Login — Authentication form
12
12
 
package/examples/@xmachines/play-react-demo/variables/NavBar.md CHANGED
@@ -8,7 +8,7 @@ const NavBar: FC<{
8
8
  }>;
9
9
  ```
10
10
 
11
- Defined in: [packages/play-react/examples/demo/src/components/NavBar.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-react/examples/demo/src/components/NavBar.tsx#L12)
11
+ Defined in: [packages/play-react/examples/demo/src/components/NavBar.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-react/examples/demo/src/components/NavBar.tsx#L12)
12
12
 
13
13
  NavBar — App-shell navigation component.
14
14
 
package/examples/@xmachines/play-react-demo/variables/NavBarView.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const NavBarView: ComponentFn<AuthCatalog, "NavBar">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/examples/demo/src/components/NavBarView.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-react/examples/demo/src/components/NavBarView.tsx#L11)
9
+ Defined in: [packages/play-react/examples/demo/src/components/NavBarView.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-react/examples/demo/src/components/NavBarView.tsx#L11)
10
10
 
11
11
  NavBarView — Catalog-typed NavBar for use in defineRegistry components map.
12
12
 
package/examples/@xmachines/play-react-demo/variables/Navigation.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const Navigation: ComponentFn<AuthCatalog, "Navigation">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/examples/demo/src/components/Navigation.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-react/examples/demo/src/components/Navigation.tsx#L10)
9
+ Defined in: [packages/play-react/examples/demo/src/components/Navigation.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-react/examples/demo/src/components/Navigation.tsx#L10)
10
10
 
11
11
  Navigation - Status display component
12
12
 
package/examples/@xmachines/play-react-demo/variables/Overview.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const Overview: ComponentFn<AuthCatalog, "Overview">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/examples/demo/src/components/Overview.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-react/examples/demo/src/components/Overview.tsx#L10)
9
+ Defined in: [packages/play-react/examples/demo/src/components/Overview.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-react/examples/demo/src/components/Overview.tsx#L10)
10
10
 
11
11
  Overview - Dashboard overview child route component
12
12
 
package/examples/@xmachines/play-react-demo/variables/Profile.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const Profile: ComponentFn<AuthCatalog, "Profile">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/examples/demo/src/components/Profile.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-react/examples/demo/src/components/Profile.tsx#L11)
9
+ Defined in: [packages/play-react/examples/demo/src/components/Profile.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-react/examples/demo/src/components/Profile.tsx#L11)
10
10
 
11
11
  Profile — Protected user profile page
12
12
 
package/examples/@xmachines/play-react-demo/variables/Settings.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const Settings: ComponentFn<AuthCatalog, "Settings">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/examples/demo/src/components/Settings.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-react/examples/demo/src/components/Settings.tsx#L11)
9
+ Defined in: [packages/play-react/examples/demo/src/components/Settings.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-react/examples/demo/src/components/Settings.tsx#L11)
10
10
 
11
11
  Settings — Protected settings page
12
12
 
package/examples/@xmachines/play-react-demo/variables/Shell.md CHANGED
@@ -10,7 +10,7 @@ const Shell: FC<{
10
10
  }>;
11
11
  ```
12
12
 
13
- Defined in: [packages/play-react/examples/demo/src/components/Shell.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-react/examples/demo/src/components/Shell.tsx#L14)
13
+ Defined in: [packages/play-react/examples/demo/src/components/Shell.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-react/examples/demo/src/components/Shell.tsx#L14)
14
14
 
15
15
  Demo Shell layout component.
16
16
 
package/examples/@xmachines/play-react-demo/variables/Stats.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const Stats: ComponentFn<AuthCatalog, "Stats">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/examples/demo/src/components/Stats.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-react/examples/demo/src/components/Stats.tsx#L10)
9
+ Defined in: [packages/play-react/examples/demo/src/components/Stats.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-react/examples/demo/src/components/Stats.tsx#L10)
10
10
 
11
11
  Stats - Dashboard stats child route component
12
12
 
package/examples/@xmachines/play-react-demo/variables/authCatalog.md CHANGED
@@ -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.52/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.53/packages/play-react/examples/demo/src/catalog.ts#L5)
package/examples/@xmachines/play-solid-demo/functions/App.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function App(): Element;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/App.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/App.tsx#L34)
9
+ Defined in: [packages/play-solid/examples/demo/src/App.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/App.tsx#L34)
10
10
 
11
11
  ## Returns
12
12
 
package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md CHANGED
@@ -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.52/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.53/packages/play-solid/examples/demo/src/catalog.ts#L6)
package/examples/@xmachines/play-solid-demo/variables/About.md CHANGED
@@ -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:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/components/About.tsx#L9)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/About.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/components/About.tsx#L9)
package/examples/@xmachines/play-solid-demo/variables/Contact.md CHANGED
@@ -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:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/components/Contact.tsx#L9)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Contact.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/components/Contact.tsx#L9)
package/examples/@xmachines/play-solid-demo/variables/Dashboard.md CHANGED
@@ -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:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/components/Dashboard.tsx#L9)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Dashboard.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/components/Dashboard.tsx#L9)
package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md CHANGED
@@ -8,7 +8,7 @@ const DebugPanel: Component<{
8
8
  }>;
9
9
  ```
10
10
 
11
- Defined in: [packages/play-solid/examples/demo/src/components/DebugPanel.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/components/DebugPanel.tsx#L10)
11
+ Defined in: [packages/play-solid/examples/demo/src/components/DebugPanel.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/components/DebugPanel.tsx#L10)
12
12
 
13
13
  DebugPanel — Live debug footer.
14
14
  Observes actor.state and actor.currentRoute via watchSignal;
package/examples/@xmachines/play-solid-demo/variables/Home.md CHANGED
@@ -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:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/components/Home.tsx#L9)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Home.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/components/Home.tsx#L9)
package/examples/@xmachines/play-solid-demo/variables/Login.md CHANGED
@@ -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:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/components/Login.tsx#L12)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Login.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/components/Login.tsx#L12)
package/examples/@xmachines/play-solid-demo/variables/NavBar.md CHANGED
@@ -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:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/components/NavBar.tsx#L15)
11
+ Defined in: [packages/play-solid/examples/demo/src/components/NavBar.tsx:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/components/NavBar.tsx#L15)
package/examples/@xmachines/play-solid-demo/variables/NavBarView.md CHANGED
@@ -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/NavBarView.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/components/NavBarView.tsx#L11)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/NavBarView.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/components/NavBarView.tsx#L11)
10
10
 
11
11
  NavBarView — Catalog-typed NavBar for use in defineRegistry components map.
12
12
 
package/examples/@xmachines/play-solid-demo/variables/Navigation.md CHANGED
@@ -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:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/components/Navigation.tsx#L9)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Navigation.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/components/Navigation.tsx#L9)
package/examples/@xmachines/play-solid-demo/variables/Overview.md CHANGED
@@ -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:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/components/Overview.tsx#L9)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Overview.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/components/Overview.tsx#L9)
package/examples/@xmachines/play-solid-demo/variables/Profile.md CHANGED
@@ -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:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/components/Profile.tsx#L9)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Profile.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/components/Profile.tsx#L9)
package/examples/@xmachines/play-solid-demo/variables/Settings.md CHANGED
@@ -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:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/components/Settings.tsx#L9)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Settings.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/components/Settings.tsx#L9)
package/examples/@xmachines/play-solid-demo/variables/Shell.md CHANGED
@@ -10,7 +10,7 @@ const Shell: Component<{
10
10
  }>;
11
11
  ```
12
12
 
13
- Defined in: [packages/play-solid/examples/demo/src/components/Shell.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/components/Shell.tsx#L13)
13
+ Defined in: [packages/play-solid/examples/demo/src/components/Shell.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/components/Shell.tsx#L13)
14
14
 
15
15
  Shell — Demo shell layout component.
16
16
  Renders standard demo chrome (header + PlayUIProvider/PlayRenderer + DebugPanel).
package/examples/@xmachines/play-solid-demo/variables/Stats.md CHANGED
@@ -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:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid/examples/demo/src/components/Stats.tsx#L9)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Stats.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-solid/examples/demo/src/components/Stats.tsx#L9)
package/examples/@xmachines/play-solid-demo/variables/authCatalog.md CHANGED
@@ -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.52/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.53/packages/play-solid/examples/demo/src/catalog.ts#L5)
package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md CHANGED
@@ -6,4 +6,4 @@
6
6
  type AuthCatalog = typeof authCatalog;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-svelte/examples/demo/src/catalog.ts#L6)
9
+ Defined in: [packages/play-svelte/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-svelte/examples/demo/src/catalog.ts#L6)
package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md CHANGED
@@ -169,4 +169,4 @@ const authCatalog: Catalog<
169
169
  >;
170
170
  ```
171
171
 
172
- Defined in: [packages/play-svelte/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-svelte/examples/demo/src/catalog.ts#L5)
172
+ Defined in: [packages/play-svelte/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-svelte/examples/demo/src/catalog.ts#L5)
package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md CHANGED
@@ -6,4 +6,4 @@
6
6
  type AuthCatalog = typeof authCatalog;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/examples/demo/src/catalog.ts#L6)
9
+ Defined in: [packages/play-vue/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-vue/examples/demo/src/catalog.ts#L6)
package/examples/@xmachines/play-vue-demo/variables/App.md CHANGED
@@ -6,4 +6,4 @@
6
6
  const App: DefineComponent<{}, {}, unknown>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/examples/demo/src/env.d.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/examples/demo/src/env.d.ts#L5)
9
+ Defined in: [packages/play-vue/examples/demo/src/env.d.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-vue/examples/demo/src/env.d.ts#L5)
package/examples/@xmachines/play-vue-demo/variables/authCatalog.md CHANGED
@@ -169,4 +169,4 @@ const authCatalog: Catalog<
169
169
  >;
170
170
  ```
171
171
 
172
- Defined in: [packages/play-vue/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-vue/examples/demo/src/catalog.ts#L5)
172
+ Defined in: [packages/play-vue/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-vue/examples/demo/src/catalog.ts#L5)
package/guides/getting-started.md CHANGED
@@ -135,11 +135,11 @@ TypeScript incremental builds depend on `.tsbuildinfo` files. After a full clean
135
135
 
136
136
  Once your setup is verified, continue with:
137
137
 
138
- - **[docs/ARCHITECTURE.md](ARCHITECTURE.md)** — System design, layers, invariants, and data flow
139
- - **[CONTRIBUTING.md](../CONTRIBUTING.md)** — Coding standards, branch conventions, and PR process
140
- - **[packages/docs/contributing/development.md](../packages/docs/contributing/development.md)** — Full development lifecycle: build commands, adding packages, commit conventions
141
- - **[packages/docs/contributing/testing.md](../packages/docs/contributing/testing.md)** — Vitest setup, test conventions, coverage thresholds, browser tests
142
- - **[packages/docs/rfc/](../packages/docs/rfc/)** — RFC specifications (read the relevant RFC before implementing any feature)
138
+ - **[Architecture](../contributing/architecture.md)** — System design, layers, invariants, and data flow
139
+ - **[Contributing](../../../CONTRIBUTING.md)** — Coding standards, branch conventions, and PR process
140
+ - **[Development](../contributing/development.md)** — Full development lifecycle: build commands, adding packages, commit conventions
141
+ - **[Testing](../contributing/testing.md)** — Vitest setup, test conventions, coverage thresholds, browser tests
142
+ - **[packages/docs/rfc/](../rfc/)** — RFC specifications (read the relevant RFC before implementing any feature)
143
143
 
144
144
  ---
145
145
 
@@ -152,7 +152,7 @@ This section covers installing XMachines packages into your own application and
152
152
  - **Node.js** `>= 22.0.0`
153
153
  - **npm** `>= 10.0.0`
154
154
  - **TypeScript** `>= 5.7` (strict mode recommended)
155
- - **XState** `v5` (required peer dependency for [`@xmachines/play-xstate`](../packages/docs/api/@xmachines/play-xstate/README.md))
155
+ - **XState** `v5` (required peer dependency for [`@xmachines/play-xstate`](../api/@xmachines/play-xstate/README.md))
156
156
 
157
157
  All packages are ES modules (`"type": "module"`). Use `.js` extensions in all TypeScript imports.
158
158
 
@@ -166,12 +166,12 @@ Every XMachines application needs these three packages plus XState:
166
166
  npm install xstate @xmachines/play-xstate @xmachines/play-actor @xmachines/play-signals
167
167
  ```
168
168
 
169
- | Package | Role |
170
- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
171
- | `xstate` | XState v5 state machine engine (peer dependency) |
172
- | [`@xmachines/play-xstate`](../packages/docs/api/@xmachines/play-xstate/README.md) | [`definePlayer()`](../packages/docs/api/@xmachines/play-xstate/functions/definePlayer.md), [`PlayerActor`](../packages/docs/api/@xmachines/play-xstate/classes/PlayerActor.md), routing helpers |
173
- | [`@xmachines/play-actor`](../packages/docs/api/@xmachines/play-actor/README.md) | Abstract actor base class and interface types |
174
- | [`@xmachines/play-signals`](../packages/docs/api/@xmachines/play-signals/README.md) | TC39 Signals polyfill (`Signal.State`, `Signal.Computed`, [`watchSignal`](../packages/docs/api/@xmachines/play-signals/functions/watchSignal.md)) |
169
+ | Package | Role |
170
+ | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
171
+ | `xstate` | XState v5 state machine engine (peer dependency) |
172
+ | [`@xmachines/play-xstate`](../api/@xmachines/play-xstate/README.md) | [`definePlayer()`](../api/@xmachines/play-xstate/functions/definePlayer.md), [`PlayerActor`](../api/@xmachines/play-xstate/classes/PlayerActor.md), routing helpers |
173
+ | [`@xmachines/play-actor`](../api/@xmachines/play-actor/README.md) | Abstract actor base class and interface types |
174
+ | [`@xmachines/play-signals`](../api/@xmachines/play-signals/README.md) | TC39 Signals polyfill (`Signal.State`, `Signal.Computed`, [`watchSignal`](../api/@xmachines/play-signals/functions/watchSignal.md)) |
175
175
 
176
176
  #### Step 2: Install a router adapter (pick one)
177
177
 
@@ -277,7 +277,7 @@ State machines control navigation through `meta.route` on states and `play.route
277
277
 
278
278
  #### Define a routable machine with `formatPlayRouteTransitions`
279
279
 
280
- [`formatPlayRouteTransitions`](../packages/docs/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md) auto-generates `play.route` handlers from `id` + `meta.route` state pairs:
280
+ [`formatPlayRouteTransitions`](../api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md) auto-generates `play.route` handlers from `id` + `meta.route` state pairs:
281
281
 
282
282
  ```typescript
283
283
  import { setup } from "xstate";
@@ -363,7 +363,7 @@ actor.stop();
363
363
 
364
364
  **Routing rules:**
365
365
 
366
- - Every routable state **must** have an `id` — [`formatPlayRouteTransitions`](../packages/docs/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md) throws `MissingStateIdError` if absent.
366
+ - Every routable state **must** have an `id` — [`formatPlayRouteTransitions`](../api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md) throws `MissingStateIdError` if absent.
367
367
  - Send `play.route` events with `to: "#stateId"` — always use the `id` field prefixed with `#`, never raw URL paths.
368
368
  - The machine context **must** include `params: Record<string, string>` and `query: Record<string, string>`.
369
369
  - Use `always` guards to protect states from direct URL access — these fire even on browser back/forward.
@@ -616,7 +616,7 @@ window.addEventListener("beforeunload", () => disconnect());
616
616
 
617
617
  #### Missing `params` / `query` in context
618
618
 
619
- **Error:** `MissingQueryContextError` at runtime when using [`formatPlayRouteTransitions`](../packages/docs/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md).
619
+ **Error:** `MissingQueryContextError` at runtime when using [`formatPlayRouteTransitions`](../api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md).
620
620
 
621
621
  **Fix:** Add `params` and `query` fields to your machine context type and initial value:
622
622
 
@@ -685,30 +685,30 @@ node --version
685
685
 
686
686
  ## Key Concepts Reference
687
687
 
688
- | Term | Description |
689
- | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
690
- | `setup({ types })` | XState v5 entry point — declares TypeScript types for context, events, and input |
691
- | [`definePlayer({ machine })`](../packages/docs/api/@xmachines/play-xstate/functions/definePlayer.md) | Creates a factory that produces [`PlayerActor`](../packages/docs/api/@xmachines/play-xstate/classes/PlayerActor.md) instances |
692
- | `actor.start()` | Activates the machine — always call before sending events |
693
- | `actor.send({ type })` | Sends an event; machine guards decide whether a transition occurs |
694
- | `actor.getSnapshot()` | Synchronous read of current state and context |
695
- | `actor.state` | `Signal.State<Snapshot>` — TC39 Signal for reactive state observation |
696
- | `actor.currentRoute` | `Signal.Computed<string \| null>` — resolved URL from active state's `meta.route` |
697
- | `actor.currentView` | `Signal.State<PlaySpec \| null>` — view spec from active state's `meta.view` |
698
- | [`formatPlayRouteTransitions`](../packages/docs/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md) | Generates `play.route` handlers from `id` + `meta.route` state pairs |
699
- | `play.route` event | Navigation event — `to: "#stateId"`, optional `params`, `query` |
700
- | `always` guard | Protects states — fires on entry before any event, even on direct URL access |
701
- | [`extractMachineRoutes`](../packages/docs/api/@xmachines/play-router/functions/extractMachineRoutes.md) | Extracts a `RouteTree` from a state machine — used by framework-integrated router adapters |
702
- | [`createRouteMapFromTree`](../packages/docs/api/@xmachines/play-router/functions/createRouteMapFromTree.md) | Builds a `RouteMap` from a `RouteTree` for bidirectional state ID ↔ URL lookups |
703
- | [`connectRouter`](../packages/docs/api/@xmachines/play-dom-router/functions/connectRouter.md) | Connects a vanilla DOM router to an actor — returns a disconnect cleanup function |
704
- | [`PlayRouterProvider`](../packages/docs/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md) | React component that connects a `PlayerActor` to TanStack React Router |
688
+ | Term | Description |
689
+ | ----------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
690
+ | `setup({ types })` | XState v5 entry point — declares TypeScript types for context, events, and input |
691
+ | [`definePlayer({ machine })`](../api/@xmachines/play-xstate/functions/definePlayer.md) | Creates a factory that produces [`PlayerActor`](../api/@xmachines/play-xstate/classes/PlayerActor.md) instances |
692
+ | `actor.start()` | Activates the machine — always call before sending events |
693
+ | `actor.send({ type })` | Sends an event; machine guards decide whether a transition occurs |
694
+ | `actor.getSnapshot()` | Synchronous read of current state and context |
695
+ | `actor.state` | `Signal.State<Snapshot>` — TC39 Signal for reactive state observation |
696
+ | `actor.currentRoute` | `Signal.Computed<string \| null>` — resolved URL from active state's `meta.route` |
697
+ | `actor.currentView` | `Signal.State<PlaySpec \| null>` — view spec from active state's `meta.view` |
698
+ | [`formatPlayRouteTransitions`](../api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md) | Generates `play.route` handlers from `id` + `meta.route` state pairs |
699
+ | `play.route` event | Navigation event — `to: "#stateId"`, optional `params`, `query` |
700
+ | `always` guard | Protects states — fires on entry before any event, even on direct URL access |
701
+ | [`extractMachineRoutes`](../api/@xmachines/play-router/functions/extractMachineRoutes.md) | Extracts a `RouteTree` from a state machine — used by framework-integrated router adapters |
702
+ | [`createRouteMapFromTree`](../api/@xmachines/play-router/functions/createRouteMapFromTree.md) | Builds a `RouteMap` from a `RouteTree` for bidirectional state ID ↔ URL lookups |
703
+ | [`connectRouter`](../api/@xmachines/play-dom-router/functions/connectRouter.md) | Connects a vanilla DOM router to an actor — returns a disconnect cleanup function |
704
+ | [`PlayRouterProvider`](../api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md) | React component that connects a `PlayerActor` to TanStack React Router |
705
705
 
706
706
  ---
707
707
 
708
708
  ## Next Steps
709
709
 
710
- - **[docs/ARCHITECTURE.md](ARCHITECTURE.md)** — System design, layers, invariants, and data flow
711
- - **[packages/docs/rfc/play.md](../packages/docs/rfc/play.md)** — Complete architectural specification
712
- - **[packages/docs/api/README.md](../packages/docs/api/README.md)** — Auto-generated API docs for all packages
713
- - **[packages/docs/examples/](../packages/docs/examples/)** — Basic state machine, form validation, routing pattern demos
714
- - **[CONTRIBUTING.md](../CONTRIBUTING.md)** — Coding standards, branch conventions, and PR process (contributors)
710
+ - **[Architecture](../contributing/architecture.md)** — System design, layers, invariants, and data flow
711
+ - **[Play RFC](../rfc/play.md)** — Complete architectural specification
712
+ - **[API Reference](../api/README.md)** — Auto-generated API docs for all packages
713
+ - **[Examples](../examples/)** — Basic state machine, form validation, routing pattern demos
714
+ - **[Contributing](../../../CONTRIBUTING.md)** — Coding standards, branch conventions, and PR process (contributors)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xmachines/docs",
3
- "version": "1.0.0-beta.52",
3
+ "version": "1.0.0-beta.53",
4
4
  "description": "Documentation for XMachines",
5
5
  "keywords": [
6
6
  "documentation",
@@ -51,7 +51,7 @@
51
51
  "test": "vitest run"
52
52
  },
53
53
  "devDependencies": {
54
- "@xmachines/shared": "1.0.0-beta.52",
54
+ "@xmachines/shared": "1.0.0-beta.53",
55
55
  "oxfmt": "^0.47.0",
56
56
  "oxlint": "^1.62.0",
57
57
  "typedoc": "^0.28.19",