@xmachines/docs 1.0.0-beta.34 → 1.0.0-beta.35

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 (321) hide show
  1. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  2. package/api/@xmachines/play/classes/PlayError.md +4 -4
  3. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  4. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  5. package/api/@xmachines/play-actor/README.md +9 -9
  6. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  7. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  8. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  9. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  10. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  11. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  13. package/api/@xmachines/play-dom/README.md +4 -3
  14. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  15. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  16. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  17. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  18. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -23
  19. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  20. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  21. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +13 -13
  22. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +8 -8
  23. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  24. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +12 -12
  25. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  26. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  27. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +5 -5
  28. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +5 -5
  29. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  31. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  32. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  36. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  41. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  42. package/api/@xmachines/play-dom-router/README.md +3 -3
  43. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  44. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  45. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +3 -3
  46. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  47. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  48. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  49. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  50. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  51. package/api/@xmachines/play-dom-router/interfaces/{RouteMapLike.md → RouteLookupContract.md} +7 -7
  52. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +6 -11
  53. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +8 -8
  54. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  55. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  56. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  57. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  58. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  59. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  60. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  61. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  62. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  63. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  64. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  65. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  66. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  67. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  68. package/api/@xmachines/play-react/variables/PlayRenderer.md +2 -2
  69. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  70. package/api/@xmachines/play-react-router/README.md +1 -0
  71. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +24 -24
  72. package/api/@xmachines/play-react-router/classes/RouteMap.md +38 -22
  73. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  74. package/api/@xmachines/play-react-router/functions/createRouteMap.md +21 -0
  75. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +5 -5
  76. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  77. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  78. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +8 -8
  79. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  80. package/api/@xmachines/play-router/README.md +6 -6
  81. package/api/@xmachines/play-router/classes/{BaseRouteMap.md → RouteMap.md} +11 -11
  82. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +24 -24
  83. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +2 -2
  84. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  85. package/api/@xmachines/play-router/functions/createRouteMap.md +6 -6
  86. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +5 -5
  87. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +6 -6
  88. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  89. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  90. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  91. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  92. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  93. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  94. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  95. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  96. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  97. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  98. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  99. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  100. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  101. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  102. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  103. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  104. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  105. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  106. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  107. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  108. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  109. package/api/@xmachines/play-router/interfaces/RouteMapping.md +8 -8
  110. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  111. package/api/@xmachines/play-router/interfaces/{RouteMap.md → RouteMatcher.md} +13 -13
  112. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  113. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  114. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  115. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  116. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  117. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  118. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  119. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  120. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  121. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  122. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  123. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  124. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  125. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  126. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  127. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  128. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  129. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  130. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  131. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  132. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  133. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  134. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  135. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  136. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  137. package/api/@xmachines/play-solid-router/README.md +2 -2
  138. package/api/@xmachines/play-solid-router/classes/RouteMap.md +9 -9
  139. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +25 -25
  140. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  141. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +3 -3
  142. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  143. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  144. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  145. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +8 -8
  146. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  147. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  148. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  149. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  150. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  151. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  152. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  153. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  154. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  155. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  156. package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +1 -1
  157. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +9 -9
  158. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  159. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +3 -3
  160. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  161. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  162. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +8 -8
  163. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  164. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  165. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  166. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +9 -9
  167. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  168. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +3 -3
  169. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  170. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  171. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  172. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +8 -8
  173. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  174. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  175. package/api/@xmachines/play-tanstack-react-router/README.md +1 -1
  176. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +38 -22
  177. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +24 -24
  178. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  179. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +7 -39
  180. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +5 -5
  181. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  182. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  183. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  184. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +8 -8
  185. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  186. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  187. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  188. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  189. package/api/@xmachines/play-tanstack-solid-router/README.md +1 -1
  190. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +9 -9
  191. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +25 -25
  192. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  193. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +3 -3
  194. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  195. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  196. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +8 -8
  197. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  198. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  199. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  200. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  201. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  202. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  203. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  204. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  205. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  206. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  207. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  208. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  209. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  210. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  211. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  212. package/api/@xmachines/play-vue-router/README.md +9 -4
  213. package/api/@xmachines/play-vue-router/classes/RouteMap.md +38 -20
  214. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +25 -25
  215. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  216. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  217. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +8 -8
  218. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  219. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  220. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  221. package/api/@xmachines/play-xstate/README.md +1 -1
  222. package/api/@xmachines/play-xstate/classes/PlayerActor.md +14 -14
  223. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  224. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  225. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  226. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  227. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  228. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  229. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  230. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  231. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  232. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  233. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  234. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  235. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  236. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  237. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  238. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  239. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  240. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  241. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  242. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  243. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  244. package/api/@xmachines/shared/README.md +47 -47
  245. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  246. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  247. package/api/llms.txt +4 -2
  248. package/examples/@xmachines/play-dom-demo/README.md +2 -2
  249. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +4 -3
  250. package/examples/@xmachines/play-dom-demo/functions/initShell.md +5 -1
  251. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  252. package/examples/@xmachines/play-dom-demo/variables/About.md +4 -1
  253. package/examples/@xmachines/play-dom-demo/variables/Contact.md +4 -1
  254. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +5 -1
  255. package/examples/@xmachines/play-dom-demo/variables/Home.md +5 -1
  256. package/examples/@xmachines/play-dom-demo/variables/Login.md +5 -1
  257. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +8 -1
  258. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +5 -1
  259. package/examples/@xmachines/play-dom-demo/variables/Overview.md +5 -1
  260. package/examples/@xmachines/play-dom-demo/variables/Profile.md +5 -1
  261. package/examples/@xmachines/play-dom-demo/variables/Settings.md +5 -1
  262. package/examples/@xmachines/play-dom-demo/variables/Stats.md +5 -1
  263. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  264. package/examples/@xmachines/play-dom-router-demo/README.md +26 -22
  265. package/examples/@xmachines/play-react-demo/README.md +2 -2
  266. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  267. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  268. package/examples/@xmachines/play-react-demo/variables/About.md +6 -1
  269. package/examples/@xmachines/play-react-demo/variables/Contact.md +6 -1
  270. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +7 -1
  271. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +5 -1
  272. package/examples/@xmachines/play-react-demo/variables/Home.md +6 -1
  273. package/examples/@xmachines/play-react-demo/variables/Login.md +8 -1
  274. package/examples/@xmachines/play-react-demo/variables/NavBar.md +6 -1
  275. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +7 -1
  276. package/examples/@xmachines/play-react-demo/variables/Navigation.md +6 -1
  277. package/examples/@xmachines/play-react-demo/variables/Overview.md +6 -1
  278. package/examples/@xmachines/play-react-demo/variables/Profile.md +6 -1
  279. package/examples/@xmachines/play-react-demo/variables/Settings.md +6 -1
  280. package/examples/@xmachines/play-react-demo/variables/Shell.md +6 -1
  281. package/examples/@xmachines/play-react-demo/variables/Stats.md +6 -1
  282. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  283. package/examples/@xmachines/play-react-router-demo/README.md +5 -3
  284. package/examples/@xmachines/play-solid-demo/README.md +2 -2
  285. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  286. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  287. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  288. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  289. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  290. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +5 -1
  291. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  292. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  293. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  294. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +6 -3
  295. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  296. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  297. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  298. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  299. package/examples/@xmachines/play-solid-demo/variables/Shell.md +5 -1
  300. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  301. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  302. package/examples/@xmachines/play-solid-router-demo/README.md +6 -4
  303. package/examples/@xmachines/play-svelte-demo/README.md +11 -1
  304. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +9 -0
  305. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +9 -0
  306. package/examples/@xmachines/play-svelte-demo/variables/App.md +9 -0
  307. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +172 -0
  308. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +2 -2
  309. package/examples/@xmachines/play-sveltekit-router-demo/README.md +2 -2
  310. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +3 -3
  311. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +4 -4
  312. package/examples/@xmachines/play-vue-demo/README.md +11 -2
  313. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +9 -0
  314. package/examples/@xmachines/play-vue-demo/variables/App.md +9 -0
  315. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +172 -0
  316. package/examples/@xmachines/play-vue-router-demo/README.md +21 -24
  317. package/examples/README.md +2 -0
  318. package/package.json +2 -2
  319. package/rfc/play.md +19 -19
  320. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +0 -141
  321. package/api/_media/README.md +0 -404
@@ -6,4 +6,9 @@
6
6
  const Profile: ComponentFn<AuthCatalog, "Profile">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/examples/demo/src/components/Profile.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/examples/demo/src/components/Profile.tsx#L14)
9
+ Defined in: [packages/play-react/examples/demo/src/components/Profile.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/examples/demo/src/components/Profile.tsx#L11)
10
+
11
+ Profile — Protected user profile page
12
+
13
+ Uses ComponentFn<AuthCatalog, "Profile"> for catalog-typed props.
14
+ Navigation is handled by HeaderNav — this component only renders content.
@@ -6,4 +6,9 @@
6
6
  const Settings: ComponentFn<AuthCatalog, "Settings">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/examples/demo/src/components/Settings.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/examples/demo/src/components/Settings.tsx#L14)
9
+ Defined in: [packages/play-react/examples/demo/src/components/Settings.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/examples/demo/src/components/Settings.tsx#L11)
10
+
11
+ Settings — Protected settings page
12
+
13
+ Uses ComponentFn<AuthCatalog, "Settings"> for catalog-typed props.
14
+ Navigation is handled by HeaderNav — this component only renders content.
@@ -10,4 +10,9 @@ const Shell: FC<{
10
10
  }>;
11
11
  ```
12
12
 
13
- Defined in: [packages/play-react/examples/demo/src/components/Shell.tsx:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/examples/demo/src/components/Shell.tsx#L15)
13
+ Defined in: [packages/play-react/examples/demo/src/components/Shell.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/examples/demo/src/components/Shell.tsx#L14)
14
+
15
+ Demo Shell layout component.
16
+
17
+ Wraps NavBar, PlayRenderer, and DebugPanel in the standard demo chrome.
18
+ Router-agnostic — all navigation is driven via play.route events on the actor.
@@ -6,4 +6,9 @@
6
6
  const Stats: ComponentFn<AuthCatalog, "Stats">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/examples/demo/src/components/Stats.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/examples/demo/src/components/Stats.tsx#L11)
9
+ Defined in: [packages/play-react/examples/demo/src/components/Stats.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/examples/demo/src/components/Stats.tsx#L10)
10
+
11
+ Stats - Dashboard stats child route component
12
+
13
+ Uses ComponentFn<AuthCatalog, "Stats"> for catalog-typed props.
14
+ Relative route "stats" resolves to /dashboard/stats.
@@ -169,4 +169,4 @@ const authCatalog: Catalog<
169
169
  >;
170
170
  ```
171
171
 
172
- Defined in: [packages/play-react/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/examples/demo/src/catalog.ts#L5)
172
+ Defined in: [packages/play-react/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/examples/demo/src/catalog.ts#L5)
@@ -79,7 +79,9 @@ return (
79
79
  // src/components/Login.tsx (shape)
80
80
  export function Login() {
81
81
  return (
82
- <button onClick={() => actor.send({ type: "auth.login", username, password })}>Login</button>
82
+ <button onClick={() => actor.send({ type: "auth.login", username, password })}>
83
+ Login
84
+ </button>
83
85
  );
84
86
  }
85
87
  ```
@@ -141,5 +143,5 @@ Expected result: tests pass for startup and auth-flow browser scenarios.
141
143
 
142
144
  ## Learn More
143
145
 
144
- - [React Router package README](../../README.md)
145
- - [React package README](../../../play-react/README.md)
146
+ - [React Router](../../README.md)
147
+ - [React](../../../play-react)
@@ -154,8 +154,8 @@ Expected result: library-pattern invariant tests pass and the browser renderer s
154
154
 
155
155
  ## Learn More
156
156
 
157
- - [SolidJS package README](../../README.md)
158
- - [Solid Router demo README](../../../play-solid-router/examples/demo/README.md)
157
+ - [SolidJS](../../README.md)
158
+ - [Solid Router](../../../play-solid-router/examples/demo)
159
159
 
160
160
  ## Type Aliases
161
161
 
@@ -6,7 +6,7 @@
6
6
  function App(): Element;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/App.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/App.tsx#L34)
9
+ Defined in: [packages/play-solid/examples/demo/src/App.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/App.tsx#L34)
10
10
 
11
11
  ## Returns
12
12
 
@@ -6,4 +6,4 @@
6
6
  type AuthCatalog = typeof authCatalog;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/catalog.ts#L6)
9
+ Defined in: [packages/play-solid/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/catalog.ts#L6)
@@ -6,4 +6,4 @@
6
6
  const About: ComponentFn<AuthCatalog, "About">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/About.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/components/About.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/About.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/components/About.tsx#L9)
@@ -6,4 +6,4 @@
6
6
  const Contact: ComponentFn<AuthCatalog, "Contact">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Contact.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/components/Contact.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Contact.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/components/Contact.tsx#L9)
@@ -6,4 +6,4 @@
6
6
  const Dashboard: ComponentFn<AuthCatalog, "Dashboard">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Dashboard.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/components/Dashboard.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Dashboard.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/components/Dashboard.tsx#L9)
@@ -8,4 +8,8 @@ const DebugPanel: Component<{
8
8
  }>;
9
9
  ```
10
10
 
11
- Defined in: [packages/play-solid/examples/demo/src/components/DebugPanel.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/components/DebugPanel.tsx#L5)
11
+ Defined in: [packages/play-solid/examples/demo/src/components/DebugPanel.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/components/DebugPanel.tsx#L10)
12
+
13
+ DebugPanel — Live debug footer.
14
+ Observes actor.state and actor.currentRoute via watchSignal;
15
+ cleans up via onCleanup.
@@ -6,4 +6,4 @@
6
6
  const Home: ComponentFn<AuthCatalog, "Home">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Home.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/components/Home.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Home.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/components/Home.tsx#L9)
@@ -6,4 +6,4 @@
6
6
  const Login: ComponentFn<AuthCatalog, "Login">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Login.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/components/Login.tsx#L7)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Login.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/components/Login.tsx#L12)
@@ -8,4 +8,4 @@ const NavBar: Component<{
8
8
  }>;
9
9
  ```
10
10
 
11
- Defined in: [packages/play-solid/examples/demo/src/components/NavBar.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/components/NavBar.tsx#L28)
11
+ Defined in: [packages/play-solid/examples/demo/src/components/NavBar.tsx:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/components/NavBar.tsx#L15)
@@ -6,7 +6,10 @@
6
6
  const NavBarView: ComponentFn<AuthCatalog, "NavBar">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/NavBar.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/components/NavBar.tsx#L20)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/NavBarView.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/components/NavBarView.tsx#L11)
10
10
 
11
- Catalog-typed NavBar component for use in defineRegistry components map.
12
- Receives props from spec (isAuthenticated, username) and renders a static nav.
11
+ NavBarView — Catalog-typed NavBar for use in defineRegistry components map.
12
+
13
+ Receives props from the spec (isAuthenticated, username) and renders a
14
+ static status indicator. Navigation buttons live in the shell-level NavBar
15
+ component which calls actor.send() directly.
@@ -6,4 +6,4 @@
6
6
  const Navigation: ComponentFn<AuthCatalog, "Navigation">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Navigation.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/components/Navigation.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Navigation.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/components/Navigation.tsx#L9)
@@ -6,4 +6,4 @@
6
6
  const Overview: ComponentFn<AuthCatalog, "Overview">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Overview.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/components/Overview.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Overview.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/components/Overview.tsx#L9)
@@ -6,4 +6,4 @@
6
6
  const Profile: ComponentFn<AuthCatalog, "Profile">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Profile.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/components/Profile.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Profile.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/components/Profile.tsx#L9)
@@ -6,4 +6,4 @@
6
6
  const Settings: ComponentFn<AuthCatalog, "Settings">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Settings.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/components/Settings.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Settings.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/components/Settings.tsx#L9)
@@ -10,4 +10,8 @@ const Shell: Component<{
10
10
  }>;
11
11
  ```
12
12
 
13
- Defined in: [packages/play-solid/examples/demo/src/components/Shell.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/components/Shell.tsx#L8)
13
+ Defined in: [packages/play-solid/examples/demo/src/components/Shell.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/components/Shell.tsx#L13)
14
+
15
+ Shell — Demo shell layout component.
16
+ Renders standard demo chrome (header + PlayUIProvider/PlayRenderer + DebugPanel).
17
+ Router-agnostic — navigation via play.route events.
@@ -6,4 +6,4 @@
6
6
  const Stats: ComponentFn<AuthCatalog, "Stats">;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/examples/demo/src/components/Stats.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/components/Stats.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Stats.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/components/Stats.tsx#L9)
@@ -169,4 +169,4 @@ const authCatalog: Catalog<
169
169
  >;
170
170
  ```
171
171
 
172
- Defined in: [packages/play-solid/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-solid/examples/demo/src/catalog.ts#L5)
172
+ Defined in: [packages/play-solid/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-solid/examples/demo/src/catalog.ts#L5)
@@ -51,7 +51,9 @@ const routeMap = createRouteMap(authMachine);
51
51
  actor={actor}
52
52
  routeMap={routeMap}
53
53
  router={{ navigate, location, params }}
54
- renderer={(currentActor, currentRouter) => <Shell actor={currentActor} router={currentRouter} />}
54
+ renderer={(currentActor, currentRouter) => (
55
+ <Shell actor={currentActor} router={currentRouter} />
56
+ )}
55
57
  />;
56
58
  ```
57
59
 
@@ -117,6 +119,6 @@ Expected result: library-pattern invariant tests and the browser shared-demo sui
117
119
 
118
120
  ## Learn More
119
121
 
120
- - [Solid Router package README](../../README.md)
121
- - [SolidJS package README](../../../play-solid/README.md)
122
- - [TanStack Solid Router demo README](../../../play-tanstack-solid-router/examples/demo/README.md)
122
+ - [Solid Router](../../README.md)
123
+ - [SolidJS](../../../play-solid)
124
+ - [TanStack Solid Router](../../../play-tanstack-solid-router/examples/demo)
@@ -127,4 +127,14 @@ Expected result: library-pattern invariant tests pass and the browser renderer s
127
127
 
128
128
  ## Learn More
129
129
 
130
- - [Svelte package README](../../README.md)
130
+ - [Svelte](../../README.md)
131
+
132
+ ## Type Aliases
133
+
134
+ - [App](type-aliases/App.md)
135
+ - [AuthCatalog](type-aliases/AuthCatalog.md)
136
+
137
+ ## Variables
138
+
139
+ - [App](variables/App.md)
140
+ - [authCatalog](variables/authCatalog.md)
@@ -0,0 +1,9 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte-demo](../README.md) / App
2
+
3
+ # Type Alias: App
4
+
5
+ ```ts
6
+ type App = SvelteComponent;
7
+ ```
8
+
9
+ Defined in: `svelte`
@@ -0,0 +1,9 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte-demo](../README.md) / AuthCatalog
2
+
3
+ # Type Alias: AuthCatalog
4
+
5
+ ```ts
6
+ type AuthCatalog = typeof authCatalog;
7
+ ```
8
+
9
+ Defined in: [packages/play-svelte/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-svelte/examples/demo/src/catalog.ts#L6)
@@ -0,0 +1,9 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte-demo](../README.md) / App
2
+
3
+ # Variable: App
4
+
5
+ ```ts
6
+ const App: LegacyComponentType;
7
+ ```
8
+
9
+ Defined in: `svelte`
@@ -0,0 +1,172 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte-demo](../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: "Login with username";
52
+ params: ZodObject<
53
+ {
54
+ username: ZodString;
55
+ },
56
+ $strip
57
+ >;
58
+ };
59
+ logout: {
60
+ description: "Logout and return to home";
61
+ };
62
+ route: {
63
+ description: "Navigate to a route by path (e.g. '#home', '#login', '#dashboard')";
64
+ params: ZodObject<
65
+ {
66
+ params: ZodOptional<ZodRecord<ZodString, ZodString>>;
67
+ to: ZodString;
68
+ },
69
+ $strip
70
+ >;
71
+ };
72
+ };
73
+ components: {
74
+ About: {
75
+ props: ZodObject<
76
+ {
77
+ title: ZodString;
78
+ },
79
+ $strip
80
+ >;
81
+ };
82
+ Contact: {
83
+ props: ZodObject<
84
+ {
85
+ title: ZodString;
86
+ },
87
+ $strip
88
+ >;
89
+ };
90
+ Dashboard: {
91
+ props: ZodObject<
92
+ {
93
+ username: ZodString;
94
+ welcome: ZodBoolean;
95
+ },
96
+ $strip
97
+ >;
98
+ };
99
+ Home: {
100
+ props: ZodObject<
101
+ {
102
+ title: ZodString;
103
+ },
104
+ $strip
105
+ >;
106
+ };
107
+ Login: {
108
+ props: ZodObject<
109
+ {
110
+ title: ZodString;
111
+ username: ZodOptional<ZodString>;
112
+ },
113
+ $strip
114
+ >;
115
+ };
116
+ NavBar: {
117
+ props: ZodObject<
118
+ {
119
+ isAuthenticated: ZodBoolean;
120
+ username: ZodNullable<ZodString>;
121
+ },
122
+ $strip
123
+ >;
124
+ };
125
+ Navigation: {
126
+ props: ZodObject<
127
+ {
128
+ currentPath: ZodString;
129
+ isAuthenticated: ZodBoolean;
130
+ },
131
+ $strip
132
+ >;
133
+ };
134
+ Overview: {
135
+ props: ZodObject<
136
+ {
137
+ title: ZodString;
138
+ },
139
+ $strip
140
+ >;
141
+ };
142
+ Profile: {
143
+ props: ZodObject<
144
+ {
145
+ username: ZodString;
146
+ },
147
+ $strip
148
+ >;
149
+ };
150
+ Settings: {
151
+ props: ZodObject<
152
+ {
153
+ section: ZodOptional<ZodString>;
154
+ username: ZodString;
155
+ },
156
+ $strip
157
+ >;
158
+ };
159
+ Stats: {
160
+ props: ZodObject<
161
+ {
162
+ title: ZodString;
163
+ },
164
+ $strip
165
+ >;
166
+ };
167
+ };
168
+ }
169
+ >;
170
+ ```
171
+
172
+ Defined in: [packages/play-svelte/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-svelte/examples/demo/src/catalog.ts#L5)
@@ -123,5 +123,5 @@ Expected result: library-pattern invariant tests pass and the browser demo suite
123
123
 
124
124
  ## Learn More
125
125
 
126
- - [Svelte SPA Router package README](../../README.md)
127
- - [Svelte package README](../../../play-svelte/README.md)
126
+ - [Svelte SPA Router](../../README.md)
127
+ - [Svelte](../../../play-svelte)
@@ -124,5 +124,5 @@ Expected result: library-pattern invariant tests pass and the browser demo suite
124
124
 
125
125
  ## Learn More
126
126
 
127
- - [SvelteKit Router package README](../../README.md)
128
- - [Svelte package README](../../../play-svelte/README.md)
127
+ - [SvelteKit Router](../../README.md)
128
+ - [Svelte](../../../play-svelte)
@@ -125,6 +125,6 @@ Expected result: invariant test suite and the browser shared-demo suite both pas
125
125
 
126
126
  ## Learn More
127
127
 
128
- - [TanStack React Router package README](../../README.md)
129
- - [React package README](../../../play-react/README.md)
130
- - [TanStack Solid Router demo README](../../../play-tanstack-solid-router/examples/demo/README.md)
128
+ - [TanStack React Router](../../README.md)
129
+ - [React](../../../play-react)
130
+ - [TanStack Solid Router](../../../play-tanstack-solid-router/examples/demo)
@@ -119,7 +119,7 @@ Expected result: library-pattern invariant tests and the browser shared-demo sui
119
119
 
120
120
  ## Learn More
121
121
 
122
- - [TanStack Solid Router package README](../../README.md)
123
- - [SolidJS package README](../../../play-solid/README.md)
124
- - [Solid Router demo README](../../../play-solid-router/examples/demo/README.md)
125
- - [TanStack React Router demo README](../../../play-tanstack-react-router/examples/demo/README.md)
122
+ - [TanStack Solid Router](../../README.md)
123
+ - [SolidJS](../../../play-solid)
124
+ - [Solid Router](../../../play-solid-router/examples/demo)
125
+ - [TanStack React Router](../../../play-tanstack-react-router/examples/demo)
@@ -159,5 +159,14 @@ Expected result: library-pattern invariant tests pass and the browser renderer s
159
159
 
160
160
  ## Learn More
161
161
 
162
- - [Vue package README](../../README.md)
163
- - [Vue Router demo README](../../../play-vue-router/examples/demo/README.md)
162
+ - [Vue](../../README.md)
163
+ - [Vue Router](../../../play-vue-router/examples/demo)
164
+
165
+ ## Type Aliases
166
+
167
+ - [AuthCatalog](type-aliases/AuthCatalog.md)
168
+
169
+ ## Variables
170
+
171
+ - [App](variables/App.md)
172
+ - [authCatalog](variables/authCatalog.md)
@@ -0,0 +1,9 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-vue-demo](../README.md) / AuthCatalog
2
+
3
+ # Type Alias: AuthCatalog
4
+
5
+ ```ts
6
+ type AuthCatalog = typeof authCatalog;
7
+ ```
8
+
9
+ Defined in: [packages/play-vue/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-vue/examples/demo/src/catalog.ts#L6)
@@ -0,0 +1,9 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-vue-demo](../README.md) / App
2
+
3
+ # Variable: App
4
+
5
+ ```ts
6
+ const App: DefineComponent<{}, {}, unknown>;
7
+ ```
8
+
9
+ Defined in: [packages/play-vue/examples/demo/src/env.d.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-vue/examples/demo/src/env.d.ts#L5)