@xmachines/docs 5.0.2 → 6.0.0

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 (543) hide show
  1. package/README.md +4 -1
  2. package/api/@xmachines/core/README.md +209 -0
  3. package/api/@xmachines/core/cache/README.md +17 -0
  4. package/api/@xmachines/core/cache/functions/createLruCache.md +52 -0
  5. package/api/@xmachines/core/cache/interfaces/KeyValueCache.md +61 -0
  6. package/api/@xmachines/core/errors/README.md +11 -0
  7. package/api/@xmachines/core/errors/classes/BaseError.md +226 -0
  8. package/api/@xmachines/core/errors/classes/DisposeConflictError.md +177 -0
  9. package/api/@xmachines/core/utils/README.md +33 -0
  10. package/api/@xmachines/core/utils/functions/asDisposable.md +139 -0
  11. package/api/@xmachines/core/utils/functions/createNullRecord.md +39 -0
  12. package/api/@xmachines/core/utils/functions/createWarnOnce.md +39 -0
  13. package/api/@xmachines/core/utils/functions/describeValue.md +39 -0
  14. package/api/@xmachines/core/utils/functions/isError.md +46 -0
  15. package/api/@xmachines/core/utils/functions/isThenable.md +43 -0
  16. package/api/@xmachines/core/utils/functions/releaseQuietly.md +37 -0
  17. package/api/@xmachines/core/utils/functions/rethrowLater.md +43 -0
  18. package/api/@xmachines/core/utils/functions/safeString.md +36 -0
  19. package/api/@xmachines/core/utils/functions/shallowEqualExcept.md +42 -0
  20. package/api/@xmachines/core/utils/type-aliases/DisposeKey.md +28 -0
  21. package/api/@xmachines/core/utils/type-aliases/DisposeMember.md +14 -0
  22. package/api/@xmachines/{play-router/index → core/utils}/variables/DISPOSE.md +9 -9
  23. package/api/@xmachines/play/README.md +18 -69
  24. package/api/@xmachines/play/errors/classes/NonNullableError.md +4 -4
  25. package/api/@xmachines/play/errors/classes/PlayError.md +30 -34
  26. package/api/@xmachines/play/index/README.md +0 -8
  27. package/api/@xmachines/play/index/functions/assertNonNullable.md +1 -1
  28. package/api/@xmachines/play/index/type-aliases/PlayEvent.md +2 -2
  29. package/api/@xmachines/play-actor/README.md +1 -1
  30. package/api/@xmachines/play-actor/interfaces/ActorEvent.md +2 -2
  31. package/api/@xmachines/play-actor/interfaces/PlayActor.md +3 -3
  32. package/api/@xmachines/play-atom/README.md +34 -25
  33. package/api/@xmachines/play-atom/functions/watchAtom.md +8 -8
  34. package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md +4 -4
  35. package/api/@xmachines/play-atom/interfaces/Atom.md +6 -6
  36. package/api/@xmachines/play-atom/interfaces/AtomObserver.md +6 -6
  37. package/api/@xmachines/play-atom/interfaces/AtomOptions.md +4 -4
  38. package/api/@xmachines/play-atom/interfaces/AtomSubscription.md +2 -2
  39. package/api/@xmachines/play-atom/interfaces/BaseAtom.md +4 -4
  40. package/api/@xmachines/play-atom/interfaces/CreateAtom.md +3 -3
  41. package/api/@xmachines/play-atom/interfaces/Readable.md +4 -4
  42. package/api/@xmachines/play-atom/interfaces/ReadonlyAtom.md +4 -4
  43. package/api/@xmachines/play-atom/type-aliases/AnyAtom.md +1 -1
  44. package/api/@xmachines/play-atom/type-aliases/AsyncAtomState.md +1 -1
  45. package/api/@xmachines/play-atom/variables/createAsyncAtom.md +1 -1
  46. package/api/@xmachines/play-atom/variables/createAtom.md +1 -1
  47. package/api/@xmachines/play-atom/variables/createWritableAtom.md +1 -1
  48. package/api/@xmachines/play-dom/README.md +32 -34
  49. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  50. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  51. package/api/@xmachines/play-dom/functions/createRenderer.md +3 -3
  52. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +11 -11
  53. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  54. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +14 -14
  55. package/api/@xmachines/play-dom/type-aliases/MountFn.md +6 -17
  56. package/api/@xmachines/play-dom-router/README.md +28 -45
  57. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +13 -13
  58. package/api/@xmachines/play-dom-router/classes/RouteMap.md +5 -6
  59. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  60. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +5 -3
  61. package/api/@xmachines/play-dom-router/functions/createRouter.md +5 -3
  62. package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md +3 -3
  63. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +21 -67
  64. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +16 -16
  65. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +10 -10
  66. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  67. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  68. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  69. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +6 -6
  70. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  71. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +5 -5
  72. package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +12 -31
  73. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +12 -27
  74. package/api/@xmachines/play-pattern/README.md +10 -6
  75. package/api/@xmachines/play-pattern/functions/buildPath.md +1 -1
  76. package/api/@xmachines/play-pattern/functions/{createPatternCache.md → createLruCache.md} +19 -14
  77. package/api/@xmachines/play-pattern/functions/getIndexKey.md +1 -1
  78. package/api/@xmachines/play-pattern/functions/isDotSegment.md +1 -1
  79. package/api/@xmachines/play-pattern/functions/parsePattern.md +1 -1
  80. package/api/@xmachines/play-pattern/interfaces/GroupPart.md +6 -6
  81. package/api/@xmachines/play-pattern/interfaces/KeyValueCache.md +61 -0
  82. package/api/@xmachines/play-pattern/interfaces/LiteralPart.md +5 -5
  83. package/api/@xmachines/play-pattern/interfaces/ParamPart.md +9 -9
  84. package/api/@xmachines/play-pattern/interfaces/ParseOptions.md +4 -4
  85. package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md +14 -14
  86. package/api/@xmachines/play-pattern/interfaces/PatternParam.md +6 -6
  87. package/api/@xmachines/play-pattern/type-aliases/PathBuildResult.md +1 -1
  88. package/api/@xmachines/play-pattern/type-aliases/PathParams.md +1 -1
  89. package/api/@xmachines/play-pattern/type-aliases/PatternModifier.md +1 -1
  90. package/api/@xmachines/play-pattern/type-aliases/PatternPart.md +1 -1
  91. package/api/@xmachines/play-react/README.md +4 -4
  92. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
  93. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  94. package/api/@xmachines/play-react/functions/useAtomEffect.md +1 -1
  95. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  96. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +10 -10
  97. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
  98. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
  99. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +13 -13
  100. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  101. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  102. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  103. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  104. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  105. package/api/@xmachines/play-react-router/README.md +4 -2
  106. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
  107. package/api/@xmachines/play-react-router/classes/RouteMap.md +5 -6
  108. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  109. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  110. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  111. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +11 -11
  112. package/api/@xmachines/play-react-router/interfaces/RoutableActor.md +4 -4
  113. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +6 -6
  114. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  115. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +5 -5
  116. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  117. package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  118. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  119. package/api/@xmachines/play-router/README.md +14 -13
  120. package/api/@xmachines/play-router/errors/classes/DuplicateBridgeError.md +4 -4
  121. package/api/@xmachines/play-router/errors/classes/DuplicateRoutePathError.md +5 -5
  122. package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md +5 -5
  123. package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md +5 -5
  124. package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md +5 -5
  125. package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md +5 -5
  126. package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md +6 -6
  127. package/api/@xmachines/play-router/errors/classes/RouterSyncError.md +4 -4
  128. package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md +6 -6
  129. package/api/@xmachines/play-router/index/README.md +2 -3
  130. package/api/@xmachines/play-router/index/classes/RouteMap.md +5 -6
  131. package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md +7 -7
  132. package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md +1 -1
  133. package/api/@xmachines/play-router/index/functions/buildRouteTree.md +1 -1
  134. package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md +1 -1
  135. package/api/@xmachines/play-router/index/functions/{createPatternCache.md → createLruCache.md} +19 -14
  136. package/api/@xmachines/play-router/index/functions/createRouteMapFromTree.md +1 -1
  137. package/api/@xmachines/play-router/index/functions/createRouterConnection.md +1 -1
  138. package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md +1 -1
  139. package/api/@xmachines/play-router/index/functions/extractQuery.md +1 -1
  140. package/api/@xmachines/play-router/index/functions/extractRouteParams.md +1 -1
  141. package/api/@xmachines/play-router/index/functions/findRouteById.md +1 -1
  142. package/api/@xmachines/play-router/index/functions/findRouteByPath.md +3 -3
  143. package/api/@xmachines/play-router/index/functions/isMountableBridge.md +1 -1
  144. package/api/@xmachines/play-router/index/functions/joinBasePath.md +1 -1
  145. package/api/@xmachines/play-router/index/functions/mountKey.md +1 -1
  146. package/api/@xmachines/play-router/index/functions/normalizeBasePath.md +1 -1
  147. package/api/@xmachines/play-router/index/functions/openProviderBridge.md +3 -3
  148. package/api/@xmachines/play-router/index/functions/parsePattern.md +1 -1
  149. package/api/@xmachines/play-router/index/functions/pickOwnParams.md +1 -1
  150. package/api/@xmachines/play-router/index/functions/repointProviderBridge.md +1 -1
  151. package/api/@xmachines/play-router/index/functions/resolveBasePath.md +1 -1
  152. package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md +1 -1
  153. package/api/@xmachines/play-router/index/functions/sanitizePathname.md +1 -1
  154. package/api/@xmachines/play-router/index/functions/splitLocation.md +1 -1
  155. package/api/@xmachines/play-router/index/functions/stripBasePath.md +1 -1
  156. package/api/@xmachines/play-router/index/functions/validateRouteFormat.md +1 -1
  157. package/api/@xmachines/play-router/index/functions/validateStateExists.md +1 -1
  158. package/api/@xmachines/play-router/index/interfaces/BasePathOptions.md +3 -3
  159. package/api/@xmachines/play-router/index/interfaces/BuildPlayRouteEventOptions.md +4 -4
  160. package/api/@xmachines/play-router/index/interfaces/CompileOptions.md +5 -5
  161. package/api/@xmachines/play-router/index/interfaces/FrameworkParamsSource.md +9 -9
  162. package/api/@xmachines/play-router/index/interfaces/KeyValueCache.md +61 -0
  163. package/api/@xmachines/play-router/index/interfaces/LocationLike.md +3 -3
  164. package/api/@xmachines/play-router/index/interfaces/MountableRouterBridge.md +6 -6
  165. package/api/@xmachines/play-router/index/interfaces/OpenProviderBridgeArgs.md +10 -10
  166. package/api/@xmachines/play-router/index/interfaces/ParseOptions.md +4 -4
  167. package/api/@xmachines/play-router/index/interfaces/ParsedPattern.md +12 -12
  168. package/api/@xmachines/play-router/index/interfaces/PlayRouteEvent.md +7 -7
  169. package/api/@xmachines/play-router/index/interfaces/PlayRouterProviderBaseProps.md +11 -11
  170. package/api/@xmachines/play-router/index/interfaces/ResolvedBasePath.md +3 -3
  171. package/api/@xmachines/play-router/index/interfaces/ResolvedRoutePath.md +3 -3
  172. package/api/@xmachines/play-router/index/interfaces/Routable.md +3 -3
  173. package/api/@xmachines/play-router/index/interfaces/RoutableActor.md +4 -4
  174. package/api/@xmachines/play-router/index/interfaces/RouteInfo.md +8 -8
  175. package/api/@xmachines/play-router/index/interfaces/RouteMapOptions.md +6 -6
  176. package/api/@xmachines/play-router/index/interfaces/RouteMapping.md +3 -3
  177. package/api/@xmachines/play-router/index/interfaces/RouteMatch.md +3 -3
  178. package/api/@xmachines/play-router/index/interfaces/RouteNode.md +10 -10
  179. package/api/@xmachines/play-router/index/interfaces/RouteObject.md +5 -5
  180. package/api/@xmachines/play-router/index/interfaces/RouteTree.md +5 -5
  181. package/api/@xmachines/play-router/index/interfaces/RouteWatcherHandle.md +3 -3
  182. package/api/@xmachines/play-router/index/interfaces/RouterBridge.md +5 -5
  183. package/api/@xmachines/play-router/index/interfaces/RouterBridgeOptions.md +7 -7
  184. package/api/@xmachines/play-router/index/interfaces/RouterConnection.md +12 -31
  185. package/api/@xmachines/play-router/index/interfaces/SplitLocation.md +5 -5
  186. package/api/@xmachines/play-router/index/interfaces/WindowLike.md +3 -3
  187. package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  188. package/api/@xmachines/play-router/index/type-aliases/RouteData.md +1 -1
  189. package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md +1 -1
  190. package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md +1 -1
  191. package/api/@xmachines/play-router/index/type-aliases/URLPatternLike.md +3 -3
  192. package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md +1 -1
  193. package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md +1 -1
  194. package/api/@xmachines/play-router/xstate/functions/createRouteMap.md +1 -1
  195. package/api/@xmachines/play-router/xstate/functions/extractMachineRoutes.md +1 -1
  196. package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md +1 -1
  197. package/api/@xmachines/play-router/xstate/functions/getRoutableRoutes.md +1 -1
  198. package/api/@xmachines/play-router/xstate/functions/getRouteMappings.md +1 -1
  199. package/api/@xmachines/play-router/xstate/functions/getTransitionReachableRoutes.md +1 -1
  200. package/api/@xmachines/play-router/xstate/functions/isRouteReachable.md +1 -1
  201. package/api/@xmachines/play-router/xstate/functions/machineToGraph.md +1 -1
  202. package/api/@xmachines/play-router/xstate/functions/routeExists.md +1 -1
  203. package/api/@xmachines/play-router/xstate/interfaces/MachineEdgeData.md +3 -3
  204. package/api/@xmachines/play-router/xstate/interfaces/MachineNodeData.md +5 -5
  205. package/api/@xmachines/play-router/xstate/type-aliases/MachineGraph.md +1 -1
  206. package/api/@xmachines/play-solid/README.md +2 -2
  207. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  208. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  209. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +10 -10
  210. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +13 -13
  211. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  212. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  213. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  214. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  215. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  216. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  217. package/api/@xmachines/play-solid-router/README.md +4 -2
  218. package/api/@xmachines/play-solid-router/classes/RouteMap.md +5 -6
  219. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  220. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  221. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +3 -3
  222. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  223. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +11 -11
  224. package/api/@xmachines/play-solid-router/interfaces/RoutableActor.md +4 -4
  225. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +6 -6
  226. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  227. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +5 -5
  228. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  229. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  230. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  231. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  232. package/api/@xmachines/play-svelte/README.md +3 -3
  233. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  234. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  235. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  236. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  237. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +10 -10
  238. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  239. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +13 -13
  240. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  241. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  242. package/api/@xmachines/play-svelte-spa-router/README.md +4 -2
  243. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +5 -6
  244. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +7 -7
  245. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  246. package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +3 -3
  247. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +10 -10
  248. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  249. package/api/@xmachines/play-svelte-spa-router/interfaces/RoutableActor.md +4 -4
  250. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +6 -6
  251. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  252. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +5 -5
  253. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +12 -31
  254. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  255. package/api/@xmachines/play-sveltekit-router/README.md +4 -2
  256. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +5 -6
  257. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +7 -7
  258. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  259. package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +3 -3
  260. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +10 -10
  261. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  262. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  263. package/api/@xmachines/play-sveltekit-router/interfaces/RoutableActor.md +4 -4
  264. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +6 -6
  265. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  266. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +5 -5
  267. package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +12 -31
  268. package/api/@xmachines/play-tanstack-react-router/README.md +4 -2
  269. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +5 -6
  270. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +7 -7
  271. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  272. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  273. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  274. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +11 -11
  275. package/api/@xmachines/play-tanstack-react-router/interfaces/RoutableActor.md +4 -4
  276. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +6 -6
  277. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  278. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +5 -5
  279. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  280. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  281. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  282. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  283. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  284. package/api/@xmachines/play-tanstack-router/README.md +11 -1
  285. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +7 -7
  286. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  287. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +5 -5
  288. package/api/@xmachines/play-tanstack-solid-router/README.md +4 -2
  289. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +5 -6
  290. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +7 -7
  291. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  292. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  293. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +11 -11
  294. package/api/@xmachines/play-tanstack-solid-router/interfaces/RoutableActor.md +4 -4
  295. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +6 -6
  296. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  297. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +5 -5
  298. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  299. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  300. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  301. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +5 -5
  302. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  303. package/api/@xmachines/play-url/README.md +3 -3
  304. package/api/@xmachines/play-url/errors/classes/InvalidBasePathError.md +5 -5
  305. package/api/@xmachines/play-url/errors/classes/InvalidRoutePatternError.md +5 -5
  306. package/api/@xmachines/play-url/errors/classes/MissingBasePathParamError.md +6 -6
  307. package/api/@xmachines/play-url/index/README.md +2 -2
  308. package/api/@xmachines/play-url/index/functions/buildPath.md +1 -1
  309. package/api/@xmachines/play-url/index/functions/cleanFrameworkParams.md +1 -1
  310. package/api/@xmachines/play-url/index/functions/{createPatternCache.md → createLruCache.md} +19 -14
  311. package/api/@xmachines/play-url/index/functions/getCandidates.md +1 -1
  312. package/api/@xmachines/play-url/index/functions/getCompiledPattern.md +1 -1
  313. package/api/@xmachines/play-url/index/functions/getIndexKey.md +1 -1
  314. package/api/@xmachines/play-url/index/functions/holdsUnsubstitutedParam.md +1 -1
  315. package/api/@xmachines/play-url/index/functions/isDotSegment.md +1 -1
  316. package/api/@xmachines/play-url/index/functions/joinBasePath.md +1 -1
  317. package/api/@xmachines/play-url/index/functions/normalizeBasePath.md +1 -1
  318. package/api/@xmachines/play-url/index/functions/parsePattern.md +1 -1
  319. package/api/@xmachines/play-url/index/functions/pickOwnParams.md +1 -1
  320. package/api/@xmachines/play-url/index/functions/resolveBasePath.md +1 -1
  321. package/api/@xmachines/play-url/index/functions/resolveFrameworkParams.md +1 -1
  322. package/api/@xmachines/play-url/index/functions/sanitizePathname.md +1 -1
  323. package/api/@xmachines/play-url/index/functions/splitLocation.md +1 -1
  324. package/api/@xmachines/play-url/index/functions/stripBasePath.md +1 -1
  325. package/api/@xmachines/play-url/index/interfaces/BasePathOptions.md +3 -3
  326. package/api/@xmachines/play-url/index/interfaces/CompileOptions.md +5 -5
  327. package/api/@xmachines/play-url/index/interfaces/FrameworkParamsSource.md +9 -9
  328. package/api/@xmachines/play-url/index/interfaces/GroupPart.md +4 -4
  329. package/api/@xmachines/play-url/index/interfaces/KeyValueCache.md +61 -0
  330. package/api/@xmachines/play-url/index/interfaces/LiteralPart.md +3 -3
  331. package/api/@xmachines/play-url/index/interfaces/ParamPart.md +7 -7
  332. package/api/@xmachines/play-url/index/interfaces/ParseOptions.md +4 -4
  333. package/api/@xmachines/play-url/index/interfaces/ParsedPattern.md +12 -12
  334. package/api/@xmachines/play-url/index/interfaces/PatternParam.md +4 -4
  335. package/api/@xmachines/play-url/index/interfaces/ResolvedBasePath.md +3 -3
  336. package/api/@xmachines/play-url/index/interfaces/SplitLocation.md +5 -5
  337. package/api/@xmachines/play-url/index/type-aliases/PathBuildResult.md +1 -1
  338. package/api/@xmachines/play-url/index/type-aliases/PathParams.md +1 -1
  339. package/api/@xmachines/play-url/index/type-aliases/PatternModifier.md +1 -1
  340. package/api/@xmachines/play-url/index/type-aliases/PatternPart.md +1 -1
  341. package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md +1 -1
  342. package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md +3 -3
  343. package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md +1 -1
  344. package/api/@xmachines/play-url/index/variables/URLPattern.md +1 -1
  345. package/api/@xmachines/play-view/README.md +4 -3
  346. package/api/@xmachines/play-view/errors/README.md +1 -1
  347. package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md +5 -5
  348. package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md +1 -1
  349. package/api/@xmachines/play-view/index/functions/composePlayState.md +1 -1
  350. package/api/@xmachines/play-view/index/functions/createFailureLatch.md +1 -1
  351. package/api/@xmachines/play-view/index/functions/createReportGuard.md +1 -1
  352. package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md +1 -1
  353. package/api/@xmachines/play-view/index/functions/guardContextWrites.md +1 -1
  354. package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md +1 -1
  355. package/api/@xmachines/play-view/index/functions/reuseComposedState.md +2 -2
  356. package/api/@xmachines/play-view/index/functions/sameViewInputs.md +1 -1
  357. package/api/@xmachines/play-view/index/functions/toAtomState.md +1 -1
  358. package/api/@xmachines/play-view/index/functions/typedSpec.md +1 -1
  359. package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md +5 -5
  360. package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md +5 -5
  361. package/api/@xmachines/play-view/index/interfaces/FailureLatch.md +3 -3
  362. package/api/@xmachines/play-view/index/interfaces/PlaySpec.md +2 -2
  363. package/api/@xmachines/play-view/index/interfaces/ReportGuard.md +5 -5
  364. package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md +5 -5
  365. package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md +2 -2
  366. package/api/@xmachines/play-view/index/interfaces/ViewInputs.md +4 -4
  367. package/api/@xmachines/play-view/index/interfaces/ViewStoreLifecycle.md +3 -3
  368. package/api/@xmachines/play-view/index/interfaces/ViewStoreResolution.md +4 -4
  369. package/api/@xmachines/play-view/index/interfaces/Viewable.md +2 -2
  370. package/api/@xmachines/play-view/index/type-aliases/ViewActor.md +1 -1
  371. package/api/@xmachines/play-view/index/variables/CONTEXT_STATE_KEY.md +1 -1
  372. package/api/@xmachines/play-vue/README.md +3 -3
  373. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  374. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  375. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  376. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +8 -8
  377. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -0
  378. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +11 -11
  379. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  380. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  381. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  382. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  383. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  384. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  385. package/api/@xmachines/play-vue/variables/schema.md +35 -54
  386. package/api/@xmachines/play-vue-router/README.md +4 -2
  387. package/api/@xmachines/play-vue-router/errors/classes/VueRouterNavigationError.md +4 -4
  388. package/api/@xmachines/play-vue-router/errors/classes/VueRouterSendError.md +4 -4
  389. package/api/@xmachines/play-vue-router/index/classes/RouteMap.md +5 -6
  390. package/api/@xmachines/play-vue-router/index/classes/VueRouterBridge.md +7 -7
  391. package/api/@xmachines/play-vue-router/index/interfaces/PlayRouteEvent.md +7 -7
  392. package/api/@xmachines/play-vue-router/index/interfaces/RoutableActor.md +4 -4
  393. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapOptions.md +6 -6
  394. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md +3 -3
  395. package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md +5 -5
  396. package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md +7 -7
  397. package/api/@xmachines/play-xstate/README.md +19 -8
  398. package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md +4 -4
  399. package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md +5 -5
  400. package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md +4 -4
  401. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md +5 -5
  402. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md +5 -5
  403. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md +14 -14
  404. package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md +6 -6
  405. package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md +6 -6
  406. package/api/@xmachines/play-xstate/index/README.md +0 -4
  407. package/api/@xmachines/play-xstate/index/classes/PlayerActor.md +10 -45
  408. package/api/@xmachines/play-xstate/index/functions/compose.md +4 -4
  409. package/api/@xmachines/play-xstate/index/functions/definePlayer.md +2 -2
  410. package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md +4 -4
  411. package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md +2 -2
  412. package/api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md +7 -7
  413. package/api/@xmachines/play-xstate/index/type-aliases/Capability.md +1 -1
  414. package/api/@xmachines/play-xstate/index/type-aliases/PlayerConstructor.md +1 -1
  415. package/api/@xmachines/play-xstate/index/type-aliases/PlayerFactory.md +1 -1
  416. package/api/@xmachines/play-xstate/with-routing/functions/buildRouteUrl.md +1 -1
  417. package/api/@xmachines/play-xstate/with-routing/functions/deriveRoute.md +1 -1
  418. package/api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md +1 -1
  419. package/api/@xmachines/play-xstate/with-routing/functions/isAbsoluteRoute.md +1 -1
  420. package/api/@xmachines/play-xstate/with-routing/functions/withRouting.md +1 -1
  421. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteContext.md +5 -5
  422. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteObject.md +5 -5
  423. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md +1 -1
  424. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md +1 -1
  425. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md +4 -4
  426. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md +1 -1
  427. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md +5 -5
  428. package/api/@xmachines/play-xstate/with-view/functions/withView.md +1 -1
  429. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  430. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  431. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  432. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  433. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  434. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  435. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  436. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  437. package/api/README.md +1 -0
  438. package/api/llms.txt +1 -0
  439. package/contributing/architecture.md +36 -21
  440. package/contributing/configuration.md +5 -3
  441. package/contributing/development.md +25 -27
  442. package/contributing/migrating-to-play-atom.md +1 -0
  443. package/examples/@xmachines/play-dom-demo/functions/createAuthActionHandlers.md +9 -9
  444. package/examples/@xmachines/play-dom-demo/functions/createConfirmDialog.md +1 -1
  445. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  446. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  447. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  448. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  449. package/examples/@xmachines/play-dom-demo/variables/Button.md +1 -1
  450. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  451. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  452. package/examples/@xmachines/play-dom-demo/variables/Field.md +1 -1
  453. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  454. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  455. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  456. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  457. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  458. package/examples/@xmachines/play-dom-demo/variables/Panel.md +1 -1
  459. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  460. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  461. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  462. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  463. package/examples/@xmachines/play-dom-demo/variables/demoComponents.md +15 -15
  464. package/examples/@xmachines/play-react-demo/functions/createAuthActionHandlers.md +9 -9
  465. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  466. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  467. package/examples/@xmachines/play-react-demo/variables/Button.md +1 -1
  468. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  469. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  470. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  471. package/examples/@xmachines/play-react-demo/variables/Field.md +1 -1
  472. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  473. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  474. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  475. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  476. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  477. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  478. package/examples/@xmachines/play-react-demo/variables/Panel.md +1 -1
  479. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  480. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  481. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  482. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  483. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  484. package/examples/@xmachines/play-react-demo/variables/demoComponents.md +15 -15
  485. package/examples/@xmachines/play-solid-demo/functions/createAuthActionHandlers.md +9 -9
  486. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  487. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  488. package/examples/@xmachines/play-solid-demo/variables/Button.md +1 -1
  489. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  490. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  491. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  492. package/examples/@xmachines/play-solid-demo/variables/Field.md +1 -1
  493. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  494. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  495. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  496. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  497. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  498. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  499. package/examples/@xmachines/play-solid-demo/variables/Panel.md +1 -1
  500. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  501. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  502. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  503. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  504. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  505. package/examples/@xmachines/play-solid-demo/variables/demoComponents.md +15 -15
  506. package/examples/@xmachines/play-svelte-demo/functions/createAuthActionHandlers.md +9 -9
  507. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  508. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  509. package/examples/@xmachines/play-svelte-demo/variables/demoComponents.md +15 -15
  510. package/examples/@xmachines/play-vue-demo/functions/createAuthActionHandlers.md +9 -9
  511. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  512. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  513. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +190 -277
  514. package/examples/@xmachines/play-vue-demo/variables/demoComponents.md +1 -1
  515. package/examples/README.md +1 -1
  516. package/guides/atoms.md +24 -12
  517. package/guides/getting-started.md +12 -10
  518. package/package.json +1 -1
  519. package/rfc/broker.md +4 -0
  520. package/rfc/browser.md +4 -0
  521. package/rfc/cli.md +4 -0
  522. package/rfc/git.md +4 -0
  523. package/rfc/mcp.md +4 -0
  524. package/rfc/node.md +4 -0
  525. package/rfc/play.md +1 -1
  526. package/rfc/rest.md +4 -0
  527. package/rfc/run.md +4 -0
  528. package/rfc/streams.md +4 -0
  529. package/api/@xmachines/play/index/functions/asCleanup.md +0 -77
  530. package/api/@xmachines/play/index/functions/shallowEqualExcept.md +0 -29
  531. package/api/@xmachines/play/index/type-aliases/Cleanup.md +0 -38
  532. package/api/@xmachines/play/index/type-aliases/DisposeKey.md +0 -32
  533. package/api/@xmachines/play/index/variables/DISPOSE.md +0 -34
  534. package/api/@xmachines/play-atom/type-aliases/Cleanup.md +0 -38
  535. package/api/@xmachines/play-dom/functions/asCleanup.md +0 -77
  536. package/api/@xmachines/play-dom/type-aliases/Cleanup.md +0 -38
  537. package/api/@xmachines/play-dom-router/functions/asCleanup.md +0 -77
  538. package/api/@xmachines/play-dom-router/type-aliases/Cleanup.md +0 -38
  539. package/api/@xmachines/play-dom-router/variables/DISPOSE.md +0 -34
  540. package/api/@xmachines/play-pattern/interfaces/PatternCache.md +0 -65
  541. package/api/@xmachines/play-router/index/interfaces/PatternCache.md +0 -65
  542. package/api/@xmachines/play-url/index/interfaces/PatternCache.md +0 -65
  543. package/api/@xmachines/play-xstate/index/variables/DISPOSE.md +0 -34
@@ -6,7 +6,7 @@
6
6
  const demoComponents: object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/examples/demo/src/components/demo-components.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L20)
9
+ Defined in: [packages/play-svelte/examples/demo/src/components/demo-components.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L20)
10
10
 
11
11
  demoComponents — the full catalog component map, shared with the router demos.
12
12
 
@@ -14,17 +14,17 @@ demoComponents — the full catalog component map, shared with the router demos.
14
14
 
15
15
  | Name | Type | Default value | Defined in |
16
16
  | --------------------------------------------- | --------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
17
- | <a id="property-about"></a> `About` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L22) |
18
- | <a id="property-button"></a> `Button` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L34) |
19
- | <a id="property-contact"></a> `Contact` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L23) |
20
- | <a id="property-dashboard"></a> `Dashboard` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L25) |
21
- | <a id="property-field"></a> `Field` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L33) |
22
- | <a id="property-home"></a> `Home` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L21) |
23
- | <a id="property-login"></a> `Login` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L24) |
24
- | <a id="property-navbar"></a> `NavBar` | `LegacyComponentType` | `NavBarView` | [packages/play-svelte/examples/demo/src/components/demo-components.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L31) |
25
- | <a id="property-navigation"></a> `Navigation` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L30) |
26
- | <a id="property-overview"></a> `Overview` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L26) |
27
- | <a id="property-panel"></a> `Panel` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L32) |
28
- | <a id="property-profile"></a> `Profile` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L28) |
29
- | <a id="property-settings"></a> `Settings` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L29) |
30
- | <a id="property-stats"></a> `Stats` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L27) |
17
+ | <a id="property-about"></a> `About` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L22) |
18
+ | <a id="property-button"></a> `Button` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L34) |
19
+ | <a id="property-contact"></a> `Contact` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L23) |
20
+ | <a id="property-dashboard"></a> `Dashboard` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L25) |
21
+ | <a id="property-field"></a> `Field` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L33) |
22
+ | <a id="property-home"></a> `Home` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L21) |
23
+ | <a id="property-login"></a> `Login` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L24) |
24
+ | <a id="property-navbar"></a> `NavBar` | `LegacyComponentType` | `NavBarView` | [packages/play-svelte/examples/demo/src/components/demo-components.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L31) |
25
+ | <a id="property-navigation"></a> `Navigation` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L30) |
26
+ | <a id="property-overview"></a> `Overview` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L26) |
27
+ | <a id="property-panel"></a> `Panel` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L32) |
28
+ | <a id="property-profile"></a> `Profile` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L28) |
29
+ | <a id="property-settings"></a> `Settings` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L29) |
30
+ | <a id="property-stats"></a> `Stats` | `LegacyComponentType` | - | [packages/play-svelte/examples/demo/src/components/demo-components.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L27) |
@@ -6,7 +6,7 @@
6
6
  function createAuthActionHandlers(actor): object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/examples/shared/src/actions.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L48)
9
+ Defined in: [packages/play-actor/examples/shared/src/actions.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-actor/examples/shared/src/actions.ts#L48)
10
10
 
11
11
  Build the demo action handler map for one actor.
12
12
 
@@ -25,11 +25,11 @@ framework's `defineRegistry` accepts; spread the result into its `actions`.
25
25
 
26
26
  | Name | Type | Defined in |
27
27
  | ---------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
28
- | `addTask()` | (`params?`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L65) |
29
- | `completeTask()` | (`params`, `_setState`, `state`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L72) |
30
- | `login()` | (`params?`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L50) |
31
- | `logout()` | () => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L54) |
32
- | `removeTask()` | (`params`, `_setState`, `state`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L81) |
33
- | `resetForm()` | (`params`, `setState`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L99) |
34
- | `route()` | (`params?`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L55) |
35
- | `submitForm()` | (`params?`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L92) |
28
+ | `addTask()` | (`params?`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-actor/examples/shared/src/actions.ts#L65) |
29
+ | `completeTask()` | (`params`, `_setState`, `state`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-actor/examples/shared/src/actions.ts#L72) |
30
+ | `login()` | (`params?`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-actor/examples/shared/src/actions.ts#L50) |
31
+ | `logout()` | () => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-actor/examples/shared/src/actions.ts#L54) |
32
+ | `removeTask()` | (`params`, `_setState`, `state`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-actor/examples/shared/src/actions.ts#L81) |
33
+ | `resetForm()` | (`params`, `setState`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-actor/examples/shared/src/actions.ts#L99) |
34
+ | `route()` | (`params?`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-actor/examples/shared/src/actions.ts#L55) |
35
+ | `submitForm()` | (`params?`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-actor/examples/shared/src/actions.ts#L92) |
@@ -6,4 +6,4 @@
6
6
  type AuthCatalog = typeof authCatalog;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue/examples/demo/src/catalog.ts#L6)
9
+ Defined in: [packages/play-vue/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-vue/examples/demo/src/catalog.ts#L6)
@@ -6,4 +6,4 @@
6
6
  const App: DefineComponent<{}, {}, unknown>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/examples/demo/src/env.d.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue/examples/demo/src/env.d.ts#L5)
9
+ Defined in: [packages/play-vue/examples/demo/src/env.d.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-vue/examples/demo/src/env.d.ts#L5)
@@ -3,282 +3,195 @@
3
3
  # Variable: authCatalog
4
4
 
5
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
- repeat: {
40
- inner?: unknown;
41
- kind: "any";
42
- optional: true;
43
- };
44
- type: SchemaType<"ref", string>;
45
- visible: {
46
- inner?: unknown;
47
- kind: "any";
48
- optional: true;
49
- };
50
- }
51
- >
52
- >;
53
- root: SchemaType<"string", unknown>;
54
- }
55
- >;
56
- },
57
- {
58
- actions: {
59
- addTask: {
60
- description: "Add a task (sends task.add to the machine)";
61
- params: ZodObject<
62
- {
63
- title: ZodString;
64
- },
65
- $strip
66
- >;
67
- };
68
- completeTask: {
69
- description: "Mark a task done (sends task.complete to the machine)";
70
- params: ZodObject<
71
- {
72
- id: ZodString;
73
- },
74
- $strip
75
- >;
76
- };
77
- login: {
78
- description: "Login with username";
79
- params: ZodObject<
80
- {
81
- username: ZodString;
82
- },
83
- $strip
84
- >;
85
- };
86
- logout: {
87
- description: "Logout and return to home";
88
- };
89
- removeTask: {
90
- description: "Remove a task (sends task.remove to the machine)";
91
- params: ZodObject<
92
- {
93
- id: ZodString;
94
- },
95
- $strip
96
- >;
97
- };
98
- resetForm: {
99
- description: "Reset a demo form to its defaults (confirm-gated in the spec)";
100
- params: ZodObject<
101
- {
102
- form: ZodString;
103
- },
104
- $strip
105
- >;
106
- };
107
- route: {
108
- description: "Navigate to a route by path (e.g. '#home', '#login', '#dashboard')";
109
- params: ZodObject<
110
- {
111
- params: ZodOptional<ZodRecord<ZodString, ZodString>>;
112
- to: ZodString;
113
- },
114
- $strip
115
- >;
116
- };
117
- submitForm: {
118
- description: "Submit a demo form; rejects when the form did not pass validation";
119
- params: ZodObject<
120
- {
121
- form: ZodString;
122
- valid: ZodOptional<ZodNullable<ZodBoolean>>;
123
- },
124
- $strip
125
- >;
126
- };
127
- };
128
- components: {
129
- About: {
130
- props: ZodObject<
131
- {
132
- title: ZodString;
133
- },
134
- $strip
135
- >;
136
- };
137
- Button: {
138
- props: ZodObject<
139
- {
140
- disabled: ZodOptional<ZodBoolean>;
141
- label: ZodString;
142
- testId: ZodOptional<ZodString>;
143
- variant: ZodOptional<
144
- ZodEnum<{
145
- danger: "danger";
146
- primary: "primary";
147
- secondary: "secondary";
148
- }>
149
- >;
150
- },
151
- $strip
152
- >;
153
- };
154
- Contact: {
155
- props: ZodObject<
156
- {
157
- title: ZodString;
158
- },
159
- $strip
160
- >;
161
- };
162
- Dashboard: {
163
- props: ZodObject<
164
- {
165
- username: ZodString;
166
- welcome: ZodBoolean;
167
- },
168
- $strip
169
- >;
170
- };
171
- Field: {
172
- props: ZodObject<
173
- {
174
- checks: ZodOptional<ZodArray<ZodCustom<ValidationCheck, ValidationCheck>>>;
175
- formErrors: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString>>>;
176
- inputType: ZodOptional<
177
- ZodEnum<{
178
- email: "email";
179
- text: "text";
180
- textarea: "textarea";
181
- }>
182
- >;
183
- label: ZodString;
184
- placeholder: ZodOptional<ZodString>;
185
- testId: ZodOptional<ZodString>;
186
- value: ZodOptional<ZodString>;
187
- },
188
- $strip
189
- >;
190
- };
191
- Home: {
192
- props: ZodObject<
193
- {
194
- title: ZodString;
195
- },
196
- $strip
197
- >;
198
- };
199
- Login: {
200
- props: ZodObject<
201
- {
202
- title: ZodString;
203
- username: ZodOptional<ZodString>;
204
- },
205
- $strip
206
- >;
207
- };
208
- NavBar: {
209
- props: ZodObject<
210
- {
211
- isAuthenticated: ZodBoolean;
212
- username: ZodNullable<ZodString>;
213
- },
214
- $strip
215
- >;
216
- };
217
- Navigation: {
218
- props: ZodObject<
219
- {
220
- currentPath: ZodString;
221
- isAuthenticated: ZodBoolean;
222
- },
223
- $strip
224
- >;
225
- };
226
- Overview: {
227
- props: ZodObject<
228
- {
229
- title: ZodString;
230
- },
231
- $strip
232
- >;
233
- };
234
- Panel: {
235
- props: ZodObject<
236
- {
237
- note: ZodOptional<
238
- ZodUnion<readonly [ZodString, ZodNumber, ZodBoolean, ZodNull]>
239
- >;
240
- testId: ZodOptional<ZodString>;
241
- title: ZodOptional<ZodUnion<readonly [ZodString, ZodNumber]>>;
242
- tone: ZodOptional<
243
- ZodEnum<{
244
- danger: "danger";
245
- default: "default";
246
- muted: "muted";
247
- success: "success";
248
- }>
249
- >;
250
- },
251
- $strip
252
- >;
253
- };
254
- Profile: {
255
- props: ZodObject<
256
- {
257
- username: ZodString;
258
- },
259
- $strip
260
- >;
261
- };
262
- Settings: {
263
- props: ZodObject<
264
- {
265
- section: ZodOptional<ZodString>;
266
- username: ZodString;
267
- },
268
- $strip
269
- >;
270
- };
271
- Stats: {
272
- props: ZodObject<
273
- {
274
- title: ZodString;
275
- },
276
- $strip
277
- >;
278
- };
279
- };
280
- }
281
- >;
6
+ const authCatalog: Catalog<{
7
+ catalog: SchemaType<"object", {
8
+ actions: SchemaType<"map", {
9
+ description: SchemaType<"string", unknown>;
10
+ params: SchemaType<"zod", unknown>;
11
+ }>;
12
+ components: SchemaType<"map", {
13
+ description: SchemaType<"string", unknown>;
14
+ example: SchemaType<"any", unknown>;
15
+ props: SchemaType<"zod", unknown>;
16
+ slots: SchemaType<"array", SchemaType<"string", unknown>>;
17
+ }>;
18
+ }>;
19
+ spec: SchemaType<"object", {
20
+ elements: SchemaType<"record", SchemaType<"object", {
21
+ children: SchemaType<"array", SchemaType<"string", unknown>>;
22
+ props: SchemaType<"propsOf", string>;
23
+ repeat: {
24
+ inner?: unknown;
25
+ kind: "any";
26
+ optional: true;
27
+ };
28
+ slots: {
29
+ inner?: SchemaType<"array", SchemaType<..., ...>>;
30
+ kind: "record";
31
+ optional: true;
32
+ };
33
+ type: SchemaType<"ref", string>;
34
+ visible: {
35
+ inner?: unknown;
36
+ kind: "any";
37
+ optional: true;
38
+ };
39
+ }>>;
40
+ root: SchemaType<"string", unknown>;
41
+ }>;
42
+ }, {
43
+ actions: {
44
+ addTask: {
45
+ description: "Add a task (sends task.add to the machine)";
46
+ params: ZodObject<{
47
+ title: ZodString;
48
+ }, $strip>;
49
+ };
50
+ completeTask: {
51
+ description: "Mark a task done (sends task.complete to the machine)";
52
+ params: ZodObject<{
53
+ id: ZodString;
54
+ }, $strip>;
55
+ };
56
+ login: {
57
+ description: "Login with username";
58
+ params: ZodObject<{
59
+ username: ZodString;
60
+ }, $strip>;
61
+ };
62
+ logout: {
63
+ description: "Logout and return to home";
64
+ };
65
+ removeTask: {
66
+ description: "Remove a task (sends task.remove to the machine)";
67
+ params: ZodObject<{
68
+ id: ZodString;
69
+ }, $strip>;
70
+ };
71
+ resetForm: {
72
+ description: "Reset a demo form to its defaults (confirm-gated in the spec)";
73
+ params: ZodObject<{
74
+ form: ZodString;
75
+ }, $strip>;
76
+ };
77
+ route: {
78
+ description: "Navigate to a route by path (e.g. '#home', '#login', '#dashboard')";
79
+ params: ZodObject<{
80
+ params: ZodOptional<ZodRecord<ZodString, ZodString>>;
81
+ to: ZodString;
82
+ }, $strip>;
83
+ };
84
+ submitForm: {
85
+ description: "Submit a demo form; rejects when the form did not pass validation";
86
+ params: ZodObject<{
87
+ form: ZodString;
88
+ valid: ZodOptional<ZodNullable<ZodBoolean>>;
89
+ }, $strip>;
90
+ };
91
+ };
92
+ components: {
93
+ About: {
94
+ props: ZodObject<{
95
+ title: ZodString;
96
+ }, $strip>;
97
+ };
98
+ Button: {
99
+ props: ZodObject<{
100
+ disabled: ZodOptional<ZodBoolean>;
101
+ label: ZodString;
102
+ testId: ZodOptional<ZodString>;
103
+ variant: ZodOptional<ZodEnum<{
104
+ danger: "danger";
105
+ primary: "primary";
106
+ secondary: "secondary";
107
+ }>>;
108
+ }, $strip>;
109
+ };
110
+ Contact: {
111
+ props: ZodObject<{
112
+ title: ZodString;
113
+ }, $strip>;
114
+ };
115
+ Dashboard: {
116
+ props: ZodObject<{
117
+ username: ZodString;
118
+ welcome: ZodBoolean;
119
+ }, $strip>;
120
+ };
121
+ Field: {
122
+ props: ZodObject<{
123
+ checks: ZodOptional<ZodArray<ZodCustom<ValidationCheck, ValidationCheck>>>;
124
+ formErrors: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString>>>;
125
+ inputType: ZodOptional<ZodEnum<{
126
+ email: "email";
127
+ text: "text";
128
+ textarea: "textarea";
129
+ }>>;
130
+ label: ZodString;
131
+ placeholder: ZodOptional<ZodString>;
132
+ testId: ZodOptional<ZodString>;
133
+ value: ZodOptional<ZodString>;
134
+ }, $strip>;
135
+ };
136
+ Home: {
137
+ props: ZodObject<{
138
+ title: ZodString;
139
+ }, $strip>;
140
+ };
141
+ Login: {
142
+ props: ZodObject<{
143
+ title: ZodString;
144
+ username: ZodOptional<ZodString>;
145
+ }, $strip>;
146
+ };
147
+ NavBar: {
148
+ props: ZodObject<{
149
+ isAuthenticated: ZodBoolean;
150
+ username: ZodNullable<ZodString>;
151
+ }, $strip>;
152
+ };
153
+ Navigation: {
154
+ props: ZodObject<{
155
+ currentPath: ZodString;
156
+ isAuthenticated: ZodBoolean;
157
+ }, $strip>;
158
+ };
159
+ Overview: {
160
+ props: ZodObject<{
161
+ title: ZodString;
162
+ }, $strip>;
163
+ };
164
+ Panel: {
165
+ props: ZodObject<{
166
+ note: ZodOptional<ZodUnion<readonly [ZodString, ZodNumber, ZodBoolean, ZodNull]>>;
167
+ testId: ZodOptional<ZodString>;
168
+ title: ZodOptional<ZodUnion<readonly [ZodString, ZodNumber]>>;
169
+ tone: ZodOptional<ZodEnum<{
170
+ danger: "danger";
171
+ default: "default";
172
+ muted: "muted";
173
+ success: "success";
174
+ }>>;
175
+ }, $strip>;
176
+ };
177
+ Profile: {
178
+ props: ZodObject<{
179
+ username: ZodString;
180
+ }, $strip>;
181
+ };
182
+ Settings: {
183
+ props: ZodObject<{
184
+ section: ZodOptional<ZodString>;
185
+ username: ZodString;
186
+ }, $strip>;
187
+ };
188
+ Stats: {
189
+ props: ZodObject<{
190
+ title: ZodString;
191
+ }, $strip>;
192
+ };
193
+ };
194
+ }>;
282
195
  ```
283
196
 
284
- Defined in: [packages/play-vue/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue/examples/demo/src/catalog.ts#L5)
197
+ Defined in: [packages/play-vue/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-vue/examples/demo/src/catalog.ts#L5)
@@ -6,6 +6,6 @@
6
6
  const demoComponents: ComponentsMap<typeof authCatalog>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/examples/demo/src/components/demo-components.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue/examples/demo/src/components/demo-components.ts#L22)
9
+ Defined in: [packages/play-vue/examples/demo/src/components/demo-components.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-vue/examples/demo/src/components/demo-components.ts#L22)
10
10
 
11
11
  demoComponents — the full catalog component map, shared with the router demos.
@@ -60,7 +60,7 @@ The conceptual examples in this directory are TypeScript snippets. To run them:
60
60
 
61
61
  ```bash
62
62
  # Install dependencies (from the monorepo root)
63
- pnpm add @xmachines/play-xstate @xmachines/play-actor @xmachines/play-atom xstate
63
+ pnpm add @xmachines/play-xstate @xmachines/play-actor @xmachines/play-atom @xmachines/play @xmachines/core xstate
64
64
 
65
65
  # Run with tsx
66
66
  pnpm dlx tsx my-example.ts