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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (288) hide show
  1. package/api/@xmachines/play/README.md +4 -4
  2. package/api/@xmachines/play/classes/PlayError.md +4 -4
  3. package/api/@xmachines/play/type-aliases/PlayEvent.md +3 -3
  4. package/api/@xmachines/play-actor/README.md +6 -6
  5. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  6. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  7. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  8. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  9. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  10. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  11. package/api/@xmachines/play-dom/README.md +50 -0
  12. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  13. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  14. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  15. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  16. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  17. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  18. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +3 -3
  19. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +3 -3
  20. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +7 -7
  21. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  22. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +3 -3
  23. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  24. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  25. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  26. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  27. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  28. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  29. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  30. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  31. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  32. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  33. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  34. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  35. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  36. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  37. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  38. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +4 -4
  39. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  40. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  41. package/api/@xmachines/play-react/README.md +1 -1
  42. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  43. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  44. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  45. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  46. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  47. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +7 -7
  48. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  49. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  50. package/api/@xmachines/play-react-router/README.md +3 -3
  51. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  52. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  53. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  54. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  55. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  56. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  57. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  58. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +4 -4
  59. package/api/@xmachines/play-router/README.md +6 -6
  60. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  61. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  62. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  63. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  64. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  65. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  66. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  67. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  68. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  69. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  70. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  71. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  72. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  73. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  74. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  75. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  76. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  77. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  78. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  79. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  80. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  81. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  82. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  83. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  84. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  85. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  86. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +7 -7
  87. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  88. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  89. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  90. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  91. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  92. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  93. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  94. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  95. package/api/@xmachines/play-router/interfaces/RouterBridge.md +4 -4
  96. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  97. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  98. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  99. package/api/@xmachines/play-signals/README.md +2 -2
  100. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  101. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  102. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  103. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  104. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  105. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  106. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  107. package/api/@xmachines/play-solid/README.md +3 -3
  108. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  109. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +7 -7
  110. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  111. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  112. package/api/@xmachines/play-solid-router/README.md +1 -1
  113. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  114. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  115. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  116. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  117. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  118. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  119. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  120. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  121. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +4 -4
  122. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  123. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  124. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +7 -7
  125. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  126. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  127. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  128. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  129. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  130. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  131. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +4 -4
  132. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  133. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  134. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  135. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  136. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  137. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  138. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  139. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  140. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  141. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +4 -4
  142. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  143. package/api/@xmachines/play-tanstack-react-router/README.md +4 -4
  144. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  145. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  146. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  147. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  148. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  149. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  150. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  151. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  152. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  153. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  154. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +4 -4
  155. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  156. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  157. package/api/@xmachines/play-tanstack-solid-router/README.md +5 -5
  158. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  159. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  160. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  161. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  162. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  163. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  164. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  165. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +4 -4
  166. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  167. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  168. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  169. package/api/@xmachines/play-vue/README.md +1 -1
  170. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  171. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  172. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  173. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  174. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  175. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  176. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  177. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  178. package/api/@xmachines/play-vue-router/README.md +1 -1
  179. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  180. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  181. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  182. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  183. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +7 -7
  184. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  185. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +4 -4
  186. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  187. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  188. package/api/@xmachines/play-xstate/README.md +10 -10
  189. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  190. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  191. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  192. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  193. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  194. package/api/@xmachines/play-xstate/functions/definePlayer.md +2 -2
  195. package/api/@xmachines/play-xstate/functions/deriveRoute.md +2 -2
  196. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  197. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  198. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  199. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  200. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  201. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  202. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  203. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  204. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  205. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  206. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  207. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  208. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  209. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  210. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  211. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  212. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  213. package/api/README.md +1 -37
  214. package/api/llms.txt +4 -11
  215. package/examples/@xmachines/play-actor-shared/README.md +155 -0
  216. package/examples/@xmachines/play-actor-shared/interfaces/AuthContext.md +14 -0
  217. package/examples/@xmachines/play-actor-shared/type-aliases/AuthActor.md +27 -0
  218. package/examples/@xmachines/play-actor-shared/type-aliases/AuthCatalog.md +16 -0
  219. package/examples/@xmachines/play-actor-shared/type-aliases/AuthEvents.md +17 -0
  220. package/examples/@xmachines/play-actor-shared/type-aliases/AuthInput.md +9 -0
  221. package/examples/@xmachines/play-actor-shared/type-aliases/AuthSnapshot.md +11 -0
  222. package/examples/@xmachines/play-actor-shared/type-aliases/CatalogProps.md +187 -0
  223. package/examples/@xmachines/play-actor-shared/type-aliases/InferProps.md +17 -0
  224. package/examples/@xmachines/play-actor-shared/variables/authCatalog.md +173 -0
  225. package/examples/@xmachines/play-actor-shared/variables/authMachine.md +189 -0
  226. package/examples/@xmachines/play-actor-shared/variables/authSetup.md +22 -0
  227. package/examples/@xmachines/play-dom-demo/README.md +145 -0
  228. package/examples/@xmachines/play-dom-demo/functions/initShell.md +20 -0
  229. package/examples/@xmachines/play-dom-demo/variables/About.md +9 -0
  230. package/examples/@xmachines/play-dom-demo/variables/Contact.md +9 -0
  231. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +9 -0
  232. package/examples/@xmachines/play-dom-demo/variables/Home.md +9 -0
  233. package/examples/@xmachines/play-dom-demo/variables/Login.md +9 -0
  234. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +9 -0
  235. package/examples/@xmachines/play-dom-demo/variables/Overview.md +9 -0
  236. package/examples/@xmachines/play-dom-demo/variables/Profile.md +9 -0
  237. package/examples/@xmachines/play-dom-demo/variables/Settings.md +9 -0
  238. package/examples/@xmachines/play-dom-demo/variables/Stats.md +9 -0
  239. package/{api → examples}/@xmachines/play-dom-router-demo/README.md +13 -13
  240. package/examples/@xmachines/play-react-demo/README.md +173 -0
  241. package/examples/@xmachines/play-react-demo/functions/App.md +13 -0
  242. package/examples/@xmachines/play-react-demo/functions/DebugPanel.md +20 -0
  243. package/examples/@xmachines/play-react-demo/functions/HeaderNav.md +20 -0
  244. package/examples/@xmachines/play-react-demo/functions/Shell.md +22 -0
  245. package/examples/@xmachines/play-react-demo/variables/About.md +9 -0
  246. package/examples/@xmachines/play-react-demo/variables/Contact.md +9 -0
  247. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +9 -0
  248. package/examples/@xmachines/play-react-demo/variables/Home.md +9 -0
  249. package/examples/@xmachines/play-react-demo/variables/Login.md +9 -0
  250. package/examples/@xmachines/play-react-demo/variables/Navigation.md +9 -0
  251. package/examples/@xmachines/play-react-demo/variables/Overview.md +9 -0
  252. package/examples/@xmachines/play-react-demo/variables/Profile.md +9 -0
  253. package/examples/@xmachines/play-react-demo/variables/Settings.md +9 -0
  254. package/examples/@xmachines/play-react-demo/variables/Stats.md +9 -0
  255. package/{api → examples}/@xmachines/play-react-router-demo/README.md +12 -12
  256. package/examples/@xmachines/play-router-shared/README.md +111 -0
  257. package/examples/@xmachines/play-router-shared/test/auth-machine-routing.test.ts/README.md +3 -0
  258. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/README.md +11 -0
  259. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/functions/defineSharedDemoBrowserSuite.md +19 -0
  260. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/variables/defineRouterDemoBrowserSuite.md +19 -0
  261. package/examples/@xmachines/play-router-shared/test/env.d.ts/README.md +8 -0
  262. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMeta.md +63 -0
  263. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMetaEnv.md +32 -0
  264. package/examples/@xmachines/play-solid-demo/README.md +159 -0
  265. package/examples/@xmachines/play-solid-demo/functions/App.md +13 -0
  266. package/examples/@xmachines/play-solid-demo/functions/DebugPanel.md +20 -0
  267. package/examples/@xmachines/play-solid-demo/functions/HeaderNav.md +20 -0
  268. package/examples/@xmachines/play-solid-demo/functions/Shell.md +22 -0
  269. package/examples/@xmachines/play-solid-demo/variables/About.md +9 -0
  270. package/examples/@xmachines/play-solid-demo/variables/Contact.md +9 -0
  271. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +9 -0
  272. package/examples/@xmachines/play-solid-demo/variables/Home.md +9 -0
  273. package/examples/@xmachines/play-solid-demo/variables/Login.md +9 -0
  274. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +9 -0
  275. package/examples/@xmachines/play-solid-demo/variables/Overview.md +9 -0
  276. package/examples/@xmachines/play-solid-demo/variables/Profile.md +9 -0
  277. package/examples/@xmachines/play-solid-demo/variables/Settings.md +9 -0
  278. package/examples/@xmachines/play-solid-demo/variables/Stats.md +9 -0
  279. package/{api → examples}/@xmachines/play-solid-router-demo/README.md +13 -13
  280. package/examples/@xmachines/play-svelte-demo/README.md +127 -0
  281. package/{api → examples}/@xmachines/play-svelte-spa-router-demo/README.md +12 -13
  282. package/{api → examples}/@xmachines/play-sveltekit-router-demo/README.md +12 -13
  283. package/{api → examples}/@xmachines/play-tanstack-react-router-demo/README.md +13 -13
  284. package/{api → examples}/@xmachines/play-tanstack-solid-router-demo/README.md +14 -14
  285. package/examples/@xmachines/play-vue-demo/README.md +145 -0
  286. package/{api → examples}/@xmachines/play-vue-router-demo/README.md +12 -12
  287. package/examples/README.md +51 -27
  288. package/package.json +6 -4
package/api/llms.txt CHANGED
@@ -32,15 +32,15 @@
32
32
  - [@xmachines/play-xstate](@xmachines/play-xstate/README.md): XState-backed player and actor integration
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
- - [@xmachines/play-svelte](@xmachines/play-svelte/README.md): Svelte 5 renderer for Viewable actors
36
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
37
37
  - [@xmachines/play-react-router](@xmachines/play-react-router/README.md): React Router bridge and provider for actor-driven navigation
38
38
  - [@xmachines/play-tanstack-react-router](@xmachines/play-tanstack-react-router/README.md): TanStack React Router bridge and provider
39
39
  - [@xmachines/play-solid-router](@xmachines/play-solid-router/README.md): Solid Router bridge and provider
40
40
  - [@xmachines/play-tanstack-solid-router](@xmachines/play-tanstack-solid-router/README.md): TanStack Solid Router bridge and provider
41
- - [@xmachines/play-sveltekit-router](@xmachines/play-sveltekit-router/README.md): SvelteKit router adapter for actor-driven navigation
42
- - [@xmachines/play-svelte-spa-router](@xmachines/play-svelte-spa-router/README.md): Svelte SPA (hash) router adapter for actor-driven navigation
43
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
44
44
  - [@xmachines/shared](@xmachines/shared/README.md): Shared TypeScript, oxlint, and formatting configuration
45
45
 
46
46
  ## Notes For LLMs
@@ -59,21 +59,14 @@ import { extractMachineRoutes } from '@xmachines/play-router';
59
59
  import { defineRegistry } from '@json-render/react';
60
60
  import { PlayRenderer } from '@xmachines/play-react';
61
61
 
62
- // Define a player from a machine
63
62
  const createPlayer = definePlayer({ machine });
64
63
  const actor = createPlayer();
65
64
  actor.start();
66
65
 
67
- // `Viewable` actors expose renderable view metadata
68
- const currentView = actor.currentView.get(); // { component, spec }
69
-
70
- // `Routable` actors expose route state for adapters to observe
66
+ const currentView = actor.currentView.get();
71
67
  const currentRoute = actor.currentRoute.get();
72
-
73
- // Extract route metadata for a framework adapter
74
68
  const routeTree = extractMachineRoutes(machine);
75
69
 
76
- // Wire components to catalog and render
77
70
  const { registry } = defineRegistry(catalog, { components, actions });
78
71
  <PlayRenderer actor={actor} registry={registry} actions={{ login: 'auth.login' }} />
79
72
  ```
@@ -0,0 +1,155 @@
1
+ [Documentation](../../README.md) / @xmachines/play-actor-shared
2
+
3
+ # play-actor Shared Demo Package
4
+
5
+ Shared auth machine, catalog, and browser test fixtures consumed by all `@xmachines` renderer and router adapter demos.
6
+
7
+ ## What This Demonstrates
8
+
9
+ - A single `authMachine` reused across every framework demo without modification
10
+ - Framework-agnostic `authCatalog` defining typed component prop shapes and action param schemas
11
+ - Shared browser test suite (`renderer-demo-browser-suite.ts`) importable by any renderer demo
12
+ - State machine invariants: public routes, protected routes with auth guards, and nested sub-states
13
+
14
+ ## Running the Demo
15
+
16
+ This is a shared fixture package — it has no standalone dev server. Run its tests from the repository root:
17
+
18
+ ```bash
19
+ npm install
20
+ npm run test -w @xmachines/play-actor-shared
21
+ ```
22
+
23
+ ## Step-by-Step Code Flow
24
+
25
+ Use this order to understand the package structure:
26
+
27
+ 1. `src/auth-machine.ts` defines the `authMachine` using XState `setup()` with `formatPlayRouteTransitions` — all states include `meta.route` and `meta.view` for router and renderer integration.
28
+ 2. `src/catalog.ts` defines `authCatalog` using `defineCatalog` from `@json-render/core` — typed component prop schemas (via Zod) and action param schemas for `login`, `logout`, and all `route*` actions.
29
+ 3. `src/index.ts` re-exports `authMachine`, `authCatalog`, and all associated TypeScript types (`AuthActor`, `AuthContext`, `AuthEvents`, `AuthSnapshot`, `AuthCatalog`).
30
+ 4. `test/shared-package.test.ts` verifies machine invariants: starts at home, unauthenticated; `auth.login` transitions to `dashboard.overview`; `auth.logout` returns to `home`.
31
+ 5. `test/renderer-demo-browser-suite.ts` exports `defineNoRouterDemoBrowserSuite` — a portable browser test helper used by renderer demos that mount `<App />` and assert DOM state.
32
+
33
+ ```ts
34
+ // src/auth-machine.ts (shape)
35
+ export const authMachine = authSetup.createMachine(
36
+ formatPlayRouteTransitions({
37
+ id: "auth",
38
+ initial: "home",
39
+ on: {
40
+ "auth.login": { target: ".dashboard", guard: ({ context }) => !context.isAuthenticated },
41
+ "auth.logout": { target: ".home", guard: ({ context }) => context.isAuthenticated },
42
+ },
43
+ states: {
44
+ home: { meta: { route: "/", view: { component: "Home", spec: { ... } } } },
45
+ login: { meta: { route: "/login", view: { component: "Login", spec: { ... } } } },
46
+ dashboard: {
47
+ meta: { route: "/dashboard" },
48
+ initial: "overview",
49
+ always: { guard: ({ context }) => !context.isAuthenticated, target: "login" },
50
+ states: {
51
+ overview: { meta: { route: "overview", view: { component: "Overview", spec: { ... } } } },
52
+ stats: { meta: { route: "stats", view: { component: "Stats", spec: { ... } } } },
53
+ },
54
+ },
55
+ profile: { meta: { route: "/profile/:username", view: { component: "Profile", spec: { ... } } } },
56
+ settings: { meta: { route: "/settings/:section?", view: { component: "Settings", spec: { ... } } } },
57
+ },
58
+ }),
59
+ );
60
+ ```
61
+
62
+ ```ts
63
+ // src/catalog.ts (shape)
64
+ export const authCatalog = defineCatalog(schema, {
65
+ components: {
66
+ Home: { props: z.object({ title: z.string() }) },
67
+ Login: { props: z.object({ title: z.string() }) },
68
+ Dashboard: { props: z.object({ welcome: z.boolean(), username: z.string() }) },
69
+ Profile: { props: z.object({ username: z.string() }) },
70
+ // ... more components
71
+ },
72
+ actions: {
73
+ login: { params: z.object({ username: z.string() }), description: "Login with username" },
74
+ logout: { description: "Logout and return to home" },
75
+ // ... more actions
76
+ },
77
+ });
78
+ ```
79
+
80
+ ## Key Files
81
+
82
+ - `src/auth-machine.ts` - XState auth machine with route metadata, guards, and nested dashboard states
83
+ - `src/catalog.ts` - `authCatalog` with typed component and action schemas
84
+ - `src/index.ts` - public re-exports: `authMachine`, `authCatalog`, all types
85
+ - `src/index.css` - shared demo stylesheet imported by all renderer demos
86
+ - `test/shared-package.test.ts` - machine invariant tests (start state, login, logout)
87
+ - `test/renderer-demo-browser-suite.ts` - portable browser test helper for renderer demos
88
+
89
+ ## State Machine & Architecture Details
90
+
91
+ The auth machine embodies XMachines architectural invariants:
92
+
93
+ 1. **Actor Authority:** All navigation uses `play.route` events — the machine evaluates each route transition against its current state and guard conditions. Framework adapters never bypass this.
94
+ 2. **Passive Infrastructure:** `meta.route` on each state is metadata for the router adapter to read, not a command. The actor drives the URL, not the other way around.
95
+ 3. **Signal-Only Reactivity:** The machine exposes `actor.currentView` and `actor.currentRoute` as TC39 Signals. Framework renderers and router adapters observe these signals — they never poll or subscribe to snapshots directly.
96
+
97
+ ## Watcher Lifecycle and Cleanup Contract
98
+
99
+ The shared machine itself does not manage watchers — that responsibility belongs to each framework adapter. However, the machine's signal-based architecture requires adapters to follow the canonical lifecycle:
100
+
101
+ 1. `notify`
102
+ 2. `queueMicrotask`
103
+ 3. `getPending()`
104
+ 4. Read actor signals and project framework-local state
105
+ 5. Re-arm with `watch()`/`watch(...signals)`
106
+
107
+ The `test/renderer-demo-browser-suite.ts` exports `defineNoRouterDemoBrowserSuite`, which each renderer demo uses to assert startup rendering and debug panel state without coupling to framework internals.
108
+
109
+ ## Adapter Boundaries
110
+
111
+ This package is pure shared infrastructure: no framework imports, no DOM dependencies. It defines the contract (machine + catalog) that all framework adapters implement against. The `AuthActor` type exported here is the preferred import for components across all framework demos — it decouples component implementations from the concrete machine type.
112
+
113
+ ## Available Scripts
114
+
115
+ These commands are defined in `package.json`:
116
+
117
+ | Command | Description |
118
+ | ------------------------------------------------------ | -------------------------------- |
119
+ | `npm run test -w @xmachines/play-actor-shared` | Run Vitest test suite |
120
+ | `npm run test:browser -w @xmachines/play-actor-shared` | Run browser-focused Vitest suite |
121
+ | `npm run build -w @xmachines/play-actor-shared` | Build TypeScript declarations |
122
+
123
+ ## Verification
124
+
125
+ Use these checks to validate the shared package invariants:
126
+
127
+ ```bash
128
+ npm run test -w @xmachines/play-actor-shared
129
+ ```
130
+
131
+ Expected result: machine exports, start state, login, and logout invariants all pass.
132
+
133
+ ## Learn More
134
+
135
+ - [play-actor package README](../../README.md)
136
+
137
+ ## Interfaces
138
+
139
+ - [AuthContext](interfaces/AuthContext.md)
140
+
141
+ ## Type Aliases
142
+
143
+ - [AuthActor](type-aliases/AuthActor.md)
144
+ - [AuthCatalog](type-aliases/AuthCatalog.md)
145
+ - [AuthEvents](type-aliases/AuthEvents.md)
146
+ - [AuthInput](type-aliases/AuthInput.md)
147
+ - [AuthSnapshot](type-aliases/AuthSnapshot.md)
148
+ - [CatalogProps](type-aliases/CatalogProps.md)
149
+ - [InferProps](type-aliases/InferProps.md)
150
+
151
+ ## Variables
152
+
153
+ - [authCatalog](variables/authCatalog.md)
154
+ - [authMachine](variables/authMachine.md)
155
+ - [authSetup](variables/authSetup.md)
@@ -0,0 +1,14 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / AuthContext
2
+
3
+ # Interface: AuthContext
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.29/packages/play-actor/examples/shared/src/auth-machine.ts#L27)
6
+
7
+ ## Properties
8
+
9
+ | Property | Type | Defined in |
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.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) |
@@ -0,0 +1,27 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / AuthActor
2
+
3
+ # Type Alias: AuthActor
4
+
5
+ ```ts
6
+ type AuthActor = PlayerActor<typeof authMachine>;
7
+ ```
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.29/packages/play-actor/examples/shared/src/auth-machine.ts#L293)
10
+
11
+ The actor type for the auth machine.
12
+
13
+ Import this in components and router adapters instead of `typeof authMachine`.
14
+ Components declare their dependency on the capability contract (AuthContext +
15
+ AuthEvents + routing/view signals) without coupling to the concrete machine
16
+ implementation.
17
+
18
+ ## Example
19
+
20
+ ```ts
21
+ import type { AuthActor } from "@xmachines/play-actor-shared";
22
+
23
+ function HeaderNav({ actor }: { actor: AuthActor }) {
24
+ const snap = actor.getSnapshot();
25
+ snap.context.username; // typed as string | null — no cast needed
26
+ }
27
+ ```
@@ -0,0 +1,16 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / AuthCatalog
2
+
3
+ # Type Alias: AuthCatalog
4
+
5
+ ```ts
6
+ type AuthCatalog = typeof authCatalog;
7
+ ```
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.29/packages/play-actor/examples/shared/src/catalog.ts#L69)
10
+
11
+ The type of the auth catalog — use as the `C` type param in `ComponentFn<AuthCatalog, "X">`,
12
+ `ComponentContext<AuthCatalog, "X">`, and `defineRegistry(authCatalog, ...)`.
13
+
14
+ Prefer this over `typeof authCatalog` at every call site: it's more readable,
15
+ follows the PascalCase convention for types, and insulates components from
16
+ the catalog's runtime representation.
@@ -0,0 +1,17 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / AuthEvents
2
+
3
+ # Type Alias: AuthEvents
4
+
5
+ ```ts
6
+ type AuthEvents =
7
+ | PlayRouteEvent
8
+ | {
9
+ type: "auth.login";
10
+ username: string;
11
+ }
12
+ | {
13
+ type: "auth.logout";
14
+ };
15
+ ```
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.29/packages/play-actor/examples/shared/src/auth-machine.ts#L36)
@@ -0,0 +1,9 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / AuthInput
2
+
3
+ # Type Alias: AuthInput
4
+
5
+ ```ts
6
+ type AuthInput = Partial<AuthContext> | undefined;
7
+ ```
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.29/packages/play-actor/examples/shared/src/auth-machine.ts#L34)
@@ -0,0 +1,11 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / AuthSnapshot
2
+
3
+ # Type Alias: AuthSnapshot
4
+
5
+ ```ts
6
+ type AuthSnapshot = SnapshotFrom<typeof authMachine>;
7
+ ```
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.29/packages/play-actor/examples/shared/src/auth-machine.ts#L273)
10
+
11
+ Snapshot type for the auth machine — use for typed `matches()` calls.
@@ -0,0 +1,187 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / CatalogProps
2
+
3
+ # Type Alias: CatalogProps
4
+
5
+ ```ts
6
+ type CatalogProps = object;
7
+ ```
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.29/packages/play-actor/examples/shared/src/catalog.ts#L48)
10
+
11
+ ## Properties
12
+
13
+ ### About
14
+
15
+ ```ts
16
+ About: object;
17
+ ```
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.29/packages/play-actor/examples/shared/src/catalog.ts#L50)
20
+
21
+ #### title
22
+
23
+ ```ts
24
+ title: string;
25
+ ```
26
+
27
+ ---
28
+
29
+ ### Contact
30
+
31
+ ```ts
32
+ Contact: object;
33
+ ```
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.29/packages/play-actor/examples/shared/src/catalog.ts#L51)
36
+
37
+ #### title
38
+
39
+ ```ts
40
+ title: string;
41
+ ```
42
+
43
+ ---
44
+
45
+ ### Dashboard
46
+
47
+ ```ts
48
+ Dashboard: object;
49
+ ```
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.29/packages/play-actor/examples/shared/src/catalog.ts#L53)
52
+
53
+ #### username
54
+
55
+ ```ts
56
+ username: string;
57
+ ```
58
+
59
+ #### welcome
60
+
61
+ ```ts
62
+ welcome: boolean;
63
+ ```
64
+
65
+ ---
66
+
67
+ ### Home
68
+
69
+ ```ts
70
+ Home: object;
71
+ ```
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.29/packages/play-actor/examples/shared/src/catalog.ts#L49)
74
+
75
+ #### title
76
+
77
+ ```ts
78
+ title: string;
79
+ ```
80
+
81
+ ---
82
+
83
+ ### Login
84
+
85
+ ```ts
86
+ Login: object;
87
+ ```
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.29/packages/play-actor/examples/shared/src/catalog.ts#L52)
90
+
91
+ #### title
92
+
93
+ ```ts
94
+ title: string;
95
+ ```
96
+
97
+ ---
98
+
99
+ ### Navigation
100
+
101
+ ```ts
102
+ Navigation: object;
103
+ ```
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.29/packages/play-actor/examples/shared/src/catalog.ts#L56)
106
+
107
+ #### currentPath
108
+
109
+ ```ts
110
+ currentPath: string;
111
+ ```
112
+
113
+ #### isAuthenticated
114
+
115
+ ```ts
116
+ isAuthenticated: boolean;
117
+ ```
118
+
119
+ ---
120
+
121
+ ### Overview
122
+
123
+ ```ts
124
+ Overview: object;
125
+ ```
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.29/packages/play-actor/examples/shared/src/catalog.ts#L57)
128
+
129
+ #### title
130
+
131
+ ```ts
132
+ title: string;
133
+ ```
134
+
135
+ ---
136
+
137
+ ### Profile
138
+
139
+ ```ts
140
+ Profile: object;
141
+ ```
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.29/packages/play-actor/examples/shared/src/catalog.ts#L54)
144
+
145
+ #### username
146
+
147
+ ```ts
148
+ username: string;
149
+ ```
150
+
151
+ ---
152
+
153
+ ### Settings
154
+
155
+ ```ts
156
+ Settings: object;
157
+ ```
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.29/packages/play-actor/examples/shared/src/catalog.ts#L55)
160
+
161
+ #### section?
162
+
163
+ ```ts
164
+ optional section?: string;
165
+ ```
166
+
167
+ #### username
168
+
169
+ ```ts
170
+ username: string;
171
+ ```
172
+
173
+ ---
174
+
175
+ ### Stats
176
+
177
+ ```ts
178
+ Stats: object;
179
+ ```
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.29/packages/play-actor/examples/shared/src/catalog.ts#L58)
182
+
183
+ #### title
184
+
185
+ ```ts
186
+ title: string;
187
+ ```
@@ -0,0 +1,17 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / InferProps
2
+
3
+ # Type Alias: InferProps\<K\>
4
+
5
+ ```ts
6
+ type InferProps<K> = CatalogProps[K];
7
+ ```
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.29/packages/play-actor/examples/shared/src/catalog.ts#L74)
10
+
11
+ Infer props for a named component from the catalog type
12
+
13
+ ## Type Parameters
14
+
15
+ | Type Parameter |
16
+ | ----------------------------------------------------- |
17
+ | `K` _extends_ keyof [`CatalogProps`](CatalogProps.md) |
@@ -0,0 +1,173 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / authCatalog
2
+
3
+ # Variable: authCatalog
4
+
5
+ ```ts
6
+ const authCatalog: Catalog<
7
+ {
8
+ catalog: SchemaType<
9
+ "object",
10
+ {
11
+ actions: SchemaType<
12
+ "map",
13
+ {
14
+ description: SchemaType<"string", unknown>;
15
+ params: SchemaType<"zod", unknown>;
16
+ }
17
+ >;
18
+ components: SchemaType<
19
+ "map",
20
+ {
21
+ description: SchemaType<"string", unknown>;
22
+ example: SchemaType<"any", unknown>;
23
+ props: SchemaType<"zod", unknown>;
24
+ slots: SchemaType<"array", SchemaType<"string", unknown>>;
25
+ }
26
+ >;
27
+ }
28
+ >;
29
+ spec: SchemaType<
30
+ "object",
31
+ {
32
+ elements: SchemaType<
33
+ "record",
34
+ SchemaType<
35
+ "object",
36
+ {
37
+ children: SchemaType<"array", SchemaType<"string", unknown>>;
38
+ props: SchemaType<"propsOf", string>;
39
+ type: SchemaType<"ref", string>;
40
+ visible: SchemaType<"any", unknown>;
41
+ }
42
+ >
43
+ >;
44
+ root: SchemaType<"string", unknown>;
45
+ }
46
+ >;
47
+ },
48
+ {
49
+ actions: {
50
+ login: {
51
+ description: string;
52
+ params: ZodObject<
53
+ {
54
+ username: ZodString;
55
+ },
56
+ $strip
57
+ >;
58
+ };
59
+ logout: {
60
+ description: string;
61
+ };
62
+ routeDashboard: {
63
+ description: string;
64
+ };
65
+ routeHome: {
66
+ description: string;
67
+ };
68
+ routeLogin: {
69
+ description: string;
70
+ };
71
+ routeOverview: {
72
+ description: string;
73
+ };
74
+ routeProfile: {
75
+ description: string;
76
+ };
77
+ routeSettings: {
78
+ description: string;
79
+ };
80
+ routeStats: {
81
+ description: string;
82
+ };
83
+ };
84
+ components: {
85
+ About: {
86
+ props: ZodObject<
87
+ {
88
+ title: ZodString;
89
+ },
90
+ $strip
91
+ >;
92
+ };
93
+ Contact: {
94
+ props: ZodObject<
95
+ {
96
+ title: ZodString;
97
+ },
98
+ $strip
99
+ >;
100
+ };
101
+ Dashboard: {
102
+ props: ZodObject<
103
+ {
104
+ username: ZodString;
105
+ welcome: ZodBoolean;
106
+ },
107
+ $strip
108
+ >;
109
+ };
110
+ Home: {
111
+ props: ZodObject<
112
+ {
113
+ title: ZodString;
114
+ },
115
+ $strip
116
+ >;
117
+ };
118
+ Login: {
119
+ props: ZodObject<
120
+ {
121
+ title: ZodString;
122
+ },
123
+ $strip
124
+ >;
125
+ };
126
+ Navigation: {
127
+ props: ZodObject<
128
+ {
129
+ currentPath: ZodString;
130
+ isAuthenticated: ZodBoolean;
131
+ },
132
+ $strip
133
+ >;
134
+ };
135
+ Overview: {
136
+ props: ZodObject<
137
+ {
138
+ title: ZodString;
139
+ },
140
+ $strip
141
+ >;
142
+ };
143
+ Profile: {
144
+ props: ZodObject<
145
+ {
146
+ username: ZodString;
147
+ },
148
+ $strip
149
+ >;
150
+ };
151
+ Settings: {
152
+ props: ZodObject<
153
+ {
154
+ section: ZodOptional<ZodString>;
155
+ username: ZodString;
156
+ },
157
+ $strip
158
+ >;
159
+ };
160
+ Stats: {
161
+ props: ZodObject<
162
+ {
163
+ title: ZodString;
164
+ },
165
+ $strip
166
+ >;
167
+ };
168
+ };
169
+ }
170
+ >;
171
+ ```
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.29/packages/play-actor/examples/shared/src/catalog.ts#L14)