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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (320) hide show
  1. package/api/@xmachines/play/README.md +4 -4
  2. package/api/@xmachines/play/classes/PlayError.md +10 -4
  3. package/api/@xmachines/play/type-aliases/PlayEvent.md +3 -3
  4. package/api/@xmachines/play-actor/README.md +6 -6
  5. package/api/@xmachines/play-actor/classes/AbstractActor.md +25 -3
  6. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  7. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  8. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  9. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  10. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  11. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  12. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  13. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  14. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  15. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  16. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  17. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +3 -3
  18. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +3 -3
  19. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +7 -7
  20. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  21. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +3 -3
  22. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  23. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  24. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  25. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  26. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  27. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  28. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  29. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  30. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  31. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  32. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  33. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  34. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  35. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  36. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  37. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +4 -4
  38. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  39. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  40. package/api/@xmachines/play-react/README.md +1 -1
  41. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +31 -5
  42. package/api/@xmachines/play-react/functions/defineRegistry.md +2 -0
  43. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  44. package/api/@xmachines/play-react/functions/useBoundProp.md +2 -0
  45. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  46. package/api/@xmachines/play-react/functions/useStateBinding.md +2 -0
  47. package/api/@xmachines/play-react/interfaces/ComponentContext.md +2 -0
  48. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  49. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  50. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +7 -7
  51. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +2 -0
  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/README.md +3 -3
  55. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  56. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  57. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  58. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  59. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  60. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  61. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  62. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +4 -4
  63. package/api/@xmachines/play-router/README.md +5 -5
  64. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  65. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  66. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  67. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  68. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  69. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  70. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  71. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  72. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  73. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  74. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  75. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  76. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  77. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  78. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  79. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  80. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  81. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  82. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  83. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  84. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  85. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  86. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  87. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  88. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  89. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  90. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +7 -7
  91. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  92. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  93. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  94. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  95. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  96. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  97. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  98. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  99. package/api/@xmachines/play-router/interfaces/RouterBridge.md +4 -4
  100. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  101. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  102. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  103. package/api/@xmachines/play-signals/README.md +2 -2
  104. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  105. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  106. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  107. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  108. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  109. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  110. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +6 -0
  111. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +8 -0
  112. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +2 -0
  113. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +10 -0
  114. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +2 -0
  115. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +2 -0
  116. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +2 -0
  117. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +2 -0
  118. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +2 -0
  119. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +2 -0
  120. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +2 -0
  121. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +2 -0
  122. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +2 -0
  123. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +2 -0
  124. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +2 -0
  125. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  126. package/api/@xmachines/play-solid/README.md +3 -3
  127. package/api/@xmachines/play-solid/functions/defineRegistry.md +2 -0
  128. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  129. package/api/@xmachines/play-solid/functions/useStateBinding.md +2 -0
  130. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +2 -0
  131. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +7 -7
  132. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +2 -0
  133. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  134. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  135. package/api/@xmachines/play-solid-router/README.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 +24 -24
  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 +23 -3
  141. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  142. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  143. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  144. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +4 -4
  145. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  146. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  147. package/api/@xmachines/play-svelte/functions/defineRegistry.md +2 -0
  148. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +2 -0
  149. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +2 -0
  150. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +7 -7
  151. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +2 -0
  152. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +2 -0
  153. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +2 -0
  154. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  155. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  156. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  157. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  158. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  159. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  160. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +4 -4
  161. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  162. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  163. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  164. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  165. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  166. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  167. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  168. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  169. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  170. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +4 -4
  171. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  172. package/api/@xmachines/play-tanstack-react-router/README.md +4 -4
  173. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  174. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  175. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  176. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  177. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  178. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  179. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  180. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  181. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  182. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  183. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +4 -4
  184. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  185. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  186. package/api/@xmachines/play-tanstack-solid-router/README.md +5 -5
  187. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  188. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  189. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  190. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  191. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  192. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  193. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  194. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +4 -4
  195. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  196. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  197. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  198. package/api/@xmachines/play-vue/README.md +1 -1
  199. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  200. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  201. package/api/@xmachines/play-vue/functions/useStateBinding.md +2 -0
  202. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +2 -0
  203. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  204. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  205. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +2 -0
  206. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  207. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  208. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  209. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  210. package/api/@xmachines/play-vue-router/README.md +1 -1
  211. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  212. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  213. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  214. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  215. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +7 -7
  216. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  217. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +4 -4
  218. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  219. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  220. package/api/@xmachines/play-xstate/README.md +10 -10
  221. package/api/@xmachines/play-xstate/classes/PlayerActor.md +26 -12
  222. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  223. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  224. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  225. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  226. package/api/@xmachines/play-xstate/functions/definePlayer.md +2 -2
  227. package/api/@xmachines/play-xstate/functions/deriveRoute.md +2 -2
  228. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  229. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  230. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  231. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  232. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  233. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  234. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  235. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  236. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  237. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  238. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  239. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  240. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  241. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  242. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  243. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  244. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  245. package/api/README.md +1 -41
  246. package/api/llms.txt +4 -8
  247. package/{api → examples}/@xmachines/play-actor-shared/README.md +1 -1
  248. package/{api → examples}/@xmachines/play-actor-shared/interfaces/AuthContext.md +5 -5
  249. package/{api → examples}/@xmachines/play-actor-shared/type-aliases/AuthActor.md +1 -1
  250. package/{api → examples}/@xmachines/play-actor-shared/type-aliases/AuthCatalog.md +1 -1
  251. package/{api → examples}/@xmachines/play-actor-shared/type-aliases/AuthEvents.md +1 -1
  252. package/{api → examples}/@xmachines/play-actor-shared/type-aliases/AuthInput.md +1 -1
  253. package/{api → examples}/@xmachines/play-actor-shared/type-aliases/AuthSnapshot.md +1 -1
  254. package/{api → examples}/@xmachines/play-actor-shared/type-aliases/CatalogProps.md +11 -11
  255. package/{api → examples}/@xmachines/play-actor-shared/type-aliases/InferProps.md +1 -1
  256. package/{api → examples}/@xmachines/play-actor-shared/variables/authCatalog.md +1 -1
  257. package/{api → examples}/@xmachines/play-actor-shared/variables/authMachine.md +1 -1
  258. package/{api → examples}/@xmachines/play-actor-shared/variables/authSetup.md +1 -1
  259. package/{api → examples}/@xmachines/play-dom-demo/README.md +2 -2
  260. package/{api → examples}/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  261. package/{api → examples}/@xmachines/play-dom-demo/variables/About.md +1 -1
  262. package/{api → examples}/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  263. package/{api → examples}/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  264. package/{api → examples}/@xmachines/play-dom-demo/variables/Home.md +1 -1
  265. package/{api → examples}/@xmachines/play-dom-demo/variables/Login.md +1 -1
  266. package/{api → examples}/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  267. package/{api → examples}/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  268. package/{api → examples}/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  269. package/{api → examples}/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  270. package/{api → examples}/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  271. package/{api → examples}/@xmachines/play-dom-router-demo/README.md +3 -3
  272. package/{api → examples}/@xmachines/play-react-demo/README.md +2 -2
  273. package/{api → examples}/@xmachines/play-react-demo/functions/App.md +1 -1
  274. package/{api → examples}/@xmachines/play-react-demo/functions/DebugPanel.md +1 -1
  275. package/{api → examples}/@xmachines/play-react-demo/functions/HeaderNav.md +1 -1
  276. package/{api → examples}/@xmachines/play-react-demo/functions/Shell.md +1 -1
  277. package/{api → examples}/@xmachines/play-react-demo/variables/About.md +1 -1
  278. package/{api → examples}/@xmachines/play-react-demo/variables/Contact.md +1 -1
  279. package/{api → examples}/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  280. package/{api → examples}/@xmachines/play-react-demo/variables/Home.md +1 -1
  281. package/{api → examples}/@xmachines/play-react-demo/variables/Login.md +1 -1
  282. package/{api → examples}/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  283. package/{api → examples}/@xmachines/play-react-demo/variables/Overview.md +1 -1
  284. package/{api → examples}/@xmachines/play-react-demo/variables/Profile.md +1 -1
  285. package/{api → examples}/@xmachines/play-react-demo/variables/Settings.md +1 -1
  286. package/{api → examples}/@xmachines/play-react-demo/variables/Stats.md +1 -1
  287. package/{api → examples}/@xmachines/play-react-router-demo/README.md +2 -2
  288. package/examples/@xmachines/play-router-shared/README.md +111 -0
  289. package/examples/@xmachines/play-router-shared/test/auth-machine-routing.test.ts/README.md +3 -0
  290. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/README.md +11 -0
  291. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/functions/defineSharedDemoBrowserSuite.md +19 -0
  292. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/variables/defineRouterDemoBrowserSuite.md +19 -0
  293. package/examples/@xmachines/play-router-shared/test/env.d.ts/README.md +8 -0
  294. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMeta.md +63 -0
  295. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMetaEnv.md +32 -0
  296. package/{api → examples}/@xmachines/play-solid-demo/README.md +3 -3
  297. package/{api → examples}/@xmachines/play-solid-demo/functions/App.md +1 -1
  298. package/{api → examples}/@xmachines/play-solid-demo/functions/DebugPanel.md +1 -1
  299. package/{api → examples}/@xmachines/play-solid-demo/functions/HeaderNav.md +1 -1
  300. package/{api → examples}/@xmachines/play-solid-demo/functions/Shell.md +1 -1
  301. package/{api → examples}/@xmachines/play-solid-demo/variables/About.md +1 -1
  302. package/{api → examples}/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  303. package/{api → examples}/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  304. package/{api → examples}/@xmachines/play-solid-demo/variables/Home.md +1 -1
  305. package/{api → examples}/@xmachines/play-solid-demo/variables/Login.md +1 -1
  306. package/{api → examples}/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  307. package/{api → examples}/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  308. package/{api → examples}/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  309. package/{api → examples}/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  310. package/{api → examples}/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  311. package/{api → examples}/@xmachines/play-solid-router-demo/README.md +3 -3
  312. package/{api → examples}/@xmachines/play-svelte-demo/README.md +1 -1
  313. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +129 -0
  314. package/examples/@xmachines/play-sveltekit-router-demo/README.md +130 -0
  315. package/{api → examples}/@xmachines/play-tanstack-react-router-demo/README.md +3 -3
  316. package/{api → examples}/@xmachines/play-tanstack-solid-router-demo/README.md +4 -4
  317. package/{api → examples}/@xmachines/play-vue-demo/README.md +2 -2
  318. package/{api → examples}/@xmachines/play-vue-router-demo/README.md +2 -2
  319. package/examples/README.md +51 -27
  320. package/package.json +6 -4
package/api/README.md CHANGED
@@ -1,63 +1,23 @@
1
- # XMachines API Reference
2
-
3
- Generated API documentation for the XMachines JavaScript/TypeScript packages.
4
-
5
- ## Start Here
6
-
7
- - For actor contracts, start with [@xmachines/play-actor](@xmachines/play-actor/README.md).
8
- - For player creation from XState machines, start with [@xmachines/play-xstate](@xmachines/play-xstate/README.md).
9
- - For route extraction and shared URL synchronization logic, start with [@xmachines/play-router](@xmachines/play-router/README.md).
10
- - For rendering, choose one of [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), [@xmachines/play-svelte](@xmachines/play-svelte/README.md), or [@xmachines/play-vue](@xmachines/play-vue/README.md).
11
- - For framework router integration, choose the matching adapter package such as [@xmachines/play-react-router](@xmachines/play-react-router/README.md), [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md), [@xmachines/play-sveltekit-router](@xmachines/play-sveltekit-router/README.md), or [@xmachines/play-svelte-spa-router](@xmachines/play-svelte-spa-router/README.md).
12
-
13
- ## Key Concepts
14
-
15
- - [Viewable](@xmachines/play-actor/interfaces/Viewable.md) actors expose `currentView` and a component catalog for renderer packages.
16
- - [Routable](@xmachines/play-actor/interfaces/Routable.md) actors expose `currentRoute` and route-oriented events for router adapters.
17
- - Router adapters are passive infrastructure: they synchronize URLs with actor state but do not own business rules.
18
-
19
- ## Package Roles
20
-
21
- - `Core runtime`: [@xmachines/play](@xmachines/play/README.md), [@xmachines/play-actor](@xmachines/play-actor/README.md), [@xmachines/play-signals](@xmachines/play-signals/README.md), [@xmachines/play-router](@xmachines/play-router/README.md), and [@xmachines/play-xstate](@xmachines/play-xstate/README.md)
22
- - `Rendering`: [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), [@xmachines/play-svelte](@xmachines/play-svelte/README.md), and [@xmachines/play-vue](@xmachines/play-vue/README.md)
23
- - `Router adapters`: [@xmachines/play-react-router](@xmachines/play-react-router/README.md), [@xmachines/play-tanstack-react-router](@xmachines/play-tanstack-react-router/README.md), [@xmachines/play-solid-router](@xmachines/play-solid-router/README.md), [@xmachines/play-tanstack-solid-router](@xmachines/play-tanstack-solid-router/README.md), [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md), [@xmachines/play-sveltekit-router](@xmachines/play-sveltekit-router/README.md), and [@xmachines/play-svelte-spa-router](@xmachines/play-svelte-spa-router/README.md)
24
- - `Shared tooling`: [@xmachines/shared](@xmachines/shared/README.md)
25
-
26
- ## Notes
27
-
28
- - Demo packages are included in the generated package index below, but most implementation questions should start with the core runtime and adapter packages above.
29
- - A useful reading order is usually: [@xmachines/play-actor](@xmachines/play-actor/README.md) -> [@xmachines/play-xstate](@xmachines/play-xstate/README.md) -> [@xmachines/play-router](@xmachines/play-router/README.md) -> framework renderer/adapter.
1
+ # Documentation
30
2
 
31
3
  ## Packages
32
4
 
33
5
  - [@xmachines/play](@xmachines/play/README.md)
34
6
  - [@xmachines/play-actor](@xmachines/play-actor/README.md)
35
- - [@xmachines/play-actor-shared](@xmachines/play-actor-shared/README.md)
36
7
  - [@xmachines/play-dom](@xmachines/play-dom/README.md)
37
- - [@xmachines/play-dom-demo](@xmachines/play-dom-demo/README.md)
38
8
  - [@xmachines/play-dom-router](@xmachines/play-dom-router/README.md)
39
- - [@xmachines/play-dom-router-demo](@xmachines/play-dom-router-demo/README.md)
40
9
  - [@xmachines/play-react](@xmachines/play-react/README.md)
41
- - [@xmachines/play-react-demo](@xmachines/play-react-demo/README.md)
42
10
  - [@xmachines/play-react-router](@xmachines/play-react-router/README.md)
43
- - [@xmachines/play-react-router-demo](@xmachines/play-react-router-demo/README.md)
44
11
  - [@xmachines/play-router](@xmachines/play-router/README.md)
45
12
  - [@xmachines/play-signals](@xmachines/play-signals/README.md)
46
13
  - [@xmachines/play-solid](@xmachines/play-solid/README.md)
47
- - [@xmachines/play-solid-demo](@xmachines/play-solid-demo/README.md)
48
14
  - [@xmachines/play-solid-router](@xmachines/play-solid-router/README.md)
49
- - [@xmachines/play-solid-router-demo](@xmachines/play-solid-router-demo/README.md)
50
15
  - [@xmachines/play-svelte](@xmachines/play-svelte/README.md)
51
- - [@xmachines/play-svelte-demo](@xmachines/play-svelte-demo/README.md)
52
16
  - [@xmachines/play-svelte-spa-router](@xmachines/play-svelte-spa-router/README.md)
53
17
  - [@xmachines/play-sveltekit-router](@xmachines/play-sveltekit-router/README.md)
54
18
  - [@xmachines/play-tanstack-react-router](@xmachines/play-tanstack-react-router/README.md)
55
- - [@xmachines/play-tanstack-react-router-demo](@xmachines/play-tanstack-react-router-demo/README.md)
56
19
  - [@xmachines/play-tanstack-solid-router](@xmachines/play-tanstack-solid-router/README.md)
57
- - [@xmachines/play-tanstack-solid-router-demo](@xmachines/play-tanstack-solid-router-demo/README.md)
58
20
  - [@xmachines/play-vue](@xmachines/play-vue/README.md)
59
- - [@xmachines/play-vue-demo](@xmachines/play-vue-demo/README.md)
60
21
  - [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md)
61
- - [@xmachines/play-vue-router-demo](@xmachines/play-vue-router-demo/README.md)
62
22
  - [@xmachines/play-xstate](@xmachines/play-xstate/README.md)
63
23
  - [@xmachines/shared](@xmachines/shared/README.md)
package/api/llms.txt CHANGED
@@ -33,11 +33,14 @@
33
33
  - [@xmachines/play-react](@xmachines/play-react/README.md): React renderer for Viewable actors
34
34
  - [@xmachines/play-solid](@xmachines/play-solid/README.md): Solid renderer for Viewable actors
35
35
  - [@xmachines/play-vue](@xmachines/play-vue/README.md): Vue renderer for Viewable actors
36
+ - [@xmachines/play-svelte](@xmachines/play-svelte/README.md): Svelte renderer for Viewable actors
36
37
  - [@xmachines/play-react-router](@xmachines/play-react-router/README.md): React Router bridge and provider for actor-driven navigation
37
38
  - [@xmachines/play-tanstack-react-router](@xmachines/play-tanstack-react-router/README.md): TanStack React Router bridge and provider
38
39
  - [@xmachines/play-solid-router](@xmachines/play-solid-router/README.md): Solid Router bridge and provider
39
40
  - [@xmachines/play-tanstack-solid-router](@xmachines/play-tanstack-solid-router/README.md): TanStack Solid Router bridge and provider
40
41
  - [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md): Vue Router bridge and provider
42
+ - [@xmachines/play-sveltekit-router](@xmachines/play-sveltekit-router/README.md): SvelteKit router adapter for actor-driven navigation
43
+ - [@xmachines/play-svelte-spa-router](@xmachines/play-svelte-spa-router/README.md): Svelte SPA router adapter for actor-driven navigation
41
44
  - [@xmachines/shared](@xmachines/shared/README.md): Shared TypeScript, oxlint, and formatting configuration
42
45
 
43
46
  ## Notes For LLMs
@@ -56,21 +59,14 @@ import { extractMachineRoutes } from '@xmachines/play-router';
56
59
  import { defineRegistry } from '@json-render/react';
57
60
  import { PlayRenderer } from '@xmachines/play-react';
58
61
 
59
- // Define a player from a machine
60
62
  const createPlayer = definePlayer({ machine });
61
63
  const actor = createPlayer();
62
64
  actor.start();
63
65
 
64
- // `Viewable` actors expose renderable view metadata
65
- const currentView = actor.currentView.get(); // { component, spec }
66
-
67
- // `Routable` actors expose route state for adapters to observe
66
+ const currentView = actor.currentView.get();
68
67
  const currentRoute = actor.currentRoute.get();
69
-
70
- // Extract route metadata for a framework adapter
71
68
  const routeTree = extractMachineRoutes(machine);
72
69
 
73
- // Wire components to catalog and render
74
70
  const { registry } = defineRegistry(catalog, { components, actions });
75
71
  <PlayRenderer actor={actor} registry={registry} actions={{ login: 'auth.login' }} />
76
72
  ```
@@ -132,7 +132,7 @@ Expected result: machine exports, start state, login, and logout invariants all
132
132
 
133
133
  ## Learn More
134
134
 
135
- - [play-actor package README](../play-actor/README.md)
135
+ - [play-actor package README](../../README.md)
136
136
 
137
137
  ## Interfaces
138
138
 
@@ -2,13 +2,13 @@
2
2
 
3
3
  # Interface: AuthContext
4
4
 
5
- Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L27)
5
+ Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/auth-machine.ts#L27)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Type | Defined in |
10
10
  | ------------------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
11
- | <a id="property-isauthenticated"></a> `isAuthenticated` | `boolean` | [packages/play-actor/examples/shared/src/auth-machine.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L28) |
12
- | <a id="property-params"></a> `params` | `Record`\<`string`, `string`\> | [packages/play-actor/examples/shared/src/auth-machine.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L30) |
13
- | <a id="property-query"></a> `query` | `Record`\<`string`, `string`\> | [packages/play-actor/examples/shared/src/auth-machine.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L31) |
14
- | <a id="property-username"></a> `username` | `string` \| `null` | [packages/play-actor/examples/shared/src/auth-machine.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L29) |
11
+ | <a id="property-isauthenticated"></a> `isAuthenticated` | `boolean` | [packages/play-actor/examples/shared/src/auth-machine.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/auth-machine.ts#L28) |
12
+ | <a id="property-params"></a> `params` | `Record`\<`string`, `string`\> | [packages/play-actor/examples/shared/src/auth-machine.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/auth-machine.ts#L30) |
13
+ | <a id="property-query"></a> `query` | `Record`\<`string`, `string`\> | [packages/play-actor/examples/shared/src/auth-machine.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/auth-machine.ts#L31) |
14
+ | <a id="property-username"></a> `username` | `string` \| `null` | [packages/play-actor/examples/shared/src/auth-machine.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/auth-machine.ts#L29) |
@@ -6,7 +6,7 @@
6
6
  type AuthActor = PlayerActor<typeof authMachine>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:293](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L293)
9
+ Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:293](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/auth-machine.ts#L293)
10
10
 
11
11
  The actor type for the auth machine.
12
12
 
@@ -6,7 +6,7 @@
6
6
  type AuthCatalog = typeof authCatalog;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/examples/shared/src/catalog.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L69)
9
+ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/catalog.ts#L69)
10
10
 
11
11
  The type of the auth catalog — use as the `C` type param in `ComponentFn<AuthCatalog, "X">`,
12
12
  `ComponentContext<AuthCatalog, "X">`, and `defineRegistry(authCatalog, ...)`.
@@ -14,4 +14,4 @@ type AuthEvents =
14
14
  };
15
15
  ```
16
16
 
17
- Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L36)
17
+ Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/auth-machine.ts#L36)
@@ -6,4 +6,4 @@
6
6
  type AuthInput = Partial<AuthContext> | undefined;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L34)
9
+ Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/auth-machine.ts#L34)
@@ -6,6 +6,6 @@
6
6
  type AuthSnapshot = SnapshotFrom<typeof authMachine>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:273](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L273)
9
+ Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:273](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/auth-machine.ts#L273)
10
10
 
11
11
  Snapshot type for the auth machine — use for typed `matches()` calls.
@@ -6,7 +6,7 @@
6
6
  type CatalogProps = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/examples/shared/src/catalog.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L48)
9
+ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/catalog.ts#L48)
10
10
 
11
11
  ## Properties
12
12
 
@@ -16,7 +16,7 @@ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:48](https://gitl
16
16
  About: object;
17
17
  ```
18
18
 
19
- Defined in: [packages/play-actor/examples/shared/src/catalog.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L50)
19
+ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/catalog.ts#L50)
20
20
 
21
21
  #### title
22
22
 
@@ -32,7 +32,7 @@ title: string;
32
32
  Contact: object;
33
33
  ```
34
34
 
35
- Defined in: [packages/play-actor/examples/shared/src/catalog.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L51)
35
+ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/catalog.ts#L51)
36
36
 
37
37
  #### title
38
38
 
@@ -48,7 +48,7 @@ title: string;
48
48
  Dashboard: object;
49
49
  ```
50
50
 
51
- Defined in: [packages/play-actor/examples/shared/src/catalog.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L53)
51
+ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/catalog.ts#L53)
52
52
 
53
53
  #### username
54
54
 
@@ -70,7 +70,7 @@ welcome: boolean;
70
70
  Home: object;
71
71
  ```
72
72
 
73
- Defined in: [packages/play-actor/examples/shared/src/catalog.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L49)
73
+ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/catalog.ts#L49)
74
74
 
75
75
  #### title
76
76
 
@@ -86,7 +86,7 @@ title: string;
86
86
  Login: object;
87
87
  ```
88
88
 
89
- Defined in: [packages/play-actor/examples/shared/src/catalog.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L52)
89
+ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/catalog.ts#L52)
90
90
 
91
91
  #### title
92
92
 
@@ -102,7 +102,7 @@ title: string;
102
102
  Navigation: object;
103
103
  ```
104
104
 
105
- Defined in: [packages/play-actor/examples/shared/src/catalog.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L56)
105
+ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/catalog.ts#L56)
106
106
 
107
107
  #### currentPath
108
108
 
@@ -124,7 +124,7 @@ isAuthenticated: boolean;
124
124
  Overview: object;
125
125
  ```
126
126
 
127
- Defined in: [packages/play-actor/examples/shared/src/catalog.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L57)
127
+ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/catalog.ts#L57)
128
128
 
129
129
  #### title
130
130
 
@@ -140,7 +140,7 @@ title: string;
140
140
  Profile: object;
141
141
  ```
142
142
 
143
- Defined in: [packages/play-actor/examples/shared/src/catalog.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L54)
143
+ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/catalog.ts#L54)
144
144
 
145
145
  #### username
146
146
 
@@ -156,7 +156,7 @@ username: string;
156
156
  Settings: object;
157
157
  ```
158
158
 
159
- Defined in: [packages/play-actor/examples/shared/src/catalog.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L55)
159
+ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/catalog.ts#L55)
160
160
 
161
161
  #### section?
162
162
 
@@ -178,7 +178,7 @@ username: string;
178
178
  Stats: object;
179
179
  ```
180
180
 
181
- Defined in: [packages/play-actor/examples/shared/src/catalog.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L58)
181
+ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/catalog.ts#L58)
182
182
 
183
183
  #### title
184
184
 
@@ -6,7 +6,7 @@
6
6
  type InferProps<K> = CatalogProps[K];
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/examples/shared/src/catalog.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L74)
9
+ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/catalog.ts#L74)
10
10
 
11
11
  Infer props for a named component from the catalog type
12
12
 
@@ -170,4 +170,4 @@ const authCatalog: Catalog<
170
170
  >;
171
171
  ```
172
172
 
173
- Defined in: [packages/play-actor/examples/shared/src/catalog.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L14)
173
+ Defined in: [packages/play-actor/examples/shared/src/catalog.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/catalog.ts#L14)
@@ -186,4 +186,4 @@ const authMachine: StateMachine<AuthContext, AuthEvents, {
186
186
  }>>;
187
187
  ```
188
188
 
189
- Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L49)
189
+ Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/auth-machine.ts#L49)
@@ -19,4 +19,4 @@ const authSetup: SetupReturn<
19
19
  >;
20
20
  ```
21
21
 
22
- Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L41)
22
+ Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/examples/shared/src/auth-machine.ts#L41)
@@ -124,8 +124,8 @@ Expected result: library-pattern invariant tests pass and the browser renderer s
124
124
 
125
125
  ## Learn More
126
126
 
127
- - [Play DOM package README](../play-dom/README.md)
128
- - [Play DOM Router demo README](../play-dom-router-demo/README.md)
127
+ - [Play DOM package README](../../README.md)
128
+ - [Play DOM Router demo README](../../../play-dom-router/examples/demo/README.md)
129
129
 
130
130
  ## Variables
131
131
 
@@ -6,7 +6,7 @@
6
6
  function initShell(actor, appElement): () => void;
7
7
  ```
8
8
 
9
- Defined in: [shell.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/examples/demo/src/shell.ts#L32)
9
+ Defined in: [shell.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/examples/demo/src/shell.ts#L32)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -6,4 +6,4 @@
6
6
  const About: ComponentFn<AuthCatalog, "About">;
7
7
  ```
8
8
 
9
- Defined in: [components/About.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/examples/demo/src/components/About.ts#L4)
9
+ Defined in: [components/About.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/examples/demo/src/components/About.ts#L4)
@@ -6,4 +6,4 @@
6
6
  const Contact: ComponentFn<AuthCatalog, "Contact">;
7
7
  ```
8
8
 
9
- Defined in: [components/Contact.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/examples/demo/src/components/Contact.ts#L4)
9
+ Defined in: [components/Contact.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/examples/demo/src/components/Contact.ts#L4)
@@ -6,4 +6,4 @@
6
6
  const Dashboard: ComponentFn<AuthCatalog, "Dashboard">;
7
7
  ```
8
8
 
9
- Defined in: [components/Dashboard.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/examples/demo/src/components/Dashboard.ts#L4)
9
+ Defined in: [components/Dashboard.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/examples/demo/src/components/Dashboard.ts#L4)
@@ -6,4 +6,4 @@
6
6
  const Home: ComponentFn<AuthCatalog, "Home">;
7
7
  ```
8
8
 
9
- Defined in: [components/Home.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/examples/demo/src/components/Home.ts#L4)
9
+ Defined in: [components/Home.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/examples/demo/src/components/Home.ts#L4)
@@ -6,4 +6,4 @@
6
6
  const Login: ComponentFn<AuthCatalog, "Login">;
7
7
  ```
8
8
 
9
- Defined in: [components/Login.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/examples/demo/src/components/Login.ts#L4)
9
+ Defined in: [components/Login.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/examples/demo/src/components/Login.ts#L4)
@@ -6,4 +6,4 @@
6
6
  const Navigation: ComponentFn<AuthCatalog, "Navigation">;
7
7
  ```
8
8
 
9
- Defined in: [components/Navigation.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/examples/demo/src/components/Navigation.ts#L4)
9
+ Defined in: [components/Navigation.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/examples/demo/src/components/Navigation.ts#L4)
@@ -6,4 +6,4 @@
6
6
  const Overview: ComponentFn<AuthCatalog, "Overview">;
7
7
  ```
8
8
 
9
- Defined in: [components/Overview.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/examples/demo/src/components/Overview.ts#L4)
9
+ Defined in: [components/Overview.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/examples/demo/src/components/Overview.ts#L4)
@@ -6,4 +6,4 @@
6
6
  const Profile: ComponentFn<AuthCatalog, "Profile">;
7
7
  ```
8
8
 
9
- Defined in: [components/Profile.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/examples/demo/src/components/Profile.ts#L4)
9
+ Defined in: [components/Profile.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/examples/demo/src/components/Profile.ts#L4)
@@ -6,4 +6,4 @@
6
6
  const Settings: ComponentFn<AuthCatalog, "Settings">;
7
7
  ```
8
8
 
9
- Defined in: [components/Settings.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/examples/demo/src/components/Settings.ts#L4)
9
+ Defined in: [components/Settings.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/examples/demo/src/components/Settings.ts#L4)
@@ -6,4 +6,4 @@
6
6
  const Stats: ComponentFn<AuthCatalog, "Stats">;
7
7
  ```
8
8
 
9
- Defined in: [components/Stats.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/examples/demo/src/components/Stats.ts#L4)
9
+ Defined in: [components/Stats.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-dom/examples/demo/src/components/Stats.ts#L4)
@@ -131,6 +131,6 @@ Expected result: tests pass, including startup rendering and the full browser au
131
131
 
132
132
  ## Learn More
133
133
 
134
- - [Play DOM Router package README](../play-dom-router/README.md)
135
- - [Play DOM demo README](../play-dom-demo/README.md)
136
- - [Play Router package README](../play-router/README.md)
134
+ - [Play DOM Router package README](../../README.md)
135
+ - [Play DOM demo README](../../../play-dom/examples/demo/README.md)
136
+ - [Play Router package README](../../../play-router/README.md)
@@ -149,8 +149,8 @@ Expected result: library-pattern invariant tests pass and the browser renderer s
149
149
 
150
150
  ## Learn More
151
151
 
152
- - [React package README](../play-react/README.md)
153
- - [React Router demo README](../play-react-router-demo/README.md)
152
+ - [React package README](../../README.md)
153
+ - [React Router demo README](../../../play-react-router/examples/demo/README.md)
154
154
 
155
155
  ## Variables
156
156
 
@@ -6,7 +6,7 @@
6
6
  function App(): Element;
7
7
  ```
8
8
 
9
- Defined in: [App.tsx:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/App.tsx#L54)
9
+ Defined in: [App.tsx:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/App.tsx#L54)
10
10
 
11
11
  ## Returns
12
12
 
@@ -6,7 +6,7 @@
6
6
  function DebugPanel(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: [components/DebugPanel.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/DebugPanel.tsx#L5)
9
+ Defined in: [components/DebugPanel.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/DebugPanel.tsx#L5)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  function HeaderNav(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: [components/HeaderNav.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/HeaderNav.tsx#L13)
9
+ Defined in: [components/HeaderNav.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/HeaderNav.tsx#L13)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  function Shell(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: [components/Shell.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/Shell.tsx#L14)
9
+ Defined in: [components/Shell.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Shell.tsx#L14)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -6,4 +6,4 @@
6
6
  const About: ComponentFn<AuthCatalog, "About">;
7
7
  ```
8
8
 
9
- Defined in: [components/About.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/About.tsx#L11)
9
+ Defined in: [components/About.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/About.tsx#L11)
@@ -6,4 +6,4 @@
6
6
  const Contact: ComponentFn<AuthCatalog, "Contact">;
7
7
  ```
8
8
 
9
- Defined in: [components/Contact.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/Contact.tsx#L11)
9
+ Defined in: [components/Contact.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Contact.tsx#L11)
@@ -6,4 +6,4 @@
6
6
  const Dashboard: ComponentFn<AuthCatalog, "Dashboard">;
7
7
  ```
8
8
 
9
- Defined in: [components/Dashboard.tsx:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/Dashboard.tsx#L15)
9
+ Defined in: [components/Dashboard.tsx:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Dashboard.tsx#L15)
@@ -6,4 +6,4 @@
6
6
  const Home: ComponentFn<AuthCatalog, "Home">;
7
7
  ```
8
8
 
9
- Defined in: [components/Home.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/Home.tsx#L11)
9
+ Defined in: [components/Home.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Home.tsx#L11)
@@ -6,4 +6,4 @@
6
6
  const Login: ComponentFn<AuthCatalog, "Login">;
7
7
  ```
8
8
 
9
- Defined in: [components/Login.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/Login.tsx#L16)
9
+ Defined in: [components/Login.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Login.tsx#L16)
@@ -6,4 +6,4 @@
6
6
  const Navigation: ComponentFn<AuthCatalog, "Navigation">;
7
7
  ```
8
8
 
9
- Defined in: [components/Navigation.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/Navigation.tsx#L11)
9
+ Defined in: [components/Navigation.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Navigation.tsx#L11)
@@ -6,4 +6,4 @@
6
6
  const Overview: ComponentFn<AuthCatalog, "Overview">;
7
7
  ```
8
8
 
9
- Defined in: [components/Overview.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/Overview.tsx#L11)
9
+ Defined in: [components/Overview.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Overview.tsx#L11)
@@ -6,4 +6,4 @@
6
6
  const Profile: ComponentFn<AuthCatalog, "Profile">;
7
7
  ```
8
8
 
9
- Defined in: [components/Profile.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/Profile.tsx#L14)
9
+ Defined in: [components/Profile.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/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: [components/Settings.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/Settings.tsx#L14)
9
+ Defined in: [components/Settings.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Settings.tsx#L14)
@@ -6,4 +6,4 @@
6
6
  const Stats: ComponentFn<AuthCatalog, "Stats">;
7
7
  ```
8
8
 
9
- Defined in: [components/Stats.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/Stats.tsx#L11)
9
+ Defined in: [components/Stats.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Stats.tsx#L11)
@@ -143,5 +143,5 @@ Expected result: tests pass for startup and auth-flow browser scenarios.
143
143
 
144
144
  ## Learn More
145
145
 
146
- - [React Router package README](../play-react-router/README.md)
147
- - [React package README](../play-react/README.md)
146
+ - [React Router package README](../../README.md)
147
+ - [React package README](../../../play-react/README.md)